From 74cdcf7e6d7f0ebea49afbf3c0c8fd9725944dbb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B1=88=E8=BD=A9?= Date: Mon, 22 Apr 2024 16:24:28 +0800 Subject: [PATCH] fix(docs): update swagger api (#20100) --- docs/swagger/swagger_cloudevent.yaml | 3021 +- docs/swagger/swagger_cloudid.yaml | 16192 +- docs/swagger/swagger_compute.yaml | 344238 ++++++++------- docs/swagger/swagger_identity.yaml | 29185 +- docs/swagger/swagger_image.yaml | 6914 +- docs/swagger/swagger_monitor.yaml | 37619 +- docs/swagger/swagger_notify.yaml | 18832 +- docs/swagger/swagger_yunionconf.yaml | 3744 +- pkg/apis/cloudid/zz_generated.model.go | 36 - pkg/apis/compute/zz_generated.model.go | 46 - pkg/apis/identity/organization.go | 7 + pkg/apis/identity/zz_generated.model.go | 14 - pkg/apis/image/zz_generated.model.go | 35 - pkg/apis/monitor/alertnotification.go | 1 - pkg/apis/monitor/zz_generated.model.go | 31 - pkg/cloudid/models/cloudgroup_policies.go | 1 + pkg/cloudid/models/cloudgroup_users.go | 1 + pkg/cloudid/models/cloudgroupjoints.go | 1 + pkg/cloudid/models/clouduser_policies.go | 1 + pkg/cloudid/models/clouduserjoints.go | 1 + pkg/cloudid/models/clouduserresource.go | 1 + pkg/compute/models/cloudproviderschedtags.go | 2 + pkg/compute/models/cloudregionschedtags.go | 2 + pkg/compute/models/dbinstance_secgroups.go | 2 + pkg/compute/models/dbinstancejoints.go | 2 + pkg/compute/models/dbinstancenetworks.go | 2 + pkg/compute/models/elasticcache_joints.go | 2 + pkg/compute/models/elasticcache_secgroups.go | 2 + pkg/compute/models/groupguests.go | 2 + pkg/compute/models/groupjoints.go | 2 + pkg/compute/models/groupnetworks.go | 2 + pkg/compute/models/guest_actions.go | 65 + pkg/compute/models/guest_secgroups.go | 3 + pkg/compute/models/guestdisks.go | 2 + pkg/compute/models/guestjoints.go | 2 + pkg/compute/models/guestnetworks.go | 2 + pkg/compute/models/guestsecgroups.go | 2 + .../models/host_isolated_device_models.go | 2 + pkg/compute/models/hostbackupstorages.go | 2 + pkg/compute/models/hostjoints.go | 2 + pkg/compute/models/hostnetworks.go | 2 + pkg/compute/models/hostschedtags.go | 2 + pkg/compute/models/hoststorages.go | 2 + pkg/compute/models/hostwires.go | 2 + pkg/compute/models/loadbalancernetworks.go | 2 + pkg/compute/models/networkschedtags.go | 2 + pkg/compute/models/schedtagjoint.go | 2 + pkg/compute/models/storageschedtags.go | 2 + pkg/compute/models/zoneschedtags.go | 2 + pkg/image/models/image_members.go | 2 +- pkg/image/models/image_peripherals.go | 1 + pkg/image/models/image_properties.go | 1 + pkg/image/models/image_subs.go | 1 + pkg/image/models/image_tags.go | 1 + pkg/keystone/models/organizations.go | 13 +- pkg/keystone/models/projects.go | 1 + pkg/keystone/models/user_group_memberships.go | 2 + pkg/monitor/models/alertjoint.go | 2 + pkg/monitor/models/alertnotification.go | 2 + pkg/monitor/models/alertresource_alert.go | 2 + pkg/monitor/models/alertresourcejoints.go | 2 + pkg/notify/models/topic.go | 1 + 62 files changed, 239550 insertions(+), 220522 deletions(-) diff --git a/docs/swagger/swagger_cloudevent.yaml b/docs/swagger/swagger_cloudevent.yaml index 7aaed817ca..fb44fdc7aa 100644 --- a/docs/swagger/swagger_cloudevent.yaml +++ b/docs/swagger/swagger_cloudevent.yaml @@ -1,1491 +1,1578 @@ basePath: / consumes: -- application/json + - application/json definitions: - CloudeventDetails: - properties: - account: - type: string - x-go-name: Account - action: - type: string - x-go-name: Action - brand: - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloudprovider_id: - type: string - x-go-name: CloudproviderId - created_at: - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - domain_id: - description: 域Id - type: string - x-go-name: DomainId - event_id: - format: int64 - type: integer - x-go-name: EventId - manager: - type: string - x-go-name: Manager - name: - type: string - x-go-name: Name - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - type: string - x-go-name: Provider - request: + CloudeventDetails: + properties: + account: + type: string + x-go-name: Account + action: + type: string + x-go-name: Action + brand: + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudprovider_id: + type: string + x-go-name: CloudproviderId + created_at: + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + domain_id: + description: 域Id + type: string + x-go-name: DomainId + event_id: + format: int64 + type: integer + x-go-name: EventId + manager: + type: string + x-go-name: Manager + name: + type: string + x-go-name: Name + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + type: string + x-go-name: Provider + request: + type: object + x-go-name: Request + request_id: + type: string + x-go-name: RequestId + resource_type: + type: string + x-go-name: ResourceType + service: + type: string + x-go-name: Service + success: + type: boolean + x-go-name: Success + update_fail_reason: + $ref: '#/definitions/Error' type: object - x-go-name: Request - request_id: - type: string - x-go-name: RequestId - resource_type: - type: string - x-go-name: ResourceType - service: - type: string - x-go-name: Service - success: - type: boolean - x-go-name: Success - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudevent - EnabledStatusStandaloneResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - EnabledStatusStandaloneResourceCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudevent + EnabledStatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress type: object - x-go-name: Metadata - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - EnabledStatusStandaloneResourceDetails: - 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: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis + EnabledStatusStandaloneResourceCreateInput: + 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 + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name type: object - x-go-name: Metadata - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - Error: - properties: - class: - type: string - x-go-name: Class - code: - format: int64 - type: integer - x-go-name: Code - details: - type: string - x-go-name: Details - type: object - x-go-package: yunion.io/x/onecloud/pkg/httperrors - GetDetailsStatusOutput: - properties: - status: - description: 状态 - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ModelBaseCreateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ModelBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformDisableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformEnableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformStatusInput: - properties: - host_id: - description: call from host id - type: string - x-go-name: HostId - power_states: - description: 电源状态 - type: string - x-go-name: PowerStates - reason: - description: 更改状态的原因描述 - type: string - x-go-name: Reason - status: - description: 更改的目标状态值 - type: string - x-go-name: Status - required: - - status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PurgeSplitTableInput: - properties: - tables: + x-go-package: yunion.io/x/onecloud/pkg/apis + EnabledStatusStandaloneResourceDetails: + 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 + 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 + ModelBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ModelBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformStatusInput: + properties: + host_id: + description: call from host id + type: string + x-go-name: HostId + power_states: + description: 电源状态 + type: string + x-go-name: PowerStates + reason: + description: 更改状态的原因描述 + type: string + x-go-name: Reason + status: + description: 更改的目标状态值 + type: string + x-go-name: Status + required: + - status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + 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 + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TTagSet: items: - type: string + $ref: '#/definitions/STag' type: array - x-go-name: Tables - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - 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 - StatusStatistic: - properties: - TotalCpuCount: - description: CPU总量 - format: int64 - type: integer - TotalDiskSizeMb: - description: 存储总量 - format: int64 - type: integer - TotalMemSizeMb: - description: 内存总量 - format: int64 - type: integer - status_info: + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: items: - $ref: '#/definitions/StatusStatisticStatusInfo' + $ref: '#/definitions/TTagSet' type: array - x-go-name: StatusInfo - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStatisticStatusInfo: - properties: - Status: - type: string - pending_deleted_count: - description: |- - 回收站数量 - 需要指定pending_delete=all - format: int64 - type: integer - x-go-name: PendingDeletedCount - total_count: - description: 资源总数 - format: int64 - type: integer - x-go-name: TotalCount - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - TTagSet: - items: - $ref: '#/definitions/STag' - type: array - x-go-package: yunion.io/x/onecloud/pkg/util/tagutils - TTagSetList: - items: - $ref: '#/definitions/TTagSet' - type: array - x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils host: '"127.0.0.1:8889"' info: - contact: - email: lizexi@yunion.cn - name: Zexi Li - description: Cloudevent API - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html - version: "1.0" + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Cloudprovider API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" paths: - /cloudevents: - get: - description: 列表 - operationId: cloudevent_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') - 支持的操作符如下： + /cloudevents: + get: + description: 列表 + operationId: cloudevent_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 指定查询的权限范围，可能值为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 | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 指定查询的权限范围，可能值为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: |- + 列出指定云平台的资源，支持的云平台如下 - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 服务类型 - in: query - items: - type: string - name: service - type: array - x-go-name: Service - - description: 订阅 - in: query - items: - type: string - name: manager - type: array - x-go-name: Manager - - description: 账号 - in: query - items: - type: string - name: account - type: array - x-go-name: Account - - description: 操作类型 - in: query - items: - type: string - name: action - type: array - x-go-name: Action - - description: 资源类别 - in: query - items: - type: string - name: resource_type - type: array - x-go-name: ResourceType - - description: 执行状态 - in: query - name: success - type: boolean - x-go-name: Success - - description: 操作日志起始时间 - format: date-time - in: query - name: since - type: string - x-go-name: Since - - description: 操作日志截止时间 - format: date-time - in: query - name: until - type: string - x-go-name: Until - responses: - "200": - $ref: '#/responses/cloudevent_ListItemFilterOutput' - summary: 云平台操作日志列表 - tags: - - cloudevent - post: - description: 新建 - operationId: cloudevent_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudevent: - $ref: '#/definitions/ModelBaseCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudevent_ValidateCreateDataOutput' - summary: 新建 - tags: - - cloudevent - /cloudevents/{id}: - delete: - description: 删除 - operationId: cloudevent_CustomizeDelete - parameters: - - description: The Id or Name of cloudevent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudevent_CustomizeDeleteOutput' - summary: 删除 - tags: - - cloudevent - get: - description: 获取详情 - operationId: cloudevent_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudevent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudevent_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - cloudevent - put: - description: 更新 - operationId: cloudevent_ValidateUpdateData - parameters: - - description: The Id or Name of cloudevent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudevent: - $ref: '#/definitions/ModelBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudevent_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cloudevent - /cloudevents/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudevent_GetPropertyDistinctField - parameters: - - in: query - items: - type: string - name: Field - type: array - - in: query - items: - type: string - name: ExtraField - type: array - responses: - "200": - $ref: '#/responses/cloudevent_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudevent - /cloudevents/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudevent_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudevent: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudevent_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudevent - /cloudevents/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudevent_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudevent_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudevent - /cloudevents/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudevent_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/cloudevent_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudevent - /cloudproviders: - get: - description: 列表 - operationId: cloudprovider_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') - 支持的操作符如下： + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 服务类型 + in: query + items: + type: string + name: service + type: array + x-go-name: Service + - description: 订阅 + in: query + items: + type: string + name: manager + type: array + x-go-name: Manager + - description: 账号 + in: query + items: + type: string + name: account + type: array + x-go-name: Account + - description: 操作类型 + in: query + items: + type: string + name: action + type: array + x-go-name: Action + - description: 资源类别 + in: query + items: + type: string + name: resource_type + type: array + x-go-name: ResourceType + - description: 执行状态 + in: query + name: success + type: boolean + x-go-name: Success + - description: 操作日志起始时间 + format: date-time + in: query + name: since + type: string + x-go-name: Since + - description: 操作日志截止时间 + format: date-time + in: query + name: until + type: string + x-go-name: Until + responses: + "200": + $ref: '#/responses/cloudevent_ListItemFilterOutput' + summary: 云平台操作日志列表 + tags: + - cloudevent + post: + description: 新建 + operationId: cloudevent_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudevent: + $ref: '#/definitions/ModelBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudevent_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudevent + /cloudevents/{id}: + delete: + description: 删除 + operationId: cloudevent_CustomizeDelete + parameters: + - description: The Id or Name of cloudevent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudevent_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudevent + get: + description: 获取详情 + operationId: cloudevent_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudevent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudevent_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudevent + put: + description: 更新 + operationId: cloudevent_ValidateUpdateData + parameters: + - description: The Id or Name of cloudevent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudevent: + $ref: '#/definitions/ModelBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudevent_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudevent + /cloudevents/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudevent_GetPropertyDistinctField + parameters: + - in: query + items: + type: string + name: Field + type: array + - in: query + items: + type: string + name: ExtraField + type: array + responses: + "200": + $ref: '#/responses/cloudevent_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudevent + /cloudevents/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudevent_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudevent: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudevent_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudevent + /cloudevents/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudevent_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudevent_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudevent + /cloudevents/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudevent_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/cloudevent_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudevent + /cloudproviders: + get: + description: 列表 + operationId: cloudprovider_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 - responses: - "200": - $ref: '#/responses/cloudprovider_ListItemFilterOutput' - summary: 列表 - tags: - - cloudprovider - post: - description: 新建 - operationId: cloudprovider_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_ValidateCreateDataOutput' - summary: 新建 - tags: - - cloudprovider - /cloudproviders/{id}: - delete: - description: 删除 - operationId: cloudprovider_CustomizeDelete - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_CustomizeDeleteOutput' - summary: 删除 - tags: - - cloudprovider - get: - description: 获取详情 - operationId: cloudprovider_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - cloudprovider - put: - description: 更新 - operationId: cloudprovider_ValidateUpdateData - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cloudprovider - /cloudproviders/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudprovider_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudprovider - post: - description: 执行操作ClassMetadata - operationId: cloudprovider_PerformClassMetadata - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudprovider - /cloudproviders/{id}/disable: - post: - description: 执行操作Disable - operationId: cloudprovider_PerformDisable - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformDisableOutput' - summary: 禁用资源 - tags: - - cloudprovider - /cloudproviders/{id}/enable: - post: - description: 执行操作Enable - operationId: cloudprovider_PerformEnable - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformEnableOutput' - summary: 启用资源 - tags: - - cloudprovider - /cloudproviders/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudprovider_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 + responses: + "200": + $ref: '#/responses/cloudprovider_ListItemFilterOutput' + summary: 列表 + tags: + - cloudprovider + post: + description: 新建 + operationId: cloudprovider_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudprovider + /cloudproviders/{id}: + delete: + description: 删除 + operationId: cloudprovider_CustomizeDelete + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudprovider + get: + description: 获取详情 + operationId: cloudprovider_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudprovider + put: + description: 更新 + operationId: cloudprovider_ValidateUpdateData + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudprovider + /cloudproviders/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudprovider_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudprovider + post: + description: 执行操作ClassMetadata + operationId: cloudprovider_PerformClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudprovider_PerformDisable + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformDisableOutput' + summary: 禁用资源 + tags: + - cloudprovider + /cloudproviders/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudprovider_PerformEnable + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformEnableOutput' + summary: 启用资源 + tags: + - cloudprovider + /cloudproviders/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudprovider_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 cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudprovider - /cloudproviders/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudprovider_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudprovider - /cloudproviders/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudprovider_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudprovider - /cloudproviders/{id}/status: - get: - description: 获取指定信息Status - operationId: cloudprovider_GetDetailsStatus - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cloudprovider - post: - description: 执行操作Status - operationId: cloudprovider_PerformStatus - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cloudprovider - /cloudproviders/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudprovider_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudprovider - /cloudproviders/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudprovider_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudprovider - /cloudproviders/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudprovider_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudprovider - /cloudproviders/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudprovider_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/cloudprovider_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudprovider - /cloudproviders/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cloudprovider_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cloudprovider - /cloudproviders/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudprovider_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudprovider - /cloudproviders/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudprovider_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudprovider + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudprovider + /cloudproviders/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cloudprovider_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cloudprovider + /cloudproviders/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudprovider_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cloudprovider_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudprovider_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudprovider + /cloudproviders/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudprovider_GetDetailsStatus + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudprovider + post: + description: 执行操作Status + operationId: cloudprovider_PerformStatus + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudprovider + /cloudproviders/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudprovider_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudprovider + /cloudproviders/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudprovider_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudprovider + /cloudproviders/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudprovider_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudprovider + /cloudproviders/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudprovider_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/cloudprovider_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudprovider + /cloudproviders/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudprovider_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudprovider + /cloudproviders/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudprovider_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudprovider + /cloudproviders/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudprovider_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudprovider produces: -- application/json + - application/json responses: - cloudevent_CustomizeDeleteOutput: - schema: - properties: - cloudevent: - $ref: '#/definitions/CloudeventDetails' - type: object - cloudevent_FetchCustomizeColumnsOutput: - schema: - properties: - cloudevent: - $ref: '#/definitions/CloudeventDetails' - type: object - cloudevent_GetPropertyDistinctFieldOutput: {} - cloudevent_GetPropertySplitableExportOutput: {} - cloudevent_GetPropertySplitableOutput: {} - cloudevent_ListItemFilterOutput: - schema: - properties: - cloudevents: - items: - $ref: '#/definitions/CloudeventDetails' - 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 - cloudevent_PerformPurgeSplitableOutput: {} - cloudevent_ValidateCreateDataOutput: - schema: - properties: - cloudevent: - $ref: '#/definitions/CloudeventDetails' - type: object - cloudevent_ValidateUpdateDataOutput: - schema: - properties: - cloudevent: - $ref: '#/definitions/CloudeventDetails' - type: object - cloudprovider_CustomizeDeleteOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' - type: object - cloudprovider_FetchCustomizeColumnsOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' - type: object - cloudprovider_GetDetailsClassMetadataOutput: - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudprovider_GetDetailsMetadataOutput: - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudprovider_GetDetailsStatusOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cloudprovider_GetPropertyDistinctFieldOutput: {} - cloudprovider_GetPropertySplitableExportOutput: {} - cloudprovider_GetPropertySplitableOutput: {} - cloudprovider_GetPropertyStatisticsOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/StatusStatistic' - type: object - cloudprovider_GetPropertyTagValuePairsOutput: {} - cloudprovider_GetPropertyTagValueTreeOutput: {} - cloudprovider_ListItemFilterOutput: - schema: - properties: - cloudproviders: - items: - $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' - 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 - cloudprovider_PerformClassMetadataOutput: {} - cloudprovider_PerformDisableOutput: {} - cloudprovider_PerformEnableOutput: {} - cloudprovider_PerformPurgeSplitableOutput: {} - cloudprovider_PerformSetClassMetadataOutput: {} - cloudprovider_PerformSetUserMetadataOutput: {} - cloudprovider_PerformStatusOutput: {} - cloudprovider_ValidateCreateDataOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' - type: object - cloudprovider_ValidateUpdateDataOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' - type: object + cloudevent_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudevent: + $ref: '#/definitions/CloudeventDetails' + type: object + cloudevent_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudevent: + $ref: '#/definitions/CloudeventDetails' + type: object + cloudevent_GetPropertyDistinctFieldOutput: + description: "" + cloudevent_GetPropertySplitableExportOutput: + description: "" + cloudevent_GetPropertySplitableOutput: + description: "" + cloudevent_ListItemFilterOutput: + description: "" + schema: + properties: + cloudevents: + items: + $ref: '#/definitions/CloudeventDetails' + 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 + cloudevent_PerformPurgeSplitableOutput: + description: "" + cloudevent_ValidateCreateDataOutput: + description: "" + schema: + properties: + cloudevent: + $ref: '#/definitions/CloudeventDetails' + type: object + cloudevent_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cloudevent: + $ref: '#/definitions/CloudeventDetails' + type: object + cloudprovider_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + type: object + cloudprovider_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + type: object + cloudprovider_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsStatusOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudprovider_GetPropertyDistinctFieldOutput: + description: "" + cloudprovider_GetPropertySplitableExportOutput: + description: "" + cloudprovider_GetPropertySplitableOutput: + description: "" + cloudprovider_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/StatusStatistic' + type: object + cloudprovider_GetPropertyTagValuePairsOutput: + description: "" + cloudprovider_GetPropertyTagValueTreeOutput: + description: "" + cloudprovider_ListItemFilterOutput: + description: "" + schema: + properties: + cloudproviders: + items: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + 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 + cloudprovider_PerformClassMetadataOutput: + description: "" + cloudprovider_PerformDisableOutput: + description: "" + cloudprovider_PerformEnableOutput: + description: "" + cloudprovider_PerformPurgeSplitableOutput: + description: "" + cloudprovider_PerformSetClassMetadataOutput: + description: "" + cloudprovider_PerformSetOrgMetadataOutput: + description: "" + cloudprovider_PerformSetUserMetadataOutput: + description: "" + cloudprovider_PerformStatusOutput: + description: "" + cloudprovider_ValidateCreateDataOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + type: object + cloudprovider_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + type: object schemes: -- https -- http + - https + - http securityDefinitions: - keystone: - in: header - name: X-Auth-Token - type: apiKey + keystone: + in: header + name: X-Auth-Token + type: apiKey swagger: "2.0" diff --git a/docs/swagger/swagger_cloudid.yaml b/docs/swagger/swagger_cloudid.yaml index cc5772a02d..272e39441d 100644 --- a/docs/swagger/swagger_cloudid.yaml +++ b/docs/swagger/swagger_cloudid.yaml @@ -1,8809 +1,7483 @@ basePath: / consumes: -- application/json + - application/json definitions: - ChangeOwnerCandidateDomainsOutput: - properties: - candidates: - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: Candidates - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - CloudgroupAddUserInput: - properties: - clouduser_id: - description: 用户Id - type: string - x-go-name: ClouduserId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupAttachPolicyInput: - properties: - cloudpolicy_id: - description: 权限Id - type: string - x-go-name: CloudpolicyId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates type: object - x-go-name: Metadata - cloudpolicy_ids: - description: 权限Id列表, 权限provider必须和权限组provider一致 - items: - type: string - type: array - x-go-name: CloudpolicyIds - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - provider: - description: 平台, 目前支持Qcloud,Google,Azure,Aliyun,Huawei,Aws - type: string - x-go-name: Provider - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupDetachPolicyInput: - properties: - cloudpolicy_id: - description: 权限Id - type: string - x-go-name: CloudpolicyId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupDetails: - properties: - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloudgroupcache_count: - description: 公有云权限组缓存数量 - format: int64 - type: integer - x-go-name: CloudgroupcacheCount - cloudpolicies: - items: - $ref: '#/definitions/SCloudIdBaseResource' - type: array - x-go-name: Cloudpolicies - cloudpolicy_count: - description: 权限数量 - format: int64 - type: integer - x-go-name: CloudpolicyCount - clouduser_count: - description: 公有云子用户数量 - format: int64 - type: integer - x-go-name: ClouduserCount - cloudusers: - items: - $ref: '#/definitions/SCloudIdBaseResource' - type: array - x-go-name: Cloudusers - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis + CloudgroupAddUserInput: + properties: + clouduser_id: + description: 用户Id + type: string + x-go-name: ClouduserId type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupRemoveUserInput: - properties: - clouduser_id: - description: 用户Id - type: string - x-go-name: ClouduserId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupSetPoliciesInput: - properties: - cloudpolicy_ids: - description: 权限Ids - items: - type: string - type: array - x-go-name: CloudpolicyIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupSetUsersInput: - properties: - clouduser_ids: - description: 公有云子账号Ids - items: - type: string - type: array - x-go-name: ClouduserIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudgroupcacheDetails: - properties: - brand: - description: 品牌信息 - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloudaccount: - description: 云账号名称 - type: string - x-go-name: Cloudaccount - cloudaccount_id: - description: 云账号Id - type: string - x-go-name: CloudaccountId - cloudgroup_id: - description: 用户组Id - type: string - x-go-name: CloudgroupId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - iam_login_url: - description: 公有云账号登录地址 - type: string - x-go-name: IamLoginUrl - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupAttachPolicyInput: + properties: + cloudpolicy_id: + description: 权限Id + type: string + x-go-name: CloudpolicyId type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 平台信息 - type: string - x-go-name: Provider - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudpolicyAssignGroupInput: - properties: - cloudgroup_id: - description: 权限组Id - type: string - x-go-name: CloudgroupId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudpolicyCacheInput: - properties: - manager_id: - description: 云订阅Id - type: string - x-go-name: ManagerId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudpolicyCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudaccount_id: + description: 'swagger: ignore' + type: string + x-go-name: CloudaccountId + cloudpolicy_ids: + description: 权限Id列表, 权限provider必须和权限组provider一致 + items: + type: string + type: array + x-go-name: CloudpolicyIds + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager_id: + description: 子账号Id + type: string + x-go-name: ManagerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name type: object - x-go-name: Metadata - cloud_env: - type: string - x-go-name: CloudEnv - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - document: - description: 策略详情 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupDetachPolicyInput: + properties: + cloudpolicy_id: + description: 权限Id + type: string + x-go-name: CloudpolicyId type: object - x-go-name: Document - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - policy_type: - default: custom - type: string - x-go-name: PolicyType - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - provider: - description: 平台 - type: string - x-go-name: Provider - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudpolicyDetails: - properties: - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - type: string - x-go-name: CloudEnv - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - document: - description: 策略内容 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupDetails: + properties: + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + cloudpolicies: + items: + $ref: '#/definitions/SCloudIdBaseResource' + type: array + x-go-name: Cloudpolicies + cloudpolicy_count: + description: 权限数量 + format: int64 + type: integer + x-go-name: CloudpolicyCount + clouduser_count: + description: 公有云子用户数量 + format: int64 + type: integer + x-go-name: ClouduserCount + cloudusers: + items: + $ref: '#/definitions/SCloudIdBaseResource' + type: array + x-go-name: Cloudusers + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 子订阅Id + type: string + x-go-name: ManagerId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt type: object - x-go-name: Document - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - locked: - description: 是否锁定, 若锁定后, 此策略不允许被绑定到用户或权限组, 仅管理员可以设置是否锁定 - type: boolean - x-go-name: Locked - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupRemoveUserInput: + properties: + clouduser_id: + description: 用户Id + type: string + x-go-name: ClouduserId type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - policy_type: - description: |- - 权限类型 - 权限类型 | 说明 | - ---------------|----------------------| - system | 平台内置权限 | - custom | 用户自定义权限 | - type: string - x-go-name: PolicyType - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: "平台\n 云平台 | 说明 |\n----------|---------------------------------------------|\n - Google | 支持 |\n Aliyun | 支持\t\t\t\t\t\t\t\t\t\t|\n - Huawei | 支持 |\n Azure | 支持 |\n - 腾讯云 | 支持 |" - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudpolicyRevokeGroupInput: - properties: - cloudgroup_id: - description: 权限组Id - type: string - x-go-name: CloudgroupId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudpolicyUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - document: + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupSetPoliciesInput: + properties: + cloudpolicy_ids: + description: 权限Ids + items: + type: string + type: array + x-go-name: CloudpolicyIds type: object - x-go-name: Document - name: - description: 资源名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudpolicycacheDetails: - properties: - brand: - description: 品牌信息 - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloudaccount: - description: 云账号名称 - type: string - x-go-name: Cloudaccount - cloudprovider: - description: 云订阅名称 - type: string - x-go-name: Cloudprovider - delete_fail_reason: - $ref: '#/definitions/Error' - iam_login_url: - description: 公有云账号登录地址 - type: string - x-go-name: IamLoginUrl - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupSetUsersInput: + properties: + clouduser_ids: + description: 公有云子账号Ids + items: + type: string + type: array + x-go-name: ClouduserIds type: object - x-go-name: Metadata - provider: - description: 平台信息 - type: string - x-go-name: Provider - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudroleDetails: - properties: - brand: - description: 品牌信息 - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloudaccount: - description: 云账号名称 - type: string - x-go-name: Cloudaccount - cloudaccount_id: - description: 云账号Id - type: string - x-go-name: CloudaccountId - cloudgroup_id: - type: string - x-go-name: CloudgroupId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - document: + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupSyncstatusInput: type: object - x-go-name: Document - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - iam_login_url: - description: 公有云账号登录地址 - type: string - x-go-name: IamLoginUrl - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupUpdateInput: type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - owner_id: - type: string - x-go-name: OwnerId - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 平台信息 - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - saml_provider_id: - type: string - x-go-name: SAMLProviderId - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - CloudrolePurgeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserAttachPolicyInput: - properties: - cloudpolicy_id: - description: |- - 权限Id + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudpolicyDetails: + properties: + CloudgroupCount: + format: int64 + type: integer + ClouduserCount: + format: int64 + type: integer + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + document: + description: 策略内容 + type: object + x-go-name: Document + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 子订阅Id + type: string + x-go-name: ManagerId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + policy_type: + description: |- + 权限类型 + 权限类型 | 说明 | + ---------------|----------------------| + system | 平台内置权限 | + custom | 用户自定义权限 | + type: string + x-go-name: PolicyType + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudroleDetails: + properties: + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + cloudgroup_id: + type: string + x-go-name: CloudgroupId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + document: + type: object + x-go-name: Document + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 子订阅Id + type: string + x-go-name: ManagerId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + saml_provider_id: + type: string + x-go-name: SAMLProviderId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserAttachPolicyInput: + properties: + cloudpolicy_id: + description: |- + 权限Id - 云平台 | 说明 | - ----------|---------------------------------------------| - Google | 支持 | - Aliyun | 支持 | - Huawei | 不支持 | - Azure | 支持 | - 腾讯云 | 支持 | - type: string - x-go-name: CloudpolicyId - cloudprovider_id: - description: 订阅Id, 向云账号赋予某个订阅的权限, 目前仅Google,Azure平台此参数生效 - type: string - x-go-name: CloudproviderId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserChangeOwnerInput: - properties: - user_id: - description: 本地用户Id - type: string - x-go-name: UserId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserCreateAccessKeyInput: - properties: - name: - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 支持 | + Aliyun | 支持 | + Huawei | 不支持 | + Azure | 支持 | + 腾讯云 | 支持 | + type: string + x-go-name: CloudpolicyId type: object - x-go-name: Metadata - cloudaccount_id: - description: |- - 云账号ID - Azure云账号需要有User administrator权限，否则删操作会出现Insufficient privileges to complete the operation错误信息 - type: string - x-go-name: CloudaccountId - cloudgroup_ids: - description: 初始化权限组Id列表, 权限组必须和云账号平台属性相同 - items: - type: string - type: array - x-go-name: CloudgroupIds - cloudpolicy_ids: - description: |- - 初始的权限Id列表, 权限必须属于指定的云账号 - - - - 云平台 | 说明 | - ----------|---------------------------------------------| - Google | 至少需要一个初始权限 | - Aliyun | 支持 | - Huawei | 不支持 | - Azure | 支持 | - 腾讯云 | 支持 | - items: - type: string - type: array - x-go-name: CloudpolicyIds - cloudprovider_id: - description: |- - 云订阅ID, 若此参数为空, 则cloudpolicy_ids的权限会绑定到此账号的所有订阅, 若不为空则cloudpolicy_ids仅绑定的指定的订阅 - 此参数仅对Google,Azure生效 - type: string - x-go-name: CloudproviderId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - email: - description: 邮箱地址 - example: test@example.com - type: string - x-go-name: Email - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_console_login: - default: false - description: 是否可控制台登录 - type: boolean - x-go-name: IsConsoleLogin - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - mobile_phone: - description: 手机号码 - example: 86-1868888**** - type: string - x-go-name: MobilePhone - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - notify: - default: false - description: 是否发送邮件通知(仅设置email不为空生效) - type: boolean - x-go-name: Notify - owner_id: - description: 本地用户Id，若为空则使用当前用户Id作为此参数值 - type: string - x-go-name: OwnerId - password: - description: |- - 用户密码, 若is_console_login = true时, 此参数不传时会生成12位随机密码 - - - - 云平台 | 说明 | - ----------|---------------------------------------------| - Google | 不支持此参数 | - Aliyun | 支持 | - Huawei | 支持 | - Azure | 支持 | - 腾讯云 | 支持 | - type: string - x-go-name: Password - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserDeleteAccessKeyInput: - properties: - access_key: - type: string - x-go-name: AccessKey - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserDetachPolicyInput: - properties: - cloudpolicy_id: - description: |- - 权限Id - - - - 云平台 | 说明 | - ----------|---------------------------------------------| - Google | 支持，但最少需要保留一个权限 | - Aliyun | 支持 | - Huawei | 不支持 | - Azure | 不支持 | - 腾讯云 | 支持 | - type: string - x-go-name: CloudpolicyId - cloudprovider_id: - description: 订阅Id, 解绑云账号赋予某个订阅的权限, 目前仅Google,Azure平台此参数生效 - type: string - x-go-name: CloudproviderId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserDetails: - properties: - brand: - description: 品牌信息 - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloudaccount: - description: 云账号名称 - type: string - x-go-name: Cloudaccount - cloudaccount_id: - description: 云账号Id - type: string - x-go-name: CloudaccountId - cloudgroup_count: - description: 权限组数量 - format: int64 - type: integer - x-go-name: CloudgroupCount - cloudgroups: - items: - $ref: '#/definitions/SCloudIdBaseResource' - type: array - x-go-name: Cloudgroups - cloudpolicies: - items: - $ref: '#/definitions/ClouduserpolicyDetails' - type: array - x-go-name: Cloudpolicies - cloudpolicy_count: - description: 权限数量 - format: int64 - type: integer - x-go-name: CloudpolicyCount - cloudprovider: - description: 云订阅名称 - type: string - x-go-name: Cloudprovider - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - email: - description: 邮箱地址 - type: string - x-go-name: Email - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - iam_login_url: - description: 公有云账号登录地址 - type: string - x-go-name: IamLoginUrl - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_console_login: - description: 是否可以控制台登录 - type: boolean - x-go-name: IsConsoleLogin - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserChangeOwnerInput: + properties: + user_id: + description: 本地用户Id + type: string + x-go-name: UserId type: object - x-go-name: Metadata - mobile_phone: - description: 手机号码 - type: string - x-go-name: MobilePhone - name: - description: 资源名称 - type: string - x-go-name: Name - owner_id: - description: 本地用户Id - type: string - x-go-name: OwnerId - owner_name: - description: 用户名称 - type: string - x-go-name: OwnerName - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 平台信息 - type: string - x-go-name: Provider - secret: - type: string - x-go-name: Secret - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserJoinGroupInput: - properties: - cloudgroup_id: - description: 权限组Id - type: string - x-go-name: CloudgroupId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserLeaveGroupInput: - properties: - cloudgroup_id: - description: 权限组Id - type: string - x-go-name: CloudgroupId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserResetPasswordInput: - properties: - password: - description: |- - 若此参数为空, 默认会生成随机12位密码 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserCreateAccessKeyInput: + properties: + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudaccount_id: + description: |- + 云账号ID + Azure云账号需要有User administrator权限，否则删操作会出现Insufficient privileges to complete the operation错误信息 + type: string + x-go-name: CloudaccountId + cloudgroup_ids: + description: 初始化权限组Id列表, 权限组必须和云账号平台属性相同 + items: + type: string + type: array + x-go-name: CloudgroupIds + cloudpolicy_ids: + description: |- + 初始的权限Id列表, 权限必须属于指定的云账号 - 云平台 | 说明 | - ----------|---------------------------------------------| - Google | 不支持 | - Aliyun | 支持 | - Huawei | 支持 | - Azure | 支持 | - 腾讯云 | 支持 | - type: string - x-go-name: Password - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserSetGroupsInput: - properties: - cloudgroup_ids: - description: 权限组Ids - items: - type: string - type: array - x-go-name: CloudgroupIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserSetPoliciesInput: - properties: - cloudpolicy_ids: - description: 权限Ids - items: - type: string - type: array - x-go-name: CloudpolicyIds - cloudprovider_id: - description: 订阅Id, 设置云账号赋予某个订阅的权限, 目前仅Google,Azure平台此参数生效 - type: string - x-go-name: CloudproviderId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserSyncInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - ClouduserpolicyDetails: - properties: - cloudprovider_id: - description: 子订阅Id - type: string - x-go-name: CloudproviderId - id: - description: 权限Id - type: string - x-go-name: Id - manager: - description: 子订阅名称 - type: string - x-go-name: Manager - name: - description: 权限名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - EnabledStatusInfrasResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - Error: - properties: - class: - type: string - x-go-name: Class - code: - format: int64 - type: integer - x-go-name: Code - details: - type: string - x-go-name: Details - type: object - x-go-package: yunion.io/x/onecloud/pkg/httperrors - GetDetailsStatusOutput: - properties: - status: - description: 状态 - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformChangeDomainOwnerInput: - properties: - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformDisableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformEnableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPrivateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPublicDomainInput: - properties: - scope: - description: 共享项目资源的共享范围，可能的值为：project, domain和system - pattern: project|domain|system - type: string - x-go-name: Scope - shared_domain_ids: - description: 如果共享范围为域，则在此列表中指定共享的目标域 - items: - type: string - type: array - x-go-name: SharedDomainIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformStatusInput: - properties: - host_id: - description: call from host id - type: string - x-go-name: HostId - power_states: - description: 电源状态 - type: string - x-go-name: PowerStates - reason: - description: 更改状态的原因描述 - type: string - x-go-name: Reason - status: - description: 更改的目标状态值 - type: string - x-go-name: Status - required: - - status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PurgeSplitTableInput: - properties: - tables: - items: - type: string - type: array - x-go-name: Tables - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - SAMLProviderCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 至少需要一个初始权限 | + Aliyun | 支持 | + Huawei | 不支持 | + Azure | 支持 | + 腾讯云 | 支持 | + items: + type: string + type: array + x-go-name: CloudpolicyIds + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + email: + description: 邮箱地址 + example: test@example.com + type: string + x-go-name: Email + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_console_login: + default: false + description: 是否可控制台登录 + type: boolean + x-go-name: IsConsoleLogin + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + mobile_phone: + description: 手机号码 + example: 86-1868888**** + type: string + x-go-name: MobilePhone + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + notify: + default: false + description: 是否发送邮件通知(仅设置email不为空生效) + type: boolean + x-go-name: Notify + owner_id: + description: 本地用户Id，若为空则使用当前用户Id作为此参数值 + type: string + x-go-name: OwnerId + password: + description: |- + 用户密码, 若is_console_login = true时, 此参数不传时会生成12位随机密码 + + + + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 不支持此参数 | + Aliyun | 支持 | + Huawei | 支持 | + Azure | 支持 | + 腾讯云 | 支持 | + type: string + x-go-name: Password + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name type: object - x-go-name: Metadata - cloudaccount_id: - type: string - x-go-name: CloudaccountId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - SAMLProviderDetails: - properties: - auth_url: - type: string - x-go-name: AuthUrl - brand: - description: 品牌信息 - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloudaccount: - description: 云账号名称 - type: string - x-go-name: Cloudaccount - cloudaccount_id: - description: 云账号Id - type: string - x-go-name: CloudaccountId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - entity_id: - type: string - x-go-name: EntityId - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - iam_login_url: - description: 公有云账号登录地址 - type: string - x-go-name: IamLoginUrl - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserDeleteAccessKeyInput: + properties: + access_key: + type: string + x-go-name: AccessKey type: object - x-go-name: Metadata - metadata_document: - type: string - x-go-name: MetadataDocument - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 平台信息 - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - shared_domains: - description: 共享的域列表 + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserDetachPolicyInput: + properties: + cloudpolicy_id: + description: |- + 权限Id + + + + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 支持，但最少需要保留一个权限 | + Aliyun | 支持 | + Huawei | 不支持 | + Azure | 不支持 | + 腾讯云 | 支持 | + type: string + x-go-name: CloudpolicyId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserDetails: + properties: + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + cloudgroup_count: + description: 权限组数量 + format: int64 + type: integer + x-go-name: CloudgroupCount + cloudgroups: + items: + $ref: '#/definitions/SCloudIdBaseResource' + type: array + x-go-name: Cloudgroups + cloudpolicies: + items: + $ref: '#/definitions/SCloudIdBaseResource' + type: array + x-go-name: Cloudpolicies + cloudpolicy_count: + description: 权限数量 + format: int64 + type: integer + x-go-name: CloudpolicyCount + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + email: + description: 邮箱地址 + type: string + x-go-name: Email + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_console_login: + description: 是否可以控制台登录 + type: boolean + x-go-name: IsConsoleLogin + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 子订阅Id + type: string + x-go-name: ManagerId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + mobile_phone: + description: 手机号码 + type: string + x-go-name: MobilePhone + name: + description: 资源名称 + type: string + x-go-name: Name + owner_id: + description: 本地用户Id + type: string + x-go-name: OwnerId + owner_name: + description: 用户名称 + type: string + x-go-name: OwnerName + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + secret: + type: string + x-go-name: Secret + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserJoinGroupInput: + properties: + cloudgroup_id: + description: 权限组Id + type: string + x-go-name: CloudgroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserLeaveGroupInput: + properties: + cloudgroup_id: + description: 权限组Id + type: string + x-go-name: CloudgroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserResetPasswordInput: + properties: + password: + description: |- + 若此参数为空, 默认会生成随机12位密码 + + + + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 不支持 | + Aliyun | 支持 | + Huawei | 支持 | + Azure | 支持 | + 腾讯云 | 支持 | + type: string + x-go-name: Password + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserSetGroupsInput: + properties: + cloudgroup_ids: + description: 权限组Ids + items: + type: string + type: array + x-go-name: CloudgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserSetPoliciesInput: + properties: + cloudpolicy_ids: + description: 权限Ids + items: + type: string + type: array + x-go-name: CloudpolicyIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + EnabledStatusInfrasResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + GetCloudaccountSamlOutput: + properties: + entity_id: + description: cloudaccount SAML ServiceProvider entity ID + type: string + x-go-name: EntityId + init_login_url: + description: initial SAML SSO login URL for this cloudaccount + type: string + x-go-name: InitLoginUrl + metadata_url: + description: metadata URL for this cloudaccount + type: string + x-go-name: MetadataUrl + redirect_login_url: + description: redirect login URL for this cloudaccount + type: string + x-go-name: RedirectLoginUrl + redirect_logout_url: + description: redirect logout URL for this cloudaccount + type: string + x-go-name: RedirectLogoutUrl + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformChangeDomainOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicDomainInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformStatusInput: + properties: + host_id: + description: call from host id + type: string + x-go-name: HostId + power_states: + description: 电源状态 + type: string + x-go-name: PowerStates + reason: + description: 更改状态的原因描述 + type: string + x-go-name: Reason + status: + description: 更改的目标状态值 + type: string + x-go-name: Status + required: + - status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SAMLProviderDetails: + properties: + auth_url: + type: string + x-go-name: AuthUrl + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + entity_id: + type: string + x-go-name: EntityId + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager_id: + description: 子订阅Id + type: string + x-go-name: ManagerId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + metadata_document: + type: string + x-go-name: MetadataDocument + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + SCloudIdBaseResource: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + STag: + properties: + key: + description: 标签Kye + type: string + x-go-name: Key + value: + description: 标签Value + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + SamluserCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudaccount_id: + description: 权限组和账号必须是同一平台 + type: string + x-go-name: CloudaccountId + cloudgroup_id: + description: 权限组和账号必须是同一平台 + type: string + x-go-name: CloudgroupId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + email: + type: string + x-go-name: Email + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + owner_id: + description: 本地用户Id，若为空则使用当前用户Id作为此参数值 + type: string + x-go-name: OwnerId + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + SamluserDetails: + properties: + CloudaccountId: + type: string + Manager: + type: string + ManagerId: + type: string + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudgroup: + description: 公有云用户名称 + type: string + x-go-name: Cloudgroup + cloudgroup_id: + type: string + x-go-name: CloudgroupId + cloudrole_id: + type: string + x-go-name: CloudroleId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + email: + description: 邮箱地址 + type: string + x-go-name: Email + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + owner_id: + description: 本地用户Id + type: string + x-go-name: OwnerId + owner_name: + description: 用户名称 + type: string + x-go-name: OwnerName + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + SharedDomain: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharedProject: + properties: + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusDomainLevelResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusInfrasResourceBaseCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusInfrasResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TTagSet: items: - $ref: '#/definitions/SharedDomain' + $ref: '#/definitions/STag' type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: items: - $ref: '#/definitions/SharedProject' + $ref: '#/definitions/TTagSet' type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - SCloudIdBaseResource: - properties: - id: - type: string - x-go-name: Id - name: - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - STag: - properties: - key: - description: 标签Kye - type: string - x-go-name: Key - value: - description: 标签Value - type: string - x-go-name: Value - type: object - x-go-package: yunion.io/x/onecloud/pkg/util/tagutils - SamluserCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - cloudaccount_id: - description: 权限组和账号必须是同一平台 - type: string - x-go-name: CloudaccountId - cloudgroup_id: - description: 权限组和账号必须是同一平台 - type: string - x-go-name: CloudgroupId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - email: - type: string - x-go-name: Email - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - owner_id: - description: 本地用户Id，若为空则使用当前用户Id作为此参数值 - type: string - x-go-name: OwnerId - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - SamluserDetails: - properties: - brand: - description: 品牌信息 - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloudaccount: - description: 云账号名称 - type: string - x-go-name: Cloudaccount - cloudaccount_id: - description: 云账号Id - type: string - x-go-name: CloudaccountId - cloudgroup: - description: 公有云用户名称 - type: string - x-go-name: Cloudgroup - cloudgroup_id: - type: string - x-go-name: CloudgroupId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - email: - description: 邮箱地址 - type: string - x-go-name: Email - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - iam_login_url: - description: 公有云账号登录地址 - type: string - x-go-name: IamLoginUrl - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - owner_id: - description: 本地用户Id - type: string - x-go-name: OwnerId - owner_name: - description: 用户名称 - type: string - x-go-name: OwnerName - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 平台信息 - type: string - x-go-name: Provider - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid - SharedDomain: - properties: - id: - type: string - x-go-name: Id - name: - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - SharedProject: - properties: - domain: - type: string - x-go-name: Domain - domain_id: - type: string - x-go-name: DomainId - id: - type: string - x-go-name: Id - name: - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusDomainLevelResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusInfrasResourceBaseCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusInfrasResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStandaloneResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStandaloneResourceCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStatistic: - properties: - TotalCpuCount: - description: CPU总量 - format: int64 - type: integer - TotalDiskSizeMb: - description: 存储总量 - format: int64 - type: integer - TotalMemSizeMb: - description: 内存总量 - format: int64 - type: integer - status_info: - items: - $ref: '#/definitions/StatusStatisticStatusInfo' - type: array - x-go-name: StatusInfo - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStatisticStatusInfo: - properties: - Status: - type: string - pending_deleted_count: - description: |- - 回收站数量 - 需要指定pending_delete=all - format: int64 - type: integer - x-go-name: PendingDeletedCount - total_count: - description: 资源总数 - format: int64 - type: integer - x-go-name: TotalCount - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - TTagSet: - items: - $ref: '#/definitions/STag' - type: array - x-go-package: yunion.io/x/onecloud/pkg/util/tagutils - TTagSetList: - items: - $ref: '#/definitions/TTagSet' - type: array - x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils host: '"127.0.0.1:8889"' info: - contact: - email: lizexi@yunion.cn - name: Zexi Li - description: Cloudid API - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html - version: "1.0" + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Cloudid API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" paths: - /cloudgroupcaches: - get: - description: 列表 - operationId: cloudgroupcache_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： + /cloudgroups: + get: + description: 列表 + operationId: cloudgroup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 根据云账号名称过滤资源 - in: query - name: cloudaccount - type: string - x-go-name: Cloudaccount - - description: 根据平台过滤 - in: query - items: - type: string - name: provider - type: array - x-go-name: Provider - - description: 根据权限组过滤 - in: query - name: cloudgroup_id - type: string - x-go-name: CloudgroupId - responses: - "200": - $ref: '#/responses/cloudgroupcache_ListItemFilterOutput' - summary: 公有云权限组缓存 - tags: - - cloudgroupcache - /cloudgroupcaches/{id}: - delete: - description: 删除 - operationId: cloudgroupcache_CustomizeDelete - parameters: - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroupcache_CustomizeDeleteOutput' - summary: 删除权限组缓存 - tags: - - cloudgroupcache - get: - description: 获取详情 - operationId: cloudgroupcache_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroupcache_FetchCustomizeColumnsOutput' - summary: 获取权限组缓存详情 - tags: - - cloudgroupcache - /cloudgroupcaches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudgroupcache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroupcache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudgroupcache - post: - description: 执行操作ClassMetadata - operationId: cloudgroupcache_PerformClassMetadata - parameters: - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroupcache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroupcache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudgroupcache - /cloudgroupcaches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudgroupcache_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 根据云订阅过滤资源 + in: query + name: manager_id + type: string + x-go-name: ManagerId + - description: 过滤子账号所在的权限组 + in: query + name: clouduser_id + type: string + x-go-name: ClouduserId + - description: 根据权限过滤权限组 + in: query + name: cloudpolicy_id + type: string + x-go-name: CloudpolicyId + responses: + "200": + $ref: '#/responses/cloudgroup_ListItemFilterOutput' + summary: 权限组列表 + tags: + - cloudgroup + post: + description: 新建 + operationId: cloudgroup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_ValidateCreateDataOutput' + summary: 创建权限组 + tags: + - cloudgroup + /cloudgroups/{id}: + delete: + description: 删除 + operationId: cloudgroup_CustomizeDelete + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_CustomizeDeleteOutput' + summary: 删除权限组 + tags: + - cloudgroup + get: + description: 获取详情 + operationId: cloudgroup_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_FetchCustomizeColumnsOutput' + summary: 获取权限组详情 + tags: + - cloudgroup + put: + description: 更新 + operationId: cloudgroup_ValidateUpdateData + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_ValidateUpdateDataOutput' + summary: 更新权限组 + tags: + - cloudgroup + /cloudgroups/{id}/add-user: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformAddUser + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupAddUserInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformAddUserOutput' + summary: 向权限组加入用户 + tags: + - cloudgroup + /cloudgroups/{id}/attach-policy: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformAttachPolicy + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupAttachPolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformAttachPolicyOutput' + summary: 向权限组添加权限 + tags: + - cloudgroup + /cloudgroups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cloudgroup_PerformChangeOwner + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cloudgroup + /cloudgroups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudgroup_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudgroup + /cloudgroups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudgroup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudgroup + post: + description: 执行操作ClassMetadata + operationId: cloudgroup_PerformClassMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudgroup + /cloudgroups/{id}/detach-policy: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformDetachPolicy + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetachPolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformDetachPolicyOutput' + summary: 从权限组移除权限 + tags: + - cloudgroup + /cloudgroups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudgroup_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | key以user:为前缀，用户自定义标签 | - 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 按标签前缀过滤 - in: query - name: prefix - type: string - x-go-name: Prefix - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroupcache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudgroupcache - /cloudgroupcaches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudgroupcache_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroupcache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroupcache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudgroupcache - /cloudgroupcaches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudgroupcache_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroupcache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroupcache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudgroupcache - /cloudgroupcaches/{id}/status: - get: - description: 获取指定信息Status - operationId: cloudgroupcache_GetDetailsStatus - parameters: - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroupcache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cloudgroupcache - post: - description: 执行操作Status - operationId: cloudgroupcache_PerformStatus - parameters: - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroupcache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroupcache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cloudgroupcache - /cloudgroupcaches/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: cloudgroupcache_PerformSyncstatus - parameters: - - description: The Id or Name of cloudgroupcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroupcache: - $ref: '#/definitions/CloudgroupSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroupcache_PerformSyncstatusOutput' - summary: 同步权限组缓存状态 - tags: - - cloudgroupcache - /cloudgroupcaches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudgroupcache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudgroupcache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudgroupcache - /cloudgroupcaches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudgroupcache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudgroupcache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroupcache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudgroupcache - /cloudgroupcaches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudgroupcache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudgroupcache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudgroupcache - /cloudgroupcaches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudgroupcache_GetPropertySplitableExport - parameters: - - in: query - name: table - type: string - x-go-name: Table - - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - responses: - "200": - $ref: '#/responses/cloudgroupcache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudgroupcache - /cloudgroupcaches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cloudgroupcache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cloudgroupcache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cloudgroupcache - /cloudgroupcaches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudgroupcache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudgroupcache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudgroupcache - /cloudgroupcaches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudgroupcache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudgroupcache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudgroupcache - /cloudgroups: - get: - description: 列表 - operationId: cloudgroup_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudgroup + /cloudgroups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cloudgroup_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cloudgroup + /cloudgroups/{id}/private: + post: + description: 执行操作Private + operationId: cloudgroup_PerformPrivate + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cloudgroup + /cloudgroups/{id}/public: + post: + description: 执行操作Public + operationId: cloudgroup_PerformPublic + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformPublicOutput' + summary: 执行操作Public + tags: + - cloudgroup + /cloudgroups/{id}/remove-user: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformRemoveUser + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupRemoveUserInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformRemoveUserOutput' + summary: 从权限组移除用户 + tags: + - cloudgroup + /cloudgroups/{id}/saml: + get: + description: 获取指定信息Saml + operationId: cloudgroup_GetDetailsSaml + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsSamlOutput' + summary: 获取指定信息Saml + tags: + - cloudgroup + /cloudgroups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudgroup_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudgroup + /cloudgroups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cloudgroup_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudgroup + /cloudgroups/{id}/set-policies: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformSetPolicies + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupSetPoliciesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSetPoliciesOutput' + summary: 设置权限组添权限(全量覆盖) + tags: + - cloudgroup + /cloudgroups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudgroup_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudgroup + /cloudgroups/{id}/set-users: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformSetUsers + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupSetUsersInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSetUsersOutput' + summary: 设置权限组用户(全量覆盖) + tags: + - cloudgroup + /cloudgroups/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudgroup_GetDetailsStatus + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudgroup + post: + description: 执行操作Status + operationId: cloudgroup_PerformStatus + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudgroup + /cloudgroups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: cloudgroup_PerformSyncstatus + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSyncstatusOutput' + summary: 恢复权限组状态 + tags: + - cloudgroup + /cloudgroups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudgroup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudgroup + /cloudgroups/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: cloudgroup_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - cloudgroup + /cloudgroups/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: cloudgroup_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - cloudgroup + /cloudgroups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudgroup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudgroup + /cloudgroups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudgroup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudgroup + /cloudgroups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudgroup_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudgroup + /cloudgroups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudgroup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudgroup + /cloudgroups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudgroup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudgroup + /cloudgroups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudgroup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudgroup + /cloudpolicies: + get: + description: 列表 + operationId: cloudpolicy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 根据平台过滤 - in: query - items: - type: string - name: provider - type: array - x-go-name: Provider - - description: 过滤子账号所在的权限组 - in: query - name: clouduser_id - type: string - x-go-name: ClouduserId - - description: 根据权限过滤权限组 - in: query - name: cloudpolicy_id - type: string - x-go-name: CloudpolicyId - - description: 是否可用 - in: query - name: usable - type: boolean - x-go-name: Usable - responses: - "200": - $ref: '#/responses/cloudgroup_ListItemFilterOutput' - summary: 权限组列表 - tags: - - cloudgroup - post: - description: 新建 - operationId: cloudgroup_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_ValidateCreateDataOutput' - summary: 创建权限组 - tags: - - cloudgroup - /cloudgroups/{id}: - delete: - description: 删除 - operationId: cloudgroup_CustomizeDelete - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroup_CustomizeDeleteOutput' - summary: 删除权限组 - tags: - - cloudgroup - get: - description: 获取详情 - operationId: cloudgroup_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroup_FetchCustomizeColumnsOutput' - summary: 获取权限组详情 - tags: - - cloudgroup - put: - description: 更新 - operationId: cloudgroup_ValidateUpdateData - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_ValidateUpdateDataOutput' - summary: 更新权限组 - tags: - - cloudgroup - /cloudgroups/{id}/add-user: - post: - description: '权限组状态必须为: available' - operationId: cloudgroup_PerformAddUser - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupAddUserInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformAddUserOutput' - summary: 向权限组加入用户 - tags: - - cloudgroup - /cloudgroups/{id}/attach-policy: - post: - description: '权限组状态必须为: available' - operationId: cloudgroup_PerformAttachPolicy - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupAttachPolicyInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformAttachPolicyOutput' - summary: 向权限组添加权限 - tags: - - cloudgroup - /cloudgroups/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: cloudgroup_PerformChangeOwner - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - cloudgroup - /cloudgroups/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: cloudgroup_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroup_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - cloudgroup - /cloudgroups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudgroup_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroup_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudgroup - post: - description: 执行操作ClassMetadata - operationId: cloudgroup_PerformClassMetadata - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudgroup - /cloudgroups/{id}/detach-policy: - post: - description: '权限组状态必须为: available' - operationId: cloudgroup_PerformDetachPolicy - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupDetachPolicyInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformDetachPolicyOutput' - summary: 从权限组移除权限 - tags: - - cloudgroup - /cloudgroups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudgroup_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 - - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | key以user:为前缀，用户自定义标签 | - 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 按标签前缀过滤 - in: query - name: prefix - type: string - x-go-name: Prefix - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroup_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudgroup - /cloudgroups/{id}/private: - post: - description: 执行操作Private - operationId: cloudgroup_PerformPrivate - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformPrivateOutput' - summary: 执行操作Private - tags: - - cloudgroup - /cloudgroups/{id}/public: - post: - description: 执行操作Public - operationId: cloudgroup_PerformPublic - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformPublicOutput' - summary: 执行操作Public - tags: - - cloudgroup - /cloudgroups/{id}/remove-user: - post: - description: '权限组状态必须为: available' - operationId: cloudgroup_PerformRemoveUser - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupRemoveUserInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformRemoveUserOutput' - summary: 从权限组移除用户 - tags: - - cloudgroup - /cloudgroups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudgroup_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudgroup - /cloudgroups/{id}/set-policies: - post: - description: '权限组状态必须为: available' - operationId: cloudgroup_PerformSetPolicies - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupSetPoliciesInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformSetPoliciesOutput' - summary: 设置权限组添权限(全量覆盖) - tags: - - cloudgroup - /cloudgroups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudgroup_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudgroup - /cloudgroups/{id}/set-users: - post: - description: '权限组状态必须为: available' - operationId: cloudgroup_PerformSetUsers - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupSetUsersInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformSetUsersOutput' - summary: 设置权限组用户(全量覆盖) - tags: - - cloudgroup - /cloudgroups/{id}/status: - get: - description: 获取指定信息Status - operationId: cloudgroup_GetDetailsStatus - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudgroup_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cloudgroup - post: - description: 执行操作Status - operationId: cloudgroup_PerformStatus - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cloudgroup - /cloudgroups/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: cloudgroup_PerformSyncstatus - parameters: - - description: The Id or Name of cloudgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformSyncstatusOutput' - summary: 恢复权限组状态 - tags: - - cloudgroup - /cloudgroups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudgroup_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudgroup_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudgroup - /cloudgroups/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: cloudgroup_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/cloudgroup_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - cloudgroup - /cloudgroups/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: cloudgroup_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/cloudgroup_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - cloudgroup - /cloudgroups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudgroup_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudgroup: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudgroup_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudgroup - /cloudgroups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudgroup_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudgroup_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudgroup - /cloudgroups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudgroup_GetPropertySplitableExport - parameters: - - in: query - name: table - type: string - x-go-name: Table - - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - responses: - "200": - $ref: '#/responses/cloudgroup_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudgroup - /cloudgroups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cloudgroup_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cloudgroup_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cloudgroup - /cloudgroups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudgroup_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudgroup_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudgroup - /cloudgroups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudgroup_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudgroup_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudgroup - /cloudpolicies: - get: - description: 列表 - operationId: cloudpolicy_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 根据平台过滤 - in: query - items: - type: string - name: provider - type: array - x-go-name: Provider - - description: 根据子账号过滤权限 - in: query - name: clouduser_id - type: string - x-go-name: ClouduserId - - description: 根据权限组过滤权限 - in: query - name: cloudgroup_id - type: string - x-go-name: CloudgroupId - - description: 根据订阅过滤权限 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: |- - 权限类型 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 根据子账号过滤权限 + in: query + name: clouduser_id + type: string + x-go-name: ClouduserId + - description: 根据权限组过滤权限 + in: query + name: cloudgroup_id + type: string + x-go-name: CloudgroupId + - description: 根据订阅过滤权限 + in: query + name: manager_id + type: string + x-go-name: ManagerId + - description: |- + 权限类型 - 类型 | 说明 | - ---------| ------------ | - system | 过滤系统权限 | - custom | 过滤自定义权限 | - in: query - name: policy_type - type: string - x-go-name: PolicyType - - description: 是否显示Locked的权限 - in: query - name: locked - type: boolean - x-go-name: Locked - responses: - "200": - $ref: '#/responses/cloudpolicy_ListItemFilterOutput' - summary: 公有云权限列表 - tags: - - cloudpolicy - post: - description: 新建 - operationId: cloudpolicy_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_ValidateCreateDataOutput' - summary: 创建自定义策略 - tags: - - cloudpolicy - /cloudpolicies/{id}: - delete: - description: 删除 - operationId: cloudpolicy_CustomizeDelete - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicy_CustomizeDeleteOutput' - summary: 删除自定义权限 - tags: - - cloudpolicy - get: - description: 获取详情 - operationId: cloudpolicy_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicy_FetchCustomizeColumnsOutput' - summary: 获取公有云权限详情 - tags: - - cloudpolicy - put: - description: 更新 - operationId: cloudpolicy_ValidateUpdateData - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_ValidateUpdateDataOutput' - summary: 更新策略(仅限自定义) - tags: - - cloudpolicy - /cloudpolicies/{id}/assign-group: - post: - description: 执行操作AssignGroup - operationId: cloudpolicy_PerformAssignGroup - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyAssignGroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformAssignGroupOutput' - summary: 将权限加入权限组 - tags: - - cloudpolicy - /cloudpolicies/{id}/cache: - post: - description: 执行操作Cache - operationId: cloudpolicy_PerformCache - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyCacheInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformCacheOutput' - summary: 缓存自定义权限到云上 - tags: - - cloudpolicy - /cloudpolicies/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: cloudpolicy_PerformChangeOwner - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - cloudpolicy - /cloudpolicies/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: cloudpolicy_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicy_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - cloudpolicy - /cloudpolicies/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudpolicy_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicy_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudpolicy - post: - description: 执行操作ClassMetadata - operationId: cloudpolicy_PerformClassMetadata - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudpolicy - /cloudpolicies/{id}/lock: - post: - description: 执行操作Lock - operationId: cloudpolicy_PerformLock - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyAssignGroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformLockOutput' - summary: 锁定权限(禁止使用此权限) - tags: - - cloudpolicy - /cloudpolicies/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudpolicy_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 类型 | 说明 | + ---------| ------------ | + system | 过滤系统权限 | + custom | 过滤自定义权限 | + in: query + name: policy_type + type: string + x-go-name: PolicyType + responses: + "200": + $ref: '#/responses/cloudpolicy_ListItemFilterOutput' + summary: 公有云权限列表 + tags: + - cloudpolicy + /cloudpolicies/{id}: + delete: + description: 删除 + operationId: cloudpolicy_CustomizeDelete + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudpolicy + get: + description: 获取详情 + operationId: cloudpolicy_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_FetchCustomizeColumnsOutput' + summary: 获取公有云权限详情 + tags: + - cloudpolicy + /cloudpolicies/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cloudpolicy_PerformChangeOwner + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cloudpolicy + /cloudpolicies/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudpolicy_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudpolicy + /cloudpolicies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudpolicy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudpolicy + post: + description: 执行操作ClassMetadata + operationId: cloudpolicy_PerformClassMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudpolicy + /cloudpolicies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudpolicy_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | key以user:为前缀，用户自定义标签 | - 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 按标签前缀过滤 - in: query - name: prefix - type: string - x-go-name: Prefix - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicy_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudpolicy - /cloudpolicies/{id}/private: - post: - description: 执行操作Private - operationId: cloudpolicy_PerformPrivate - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformPrivateOutput' - summary: 执行操作Private - tags: - - cloudpolicy - /cloudpolicies/{id}/public: - post: - description: 执行操作Public - operationId: cloudpolicy_PerformPublic - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformPublicOutput' - summary: 执行操作Public - tags: - - cloudpolicy - /cloudpolicies/{id}/revoke-group: - post: - description: 执行操作RevokeGroup - operationId: cloudpolicy_PerformRevokeGroup - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyRevokeGroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformRevokeGroupOutput' - summary: 将权限从权限组中移除 - tags: - - cloudpolicy - /cloudpolicies/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudpolicy_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudpolicy - /cloudpolicies/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudpolicy_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudpolicy - /cloudpolicies/{id}/status: - get: - description: 获取指定信息Status - operationId: cloudpolicy_GetDetailsStatus - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicy_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cloudpolicy - post: - description: 执行操作Status - operationId: cloudpolicy_PerformStatus - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cloudpolicy - /cloudpolicies/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: cloudpolicy_PerformSyncstatus - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudgroupSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformSyncstatusOutput' - summary: 恢复权限组状态 - tags: - - cloudpolicy - /cloudpolicies/{id}/unlock: - post: - description: 执行操作Unlock - operationId: cloudpolicy_PerformUnlock - parameters: - - description: The Id or Name of cloudpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyAssignGroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformUnlockOutput' - summary: 解锁权限(允许使用此权限) - tags: - - cloudpolicy - /cloudpolicies/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudpolicy_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudpolicy_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudpolicy - /cloudpolicies/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: cloudpolicy_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/cloudpolicy_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - cloudpolicy - /cloudpolicies/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: cloudpolicy_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/cloudpolicy_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - cloudpolicy - /cloudpolicies/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudpolicy_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudpolicy: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicy_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudpolicy - /cloudpolicies/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudpolicy_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudpolicy_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudpolicy - /cloudpolicies/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudpolicy_GetPropertySplitableExport - parameters: - - in: query - name: table - type: string - x-go-name: Table - - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - responses: - "200": - $ref: '#/responses/cloudpolicy_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudpolicy - /cloudpolicies/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cloudpolicy_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cloudpolicy_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cloudpolicy - /cloudpolicies/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudpolicy_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudpolicy_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudpolicy - /cloudpolicies/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudpolicy_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudpolicy_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudpolicy - /cloudpolicycaches: - get: - description: 列表 - operationId: cloudpolicycache_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudpolicy + /cloudpolicies/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cloudpolicy_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cloudpolicy + /cloudpolicies/{id}/private: + post: + description: 执行操作Private + operationId: cloudpolicy_PerformPrivate + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cloudpolicy + /cloudpolicies/{id}/public: + post: + description: 执行操作Public + operationId: cloudpolicy_PerformPublic + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformPublicOutput' + summary: 执行操作Public + tags: + - cloudpolicy + /cloudpolicies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudpolicy_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudpolicy + /cloudpolicies/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cloudpolicy_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudpolicy + /cloudpolicies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudpolicy_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudpolicy + /cloudpolicies/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudpolicy_GetDetailsStatus + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudpolicy + post: + description: 执行操作Status + operationId: cloudpolicy_PerformStatus + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudpolicy + /cloudpolicies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudpolicy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudpolicy + /cloudpolicies/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: cloudpolicy_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - cloudpolicy + /cloudpolicies/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: cloudpolicy_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - cloudpolicy + /cloudpolicies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudpolicy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudpolicy + /cloudpolicies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudpolicy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudpolicy + /cloudpolicies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudpolicy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudpolicy + /cloudpolicies/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudpolicy_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudpolicy + /cloudpolicies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudpolicy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudpolicy + /cloudpolicies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudpolicy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudpolicy + /cloudroles: + get: + description: 列表 + operationId: cloudrole_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 根据权限过滤 - in: query - name: cloudpolicy_id - type: string - x-go-name: CloudpolicyId - - description: 根据云账号过滤 - in: query - name: cloudaccount_id - type: string - x-go-name: CloudaccountId - responses: - "200": - $ref: '#/responses/cloudpolicycache_ListItemFilterOutput' - summary: 公有云权限缓存列表 - tags: - - cloudpolicycache - post: - description: 新建 - operationId: cloudpolicycache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicycache_ValidateCreateDataOutput' - summary: 新建 - tags: - - cloudpolicycache - /cloudpolicycaches/{id}: - delete: - description: 删除 - operationId: cloudpolicycache_CustomizeDelete - parameters: - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicycache_CustomizeDeleteOutput' - summary: 删除 - tags: - - cloudpolicycache - get: - description: 获取详情 - operationId: cloudpolicycache_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicycache_FetchCustomizeColumnsOutput' - summary: 获取公有云权限缓存详情 - tags: - - cloudpolicycache - put: - description: 更新 - operationId: cloudpolicycache_ValidateUpdateData - parameters: - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicycache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cloudpolicycache - /cloudpolicycaches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudpolicycache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicycache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudpolicycache - post: - description: 执行操作ClassMetadata - operationId: cloudpolicycache_PerformClassMetadata - parameters: - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicycache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicycache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudpolicycache - /cloudpolicycaches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudpolicycache_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 根据云订阅过滤资源 + in: query + name: manager_id + type: string + x-go-name: ManagerId + - description: 根据权限组Id过滤资源 + in: query + name: cloudgroup_id + type: string + x-go-name: CloudgroupId + responses: + "200": + $ref: '#/responses/cloudrole_ListItemFilterOutput' + summary: 公有云角色列表 + tags: + - cloudrole + post: + description: 新建 + operationId: cloudrole_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudrole + /cloudroles/{id}: + delete: + description: 删除 + operationId: cloudrole_CustomizeDelete + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_CustomizeDeleteOutput' + summary: 删除公有云角色 + tags: + - cloudrole + get: + description: 获取详情 + operationId: cloudrole_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_FetchCustomizeColumnsOutput' + summary: 获取公有云角色详情 + tags: + - cloudrole + put: + description: 更新 + operationId: cloudrole_ValidateUpdateData + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudrole + /cloudroles/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cloudrole_PerformChangeOwner + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cloudrole + /cloudroles/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudrole_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudrole + /cloudroles/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudrole_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudrole + post: + description: 执行操作ClassMetadata + operationId: cloudrole_PerformClassMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudrole + /cloudroles/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudrole_PerformDisable + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformDisableOutput' + summary: 禁用资源 + tags: + - cloudrole + /cloudroles/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudrole_PerformEnable + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformEnableOutput' + summary: 启用资源 + tags: + - cloudrole + /cloudroles/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudrole_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | key以user:为前缀，用户自定义标签 | - 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 按标签前缀过滤 - in: query - name: prefix - type: string - x-go-name: Prefix - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicycache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudpolicycache - /cloudpolicycaches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudpolicycache_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicycache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicycache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudpolicycache - /cloudpolicycaches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudpolicycache_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicycache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicycache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudpolicycache - /cloudpolicycaches/{id}/status: - get: - description: 获取指定信息Status - operationId: cloudpolicycache_GetDetailsStatus - parameters: - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudpolicycache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cloudpolicycache - post: - description: 执行操作Status - operationId: cloudpolicycache_PerformStatus - parameters: - - description: The Id or Name of cloudpolicycache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicycache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cloudpolicycache - /cloudpolicycaches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudpolicycache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudpolicycache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudpolicycache - /cloudpolicycaches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudpolicycache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudpolicycache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudpolicycache - /cloudpolicycaches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudpolicycache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudpolicycache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudpolicycache - /cloudpolicycaches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudpolicycache_GetPropertySplitableExport - parameters: - - in: query - name: table - type: string - x-go-name: Table - - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - responses: - "200": - $ref: '#/responses/cloudpolicycache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudpolicycache - /cloudpolicycaches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cloudpolicycache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cloudpolicycache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cloudpolicycache - /cloudpolicycaches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudpolicycache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudpolicycache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudpolicycache - /cloudpolicycaches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudpolicycache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudpolicycache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudpolicycache - /cloudroles: - get: - description: 列表 - operationId: cloudrole_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudrole + /cloudroles/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cloudrole_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cloudrole + /cloudroles/{id}/private: + post: + description: 执行操作Private + operationId: cloudrole_PerformPrivate + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cloudrole + /cloudroles/{id}/public: + post: + description: 执行操作Public + operationId: cloudrole_PerformPublic + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformPublicOutput' + summary: 执行操作Public + tags: + - cloudrole + /cloudroles/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudrole_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudrole + /cloudroles/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cloudrole_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudrole + /cloudroles/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudrole_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudrole + /cloudroles/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudrole_GetDetailsStatus + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudrole + post: + description: 执行操作Status + operationId: cloudrole_PerformStatus + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudrole + /cloudroles/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudrole_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudrole + /cloudroles/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: cloudrole_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - cloudrole + /cloudroles/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: cloudrole_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - cloudrole + /cloudroles/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudrole_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudrole + /cloudroles/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudrole_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudrole + /cloudroles/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudrole_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudrole + /cloudroles/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudrole_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudrole + /cloudroles/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudrole_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudrole + /cloudroles/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudrole_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudrole + /cloudusers: + get: + description: 列表 + operationId: clouduser_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 根据云账号名称过滤资源 - in: query - name: cloudaccount - type: string - x-go-name: Cloudaccount - - description: 根据平台过滤 - in: query - items: - type: string - name: provider - type: array - x-go-name: Provider - - description: 根据权限组Id过滤资源 - in: query - name: cloudgroup_id - type: string - x-go-name: CloudgroupId - responses: - "200": - $ref: '#/responses/cloudrole_ListItemFilterOutput' - summary: 公有云角色列表 - tags: - - cloudrole - post: - description: 新建 - operationId: cloudrole_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_ValidateCreateDataOutput' - summary: 新建 - tags: - - cloudrole - /cloudroles/{id}: - delete: - description: 删除 - operationId: cloudrole_CustomizeDelete - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudrole_CustomizeDeleteOutput' - summary: 删除公有云角色 - tags: - - cloudrole - get: - description: 获取详情 - operationId: cloudrole_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudrole_FetchCustomizeColumnsOutput' - summary: 获取公有云角色详情 - tags: - - cloudrole - put: - description: 更新 - operationId: cloudrole_ValidateUpdateData - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cloudrole - /cloudroles/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: cloudrole_PerformChangeOwner - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - cloudrole - /cloudroles/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: cloudrole_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudrole_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - cloudrole - /cloudroles/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudrole_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudrole_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudrole - post: - description: 执行操作ClassMetadata - operationId: cloudrole_PerformClassMetadata - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudrole - /cloudroles/{id}/disable: - post: - description: 执行操作Disable - operationId: cloudrole_PerformDisable - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformDisableOutput' - summary: 禁用资源 - tags: - - cloudrole - /cloudroles/{id}/enable: - post: - description: 执行操作Enable - operationId: cloudrole_PerformEnable - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformEnableOutput' - summary: 启用资源 - tags: - - cloudrole - /cloudroles/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudrole_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 查询指定的用户（ID或名称）拥有的资源 + in: query + name: user_id + type: string + x-go-name: UserId + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 根据云订阅过滤资源 + in: query + name: manager_id + type: string + x-go-name: ManagerId + - description: 过滤绑定权限的子账号 + in: query + name: cloudpolicy_id + type: string + x-go-name: CloudpolicyId + - description: 过滤属于指定权限组的子账号 + in: query + name: cloudgroup_id + type: string + x-go-name: CloudgroupId + responses: + "200": + $ref: '#/responses/clouduser_ListItemFilterOutput' + summary: 公有云用户列表 + tags: + - clouduser + post: + description: 新建 + operationId: clouduser_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_ValidateCreateDataOutput' + summary: 创建公有云用户 + tags: + - clouduser + /cloudusers/{id}: + delete: + description: 删除 + operationId: clouduser_CustomizeDelete + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_CustomizeDeleteOutput' + summary: 删除公有云用户 + tags: + - clouduser + get: + description: 获取详情 + operationId: clouduser_FetchCustomizeColumns + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_FetchCustomizeColumnsOutput' + summary: 获取公有云用户详情 + tags: + - clouduser + /cloudusers/{id}/access-keys: + get: + description: 获取指定信息AccessKeys + operationId: clouduser_GetDetailsAccessKeys + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsAccessKeysOutput' + summary: 获取指定信息AccessKeys + tags: + - clouduser + /cloudusers/{id}/attach-policy: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformAttachPolicy + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserAttachPolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformAttachPolicyOutput' + summary: 绑定用户权限 + tags: + - clouduser + /cloudusers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: clouduser_PerformChangeOwner + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserChangeOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformChangeOwnerOutput' + summary: 变更子账号所属本地用户 + tags: + - clouduser + /cloudusers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: clouduser_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - clouduser + /cloudusers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: clouduser_GetDetailsClassMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - clouduser + post: + description: 执行操作ClassMetadata + operationId: clouduser_PerformClassMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - clouduser + /cloudusers/{id}/create-access-key: + post: + description: 执行操作CreateAccessKey + operationId: clouduser_PerformCreateAccessKey + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserCreateAccessKeyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformCreateAccessKeyOutput' + summary: 执行操作CreateAccessKey + tags: + - clouduser + /cloudusers/{id}/delete-access-key: + post: + description: 执行操作DeleteAccessKey + operationId: clouduser_PerformDeleteAccessKey + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDeleteAccessKeyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformDeleteAccessKeyOutput' + summary: 执行操作DeleteAccessKey + tags: + - clouduser + /cloudusers/{id}/detach-policy: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformDetachPolicy + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDetachPolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformDetachPolicyOutput' + summary: 解绑用户权限 + tags: + - clouduser + /cloudusers/{id}/join-group: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformJoinGroup + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserJoinGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformJoinGroupOutput' + summary: 将用户加入权限组 + tags: + - clouduser + /cloudusers/{id}/leave-group: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformLeaveGroup + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserLeaveGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformLeaveGroupOutput' + summary: 将用户从权限组中移除 + tags: + - clouduser + /cloudusers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: clouduser_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | key以user:为前缀，用户自定义标签 | - 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 按标签前缀过滤 - in: query - name: prefix - type: string - x-go-name: Prefix - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudrole_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudrole - /cloudroles/{id}/private: - post: - description: 执行操作Private - operationId: cloudrole_PerformPrivate - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformPrivateOutput' - summary: 执行操作Private - tags: - - cloudrole - /cloudroles/{id}/public: - post: - description: 执行操作Public - operationId: cloudrole_PerformPublic - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformPublicOutput' - summary: 执行操作Public - tags: - - cloudrole - /cloudroles/{id}/purge: - post: - description: 执行操作Purge - operationId: cloudrole_PerformPurge - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/CloudrolePurgeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformPurgeOutput' - summary: 清除角色(不删除云上资源) - tags: - - cloudrole - /cloudroles/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudrole_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudrole - /cloudroles/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudrole_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudrole - /cloudroles/{id}/status: - get: - description: 获取指定信息Status - operationId: cloudrole_GetDetailsStatus - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudrole_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cloudrole - post: - description: 执行操作Status - operationId: cloudrole_PerformStatus - parameters: - - description: The Id or Name of cloudrole - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cloudrole - /cloudroles/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudrole_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudrole_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudrole - /cloudroles/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: cloudrole_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/cloudrole_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - cloudrole - /cloudroles/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: cloudrole_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/cloudrole_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - cloudrole - /cloudroles/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudrole_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudrole: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudrole_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudrole - /cloudroles/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudrole_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudrole_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudrole - /cloudroles/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudrole_GetPropertySplitableExport - parameters: - - in: query - name: table - type: string - x-go-name: Table - - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - responses: - "200": - $ref: '#/responses/cloudrole_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudrole - /cloudroles/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cloudrole_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cloudrole_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cloudrole - /cloudroles/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudrole_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudrole_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudrole - /cloudroles/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudrole_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudrole_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudrole - /cloudusers: - get: - description: 列表 - operationId: clouduser_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - clouduser + /cloudusers/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: clouduser_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - clouduser + /cloudusers/{id}/reset-password: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformResetPassword + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserResetPasswordInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformResetPasswordOutput' + summary: 重置用户密码 + tags: + - clouduser + /cloudusers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: clouduser_PerformSetClassMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - clouduser + /cloudusers/{id}/set-groups: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformSetGroups + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserSetGroupsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSetGroupsOutput' + summary: 设置用户权限组列表(全量覆盖) + tags: + - clouduser + /cloudusers/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: clouduser_PerformSetOrgMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - clouduser + /cloudusers/{id}/set-policies: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformSetPolicies + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserSetPoliciesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSetPoliciesOutput' + summary: 设置用户权限列表(全量覆盖) + tags: + - clouduser + /cloudusers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: clouduser_PerformSetUserMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - clouduser + /cloudusers/{id}/status: + get: + description: 获取指定信息Status + operationId: clouduser_GetDetailsStatus + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - clouduser + post: + description: 执行操作Status + operationId: clouduser_PerformStatus + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformStatusOutput' + summary: 更新资源状态 + tags: + - clouduser + /cloudusers/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: clouduser_PerformSyncstatus + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSyncstatusOutput' + summary: 同步用户状态 + tags: + - clouduser + /cloudusers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: clouduser_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - clouduser + /cloudusers/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: clouduser_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - clouduser + /cloudusers/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: clouduser_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - clouduser + /cloudusers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: clouduser_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - clouduser + /cloudusers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: clouduser_GetPropertySplitable + responses: + "200": + $ref: '#/responses/clouduser_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - clouduser + /cloudusers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: clouduser_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/clouduser_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - clouduser + /cloudusers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: clouduser_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - clouduser + /cloudusers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: clouduser_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - clouduser + /saml_providers: + get: + description: 列表 + operationId: saml_provider_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 查询指定的用户（ID或名称）拥有的资源 - in: query - name: user_id - type: string - x-go-name: UserId - - description: 根据云账号名称过滤资源 - in: query - name: cloudaccount - type: string - x-go-name: Cloudaccount - - description: 根据平台过滤 - in: query - items: - type: string - name: provider - type: array - x-go-name: Provider - - description: 过滤绑定权限的子账号 - in: query - name: cloudpolicy_id - type: string - x-go-name: CloudpolicyId - - description: 过滤属于指定权限组的子账号 - in: query - name: cloudgroup_id - type: string - x-go-name: CloudgroupId - responses: - "200": - $ref: '#/responses/clouduser_ListItemFilterOutput' - summary: 公有云用户列表 - tags: - - clouduser - post: - description: 新建 - operationId: clouduser_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_ValidateCreateDataOutput' - summary: 创建公有云用户 - tags: - - clouduser - /cloudusers/{id}: - delete: - description: 删除 - operationId: clouduser_CustomizeDelete - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/clouduser_CustomizeDeleteOutput' - summary: 删除公有云用户 - tags: - - clouduser - get: - description: 获取详情 - operationId: clouduser_FetchCustomizeColumns - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/clouduser_FetchCustomizeColumnsOutput' - summary: 获取公有云用户详情 - tags: - - clouduser - /cloudusers/{id}/access-keys: - get: - description: 获取指定信息AccessKeys - operationId: clouduser_GetDetailsAccessKeys - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/clouduser_GetDetailsAccessKeysOutput' - summary: 获取指定信息AccessKeys - tags: - - clouduser - /cloudusers/{id}/attach-policy: - post: - description: '用户状态必须为: available' - operationId: clouduser_PerformAttachPolicy - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserAttachPolicyInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformAttachPolicyOutput' - summary: 绑定用户权限 - tags: - - clouduser - /cloudusers/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: clouduser_PerformChangeOwner - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserChangeOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformChangeOwnerOutput' - summary: 变更子账号所属本地用户 - tags: - - clouduser - /cloudusers/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: clouduser_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/clouduser_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - clouduser - /cloudusers/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: clouduser_GetDetailsClassMetadata - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/clouduser_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - clouduser - post: - description: 执行操作ClassMetadata - operationId: clouduser_PerformClassMetadata - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - clouduser - /cloudusers/{id}/create-access-key: - post: - description: 执行操作CreateAccessKey - operationId: clouduser_PerformCreateAccessKey - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserCreateAccessKeyInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformCreateAccessKeyOutput' - summary: 执行操作CreateAccessKey - tags: - - clouduser - /cloudusers/{id}/delete-access-key: - post: - description: 执行操作DeleteAccessKey - operationId: clouduser_PerformDeleteAccessKey - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserDeleteAccessKeyInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformDeleteAccessKeyOutput' - summary: 执行操作DeleteAccessKey - tags: - - clouduser - /cloudusers/{id}/detach-policy: - post: - description: '用户状态必须为: available' - operationId: clouduser_PerformDetachPolicy - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserDetachPolicyInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformDetachPolicyOutput' - summary: 解绑用户权限 - tags: - - clouduser - /cloudusers/{id}/join-group: - post: - description: '用户状态必须为: available' - operationId: clouduser_PerformJoinGroup - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserJoinGroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformJoinGroupOutput' - summary: 将用户加入权限组 - tags: - - clouduser - /cloudusers/{id}/leave-group: - post: - description: '用户状态必须为: available' - operationId: clouduser_PerformLeaveGroup - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserLeaveGroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformLeaveGroupOutput' - summary: 将用户从权限组中移除 - tags: - - clouduser - /cloudusers/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: clouduser_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 根据云订阅过滤资源 + in: query + name: manager_id + type: string + x-go-name: ManagerId + responses: + "200": + $ref: '#/responses/saml_provider_ListItemFilterOutput' + summary: 公有云身份提供商列表 + tags: + - saml_provider + post: + description: 新建 + operationId: saml_provider_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + saml_provider: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_ValidateCreateDataOutput' + summary: 新建 + tags: + - saml_provider + /saml_providers/{id}: + delete: + description: 删除 + operationId: saml_provider_CustomizeDelete + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_CustomizeDeleteOutput' + summary: 删除 + tags: + - saml_provider + get: + description: 获取详情 + operationId: saml_provider_FetchCustomizeColumns + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - saml_provider + put: + description: 更新 + operationId: saml_provider_ValidateUpdateData + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_ValidateUpdateDataOutput' + summary: 更新 + tags: + - saml_provider + /saml_providers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: saml_provider_PerformChangeOwner + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - saml_provider + /saml_providers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: saml_provider_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - saml_provider + /saml_providers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: saml_provider_GetDetailsClassMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - saml_provider + post: + description: 执行操作ClassMetadata + operationId: saml_provider_PerformClassMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - saml_provider + /saml_providers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: saml_provider_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | key以user:为前缀，用户自定义标签 | - 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 按标签前缀过滤 - in: query - name: prefix - type: string - x-go-name: Prefix - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/clouduser_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - clouduser - /cloudusers/{id}/reset-password: - post: - description: '用户状态必须为: available' - operationId: clouduser_PerformResetPassword - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserResetPasswordInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformResetPasswordOutput' - summary: 重置用户密码 - tags: - - clouduser - /cloudusers/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: clouduser_PerformSetClassMetadata - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - clouduser - /cloudusers/{id}/set-groups: - post: - description: '用户状态必须为: available' - operationId: clouduser_PerformSetGroups - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserSetGroupsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformSetGroupsOutput' - summary: 设置用户权限组列表(全量覆盖) - tags: - - clouduser - /cloudusers/{id}/set-policies: - post: - description: '用户状态必须为: available' - operationId: clouduser_PerformSetPolicies - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserSetPoliciesInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformSetPoliciesOutput' - summary: 设置用户权限列表(全量覆盖) - tags: - - clouduser - /cloudusers/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: clouduser_PerformSetUserMetadata - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - clouduser - /cloudusers/{id}/status: - get: - description: 获取指定信息Status - operationId: clouduser_GetDetailsStatus - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/clouduser_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - clouduser - post: - description: 执行操作Status - operationId: clouduser_PerformStatus - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformStatusOutput' - summary: 更新资源状态 - tags: - - clouduser - /cloudusers/{id}/sync: - post: - description: '用户状态必须为: available' - operationId: clouduser_PerformSync - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserSyncInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformSyncOutput' - summary: 同步用户权限和权限组到云上 - tags: - - clouduser - /cloudusers/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: clouduser_PerformSyncstatus - parameters: - - description: The Id or Name of clouduser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformSyncstatusOutput' - summary: 同步用户状态 - tags: - - clouduser - /cloudusers/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: clouduser_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/clouduser_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - clouduser - /cloudusers/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: clouduser_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/clouduser_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - clouduser - /cloudusers/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: clouduser_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/clouduser_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - clouduser - /cloudusers/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: clouduser_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - clouduser: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/clouduser_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - clouduser - /cloudusers/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: clouduser_GetPropertySplitable - responses: - "200": - $ref: '#/responses/clouduser_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - clouduser - /cloudusers/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: clouduser_GetPropertySplitableExport - parameters: - - in: query - name: table - type: string - x-go-name: Table - - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - responses: - "200": - $ref: '#/responses/clouduser_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - clouduser - /cloudusers/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: clouduser_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/clouduser_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - clouduser - /cloudusers/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: clouduser_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/clouduser_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - clouduser - /saml_providers: - get: - description: 列表 - operationId: saml_provider_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - saml_provider + /saml_providers/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: saml_provider_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - saml_provider + /saml_providers/{id}/private: + post: + description: 执行操作Private + operationId: saml_provider_PerformPrivate + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformPrivateOutput' + summary: 执行操作Private + tags: + - saml_provider + /saml_providers/{id}/public: + post: + description: 执行操作Public + operationId: saml_provider_PerformPublic + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformPublicOutput' + summary: 执行操作Public + tags: + - saml_provider + /saml_providers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: saml_provider_PerformSetClassMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - saml_provider + /saml_providers/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: saml_provider_PerformSetOrgMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - saml_provider + /saml_providers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: saml_provider_PerformSetUserMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - saml_provider + /saml_providers/{id}/status: + get: + description: 获取指定信息Status + operationId: saml_provider_GetDetailsStatus + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - saml_provider + post: + description: 执行操作Status + operationId: saml_provider_PerformStatus + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformStatusOutput' + summary: 更新资源状态 + tags: + - saml_provider + /saml_providers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: saml_provider_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - saml_provider + /saml_providers/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: saml_provider_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - saml_provider + /saml_providers/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: saml_provider_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - saml_provider + /saml_providers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: saml_provider_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - saml_provider + /saml_providers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: saml_provider_GetPropertySplitable + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - saml_provider + /saml_providers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: saml_provider_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - saml_provider + /saml_providers/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: saml_provider_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - saml_provider + /saml_providers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: saml_provider_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - saml_provider + /saml_providers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: saml_provider_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - saml_provider + /samlusers: + get: + description: 列表 + operationId: samluser_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 根据云账号名称过滤资源 - in: query - name: cloudaccount - type: string - x-go-name: Cloudaccount - - description: 根据平台过滤 - in: query - items: - type: string - name: provider - type: array - x-go-name: Provider - responses: - "200": - $ref: '#/responses/saml_provider_ListItemFilterOutput' - summary: 公有云身份提供商列表 - tags: - - saml_provider - post: - description: 新建 - operationId: saml_provider_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - saml_provider: - $ref: '#/definitions/SAMLProviderCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_ValidateCreateDataOutput' - summary: 创建云账号的身份提供商 - tags: - - saml_provider - /saml_providers/{id}: - delete: - description: 删除 - operationId: saml_provider_CustomizeDelete - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/saml_provider_CustomizeDeleteOutput' - summary: 删除 - tags: - - saml_provider - get: - description: 获取详情 - operationId: saml_provider_FetchCustomizeColumns - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/saml_provider_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - saml_provider - put: - description: 更新 - operationId: saml_provider_ValidateUpdateData - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - saml_provider: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_ValidateUpdateDataOutput' - summary: 更新 - tags: - - saml_provider - /saml_providers/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: saml_provider_PerformChangeOwner - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - saml_provider: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - saml_provider - /saml_providers/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: saml_provider_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/saml_provider_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - saml_provider - /saml_providers/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: saml_provider_GetDetailsClassMetadata - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/saml_provider_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - saml_provider - post: - description: 执行操作ClassMetadata - operationId: saml_provider_PerformClassMetadata - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - saml_provider: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - saml_provider - /saml_providers/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: saml_provider_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 查询指定的用户（ID或名称）拥有的资源 + in: query + name: user_id + type: string + x-go-name: UserId + - description: 根据权限组Id过滤资源 + in: query + name: cloudgroup_id + type: string + x-go-name: CloudgroupId + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + responses: + "200": + $ref: '#/responses/samluser_ListItemFilterOutput' + summary: SAML认证用户列表 + tags: + - samluser + post: + description: 新建 + operationId: samluser_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + samluser: + $ref: '#/definitions/SamluserCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_ValidateCreateDataOutput' + summary: 创建SAML认证用户 + tags: + - samluser + /samlusers/{id}: + delete: + description: 删除 + operationId: samluser_CustomizeDelete + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_CustomizeDeleteOutput' + summary: 删除 + tags: + - samluser + get: + description: 获取详情 + operationId: samluser_FetchCustomizeColumns + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - samluser + put: + description: 更新 + operationId: samluser_ValidateUpdateData + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + $ref: '#/definitions/StatusDomainLevelResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_ValidateUpdateDataOutput' + summary: 更新 + tags: + - samluser + /samlusers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: samluser_PerformChangeOwner + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - samluser + /samlusers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: samluser_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - samluser + /samlusers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: samluser_GetDetailsClassMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - samluser + post: + description: 执行操作ClassMetadata + operationId: samluser_PerformClassMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - samluser + /samlusers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: samluser_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | key以user:为前缀，用户自定义标签 | - 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 按标签前缀过滤 - in: query - name: prefix - type: string - x-go-name: Prefix - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/saml_provider_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - saml_provider - /saml_providers/{id}/private: - post: - description: 执行操作Private - operationId: saml_provider_PerformPrivate - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - saml_provider: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_PerformPrivateOutput' - summary: 执行操作Private - tags: - - saml_provider - /saml_providers/{id}/public: - post: - description: 执行操作Public - operationId: saml_provider_PerformPublic - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - saml_provider: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_PerformPublicOutput' - summary: 执行操作Public - tags: - - saml_provider - /saml_providers/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: saml_provider_PerformSetClassMetadata - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - saml_provider: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - saml_provider - /saml_providers/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: saml_provider_PerformSetUserMetadata - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - saml_provider: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - saml_provider - /saml_providers/{id}/status: - get: - description: 获取指定信息Status - operationId: saml_provider_GetDetailsStatus - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/saml_provider_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - saml_provider - post: - description: 执行操作Status - operationId: saml_provider_PerformStatus - parameters: - - description: The Id or Name of saml_provider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - saml_provider: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_PerformStatusOutput' - summary: 更新资源状态 - tags: - - saml_provider - /saml_providers/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: saml_provider_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/saml_provider_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - saml_provider - /saml_providers/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: saml_provider_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/saml_provider_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - saml_provider - /saml_providers/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: saml_provider_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/saml_provider_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - saml_provider - /saml_providers/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: saml_provider_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - saml_provider: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/saml_provider_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - saml_provider - /saml_providers/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: saml_provider_GetPropertySplitable - responses: - "200": - $ref: '#/responses/saml_provider_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - saml_provider - /saml_providers/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: saml_provider_GetPropertySplitableExport - parameters: - - in: query - name: table - type: string - x-go-name: Table - - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - responses: - "200": - $ref: '#/responses/saml_provider_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - saml_provider - /saml_providers/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: saml_provider_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/saml_provider_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - saml_provider - /saml_providers/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: saml_provider_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/saml_provider_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - saml_provider - /saml_providers/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: saml_provider_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/saml_provider_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - saml_provider - /samlusers: - get: - description: 列表 - operationId: samluser_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 查询指定的用户（ID或名称）拥有的资源 - in: query - name: user_id - type: string - x-go-name: UserId - - description: 根据权限组Id过滤资源 - in: query - name: cloudgroup_id - type: string - x-go-name: CloudgroupId - - description: 根据云账号名称过滤资源 - in: query - name: cloudaccount - type: string - x-go-name: Cloudaccount - - description: 根据平台过滤 - in: query - items: - type: string - name: provider - type: array - x-go-name: Provider - responses: - "200": - $ref: '#/responses/samluser_ListItemFilterOutput' - summary: SAML认证用户列表 - tags: - - samluser - post: - description: 新建 - operationId: samluser_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - samluser: - $ref: '#/definitions/SamluserCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/samluser_ValidateCreateDataOutput' - summary: 创建SAML认证用户 - tags: - - samluser - /samlusers/{id}: - delete: - description: 删除 - operationId: samluser_CustomizeDelete - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/samluser_CustomizeDeleteOutput' - summary: 删除 - tags: - - samluser - get: - description: 获取详情 - operationId: samluser_FetchCustomizeColumns - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/samluser_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - samluser - put: - description: 更新 - operationId: samluser_ValidateUpdateData - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - samluser: - $ref: '#/definitions/StatusDomainLevelResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/samluser_ValidateUpdateDataOutput' - summary: 更新 - tags: - - samluser - /samlusers/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: samluser_PerformChangeOwner - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - samluser: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/samluser_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - samluser - /samlusers/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: samluser_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/samluser_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - samluser - /samlusers/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: samluser_GetDetailsClassMetadata - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/samluser_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - samluser - post: - description: 执行操作ClassMetadata - operationId: samluser_PerformClassMetadata - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - samluser: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/samluser_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - samluser - /samlusers/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: samluser_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 - - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | key以user:为前缀，用户自定义标签 | - 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 按标签前缀过滤 - in: query - name: prefix - type: string - x-go-name: Prefix - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/samluser_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - samluser - /samlusers/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: samluser_PerformSetClassMetadata - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - samluser: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/samluser_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - samluser - /samlusers/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: samluser_PerformSetUserMetadata - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - samluser: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/samluser_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - samluser - /samlusers/{id}/status: - get: - description: 获取指定信息Status - operationId: samluser_GetDetailsStatus - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/samluser_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - samluser - post: - description: 执行操作Status - operationId: samluser_PerformStatus - parameters: - - description: The Id or Name of samluser - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - samluser: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/samluser_PerformStatusOutput' - summary: 更新资源状态 - tags: - - samluser - /samlusers/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: samluser_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/samluser_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - samluser - /samlusers/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: samluser_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/samluser_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - samluser - /samlusers/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: samluser_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/samluser_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - samluser - /samlusers/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: samluser_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - samluser: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/samluser_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - samluser - /samlusers/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: samluser_GetPropertySplitable - responses: - "200": - $ref: '#/responses/samluser_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - samluser - /samlusers/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: samluser_GetPropertySplitableExport - parameters: - - in: query - name: table - type: string - x-go-name: Table - - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - responses: - "200": - $ref: '#/responses/samluser_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - samluser - /samlusers/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: samluser_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/samluser_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - samluser - /samlusers/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: samluser_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/samluser_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - samluser + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - samluser + /samlusers/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: samluser_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - samluser + /samlusers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: samluser_PerformSetClassMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - samluser + /samlusers/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: samluser_PerformSetOrgMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - samluser + /samlusers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: samluser_PerformSetUserMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - samluser + /samlusers/{id}/status: + get: + description: 获取指定信息Status + operationId: samluser_GetDetailsStatus + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - samluser + post: + description: 执行操作Status + operationId: samluser_PerformStatus + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformStatusOutput' + summary: 更新资源状态 + tags: + - samluser + /samlusers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: samluser_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/samluser_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - samluser + /samlusers/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: samluser_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/samluser_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - samluser + /samlusers/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: samluser_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/samluser_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - samluser + /samlusers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: samluser_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + samluser: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - samluser + /samlusers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: samluser_GetPropertySplitable + responses: + "200": + $ref: '#/responses/samluser_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - samluser + /samlusers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: samluser_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/samluser_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - samluser + /samlusers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: samluser_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/samluser_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - samluser + /samlusers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: samluser_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/samluser_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - samluser produces: -- application/json + - application/json responses: - cloudgroup_CustomizeDeleteOutput: - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupDetails' - type: object - cloudgroup_FetchCustomizeColumnsOutput: - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupDetails' - type: object - cloudgroup_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - cloudgroup: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - cloudgroup_GetDetailsClassMetadataOutput: - schema: - properties: - cloudgroup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudgroup_GetDetailsMetadataOutput: - schema: - properties: - cloudgroup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudgroup_GetDetailsStatusOutput: - schema: - properties: - cloudgroup: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cloudgroup_GetPropertyDistinctFieldOutput: {} - cloudgroup_GetPropertyDomainTagValuePairsOutput: {} - cloudgroup_GetPropertyDomainTagValueTreeOutput: {} - cloudgroup_GetPropertySplitableExportOutput: {} - cloudgroup_GetPropertySplitableOutput: {} - cloudgroup_GetPropertyStatisticsOutput: - schema: - properties: - cloudgroup: - $ref: '#/definitions/StatusStatistic' - type: object - cloudgroup_GetPropertyTagValuePairsOutput: {} - cloudgroup_GetPropertyTagValueTreeOutput: {} - cloudgroup_ListItemFilterOutput: - schema: - properties: - cloudgroups: - items: - $ref: '#/definitions/CloudgroupDetails' - type: array - x-go-name: Output - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - cloudgroup_PerformAddUserOutput: {} - cloudgroup_PerformAttachPolicyOutput: {} - cloudgroup_PerformChangeOwnerOutput: {} - cloudgroup_PerformClassMetadataOutput: {} - cloudgroup_PerformDetachPolicyOutput: {} - cloudgroup_PerformPrivateOutput: {} - cloudgroup_PerformPublicOutput: {} - cloudgroup_PerformPurgeSplitableOutput: {} - cloudgroup_PerformRemoveUserOutput: {} - cloudgroup_PerformSetClassMetadataOutput: {} - cloudgroup_PerformSetPoliciesOutput: {} - cloudgroup_PerformSetUserMetadataOutput: {} - cloudgroup_PerformSetUsersOutput: {} - cloudgroup_PerformStatusOutput: {} - cloudgroup_PerformSyncstatusOutput: {} - cloudgroup_ValidateCreateDataOutput: - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupDetails' - type: object - cloudgroup_ValidateUpdateDataOutput: - schema: - properties: - cloudgroup: - $ref: '#/definitions/CloudgroupDetails' - type: object - cloudgroupcache_CustomizeDeleteOutput: - schema: - properties: - cloudgroupcache: - $ref: '#/definitions/CloudgroupcacheDetails' - type: object - cloudgroupcache_FetchCustomizeColumnsOutput: - schema: - properties: - cloudgroupcache: - $ref: '#/definitions/CloudgroupcacheDetails' - type: object - cloudgroupcache_GetDetailsClassMetadataOutput: - schema: - properties: - cloudgroupcache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudgroupcache_GetDetailsMetadataOutput: - schema: - properties: - cloudgroupcache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudgroupcache_GetDetailsStatusOutput: - schema: - properties: - cloudgroupcache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cloudgroupcache_GetPropertyDistinctFieldOutput: {} - cloudgroupcache_GetPropertySplitableExportOutput: {} - cloudgroupcache_GetPropertySplitableOutput: {} - cloudgroupcache_GetPropertyStatisticsOutput: - schema: - properties: - cloudgroupcache: - $ref: '#/definitions/StatusStatistic' - type: object - cloudgroupcache_GetPropertyTagValuePairsOutput: {} - cloudgroupcache_GetPropertyTagValueTreeOutput: {} - cloudgroupcache_ListItemFilterOutput: - schema: - properties: - cloudgroupcaches: - items: - $ref: '#/definitions/CloudgroupcacheDetails' - type: array - x-go-name: Output - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - cloudgroupcache_PerformClassMetadataOutput: {} - cloudgroupcache_PerformPurgeSplitableOutput: {} - cloudgroupcache_PerformSetClassMetadataOutput: {} - cloudgroupcache_PerformSetUserMetadataOutput: {} - cloudgroupcache_PerformStatusOutput: {} - cloudgroupcache_PerformSyncstatusOutput: {} - cloudpolicy_CustomizeDeleteOutput: - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyDetails' - type: object - cloudpolicy_FetchCustomizeColumnsOutput: - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyDetails' - type: object - cloudpolicy_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - cloudpolicy: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - cloudpolicy_GetDetailsClassMetadataOutput: - schema: - properties: - cloudpolicy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudpolicy_GetDetailsMetadataOutput: - schema: - properties: - cloudpolicy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudpolicy_GetDetailsStatusOutput: - schema: - properties: - cloudpolicy: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cloudpolicy_GetPropertyDistinctFieldOutput: {} - cloudpolicy_GetPropertyDomainTagValuePairsOutput: {} - cloudpolicy_GetPropertyDomainTagValueTreeOutput: {} - cloudpolicy_GetPropertySplitableExportOutput: {} - cloudpolicy_GetPropertySplitableOutput: {} - cloudpolicy_GetPropertyStatisticsOutput: - schema: - properties: - cloudpolicy: - $ref: '#/definitions/StatusStatistic' - type: object - cloudpolicy_GetPropertyTagValuePairsOutput: {} - cloudpolicy_GetPropertyTagValueTreeOutput: {} - cloudpolicy_ListItemFilterOutput: - schema: - properties: - cloudpolicies: - items: - $ref: '#/definitions/CloudpolicyDetails' - type: array - x-go-name: Output - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - cloudpolicy_PerformAssignGroupOutput: {} - cloudpolicy_PerformCacheOutput: {} - cloudpolicy_PerformChangeOwnerOutput: {} - cloudpolicy_PerformClassMetadataOutput: {} - cloudpolicy_PerformLockOutput: {} - cloudpolicy_PerformPrivateOutput: {} - cloudpolicy_PerformPublicOutput: {} - cloudpolicy_PerformPurgeSplitableOutput: {} - cloudpolicy_PerformRevokeGroupOutput: {} - cloudpolicy_PerformSetClassMetadataOutput: {} - cloudpolicy_PerformSetUserMetadataOutput: {} - cloudpolicy_PerformStatusOutput: {} - cloudpolicy_PerformSyncstatusOutput: {} - cloudpolicy_PerformUnlockOutput: {} - cloudpolicy_ValidateCreateDataOutput: - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyDetails' - type: object - cloudpolicy_ValidateUpdateDataOutput: - schema: - properties: - cloudpolicy: - $ref: '#/definitions/CloudpolicyDetails' - type: object - cloudpolicycache_CustomizeDeleteOutput: - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/CloudpolicycacheDetails' - type: object - cloudpolicycache_FetchCustomizeColumnsOutput: - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/CloudpolicycacheDetails' - type: object - cloudpolicycache_GetDetailsClassMetadataOutput: - schema: - properties: - cloudpolicycache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudpolicycache_GetDetailsMetadataOutput: - schema: - properties: - cloudpolicycache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudpolicycache_GetDetailsStatusOutput: - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cloudpolicycache_GetPropertyDistinctFieldOutput: {} - cloudpolicycache_GetPropertySplitableExportOutput: {} - cloudpolicycache_GetPropertySplitableOutput: {} - cloudpolicycache_GetPropertyStatisticsOutput: - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/StatusStatistic' - type: object - cloudpolicycache_GetPropertyTagValuePairsOutput: {} - cloudpolicycache_GetPropertyTagValueTreeOutput: {} - cloudpolicycache_ListItemFilterOutput: - schema: - properties: - cloudpolicycaches: - items: - $ref: '#/definitions/CloudpolicycacheDetails' - type: array - x-go-name: Output - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - cloudpolicycache_PerformClassMetadataOutput: {} - cloudpolicycache_PerformPurgeSplitableOutput: {} - cloudpolicycache_PerformSetClassMetadataOutput: {} - cloudpolicycache_PerformSetUserMetadataOutput: {} - cloudpolicycache_PerformStatusOutput: {} - cloudpolicycache_ValidateCreateDataOutput: - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/CloudpolicycacheDetails' - type: object - cloudpolicycache_ValidateUpdateDataOutput: - schema: - properties: - cloudpolicycache: - $ref: '#/definitions/CloudpolicycacheDetails' - type: object - cloudrole_CustomizeDeleteOutput: - schema: - properties: - cloudrole: - $ref: '#/definitions/CloudroleDetails' - type: object - cloudrole_FetchCustomizeColumnsOutput: - schema: - properties: - cloudrole: - $ref: '#/definitions/CloudroleDetails' - type: object - cloudrole_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - cloudrole: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - cloudrole_GetDetailsClassMetadataOutput: - schema: - properties: - cloudrole: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudrole_GetDetailsMetadataOutput: - schema: - properties: - cloudrole: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudrole_GetDetailsStatusOutput: - schema: - properties: - cloudrole: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cloudrole_GetPropertyDistinctFieldOutput: {} - cloudrole_GetPropertyDomainTagValuePairsOutput: {} - cloudrole_GetPropertyDomainTagValueTreeOutput: {} - cloudrole_GetPropertySplitableExportOutput: {} - cloudrole_GetPropertySplitableOutput: {} - cloudrole_GetPropertyStatisticsOutput: - schema: - properties: - cloudrole: - $ref: '#/definitions/StatusStatistic' - type: object - cloudrole_GetPropertyTagValuePairsOutput: {} - cloudrole_GetPropertyTagValueTreeOutput: {} - cloudrole_ListItemFilterOutput: - schema: - properties: - cloudroles: - items: - $ref: '#/definitions/CloudroleDetails' - type: array - x-go-name: Output - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - cloudrole_PerformChangeOwnerOutput: {} - cloudrole_PerformClassMetadataOutput: {} - cloudrole_PerformDisableOutput: {} - cloudrole_PerformEnableOutput: {} - cloudrole_PerformPrivateOutput: {} - cloudrole_PerformPublicOutput: {} - cloudrole_PerformPurgeOutput: {} - cloudrole_PerformPurgeSplitableOutput: {} - cloudrole_PerformSetClassMetadataOutput: {} - cloudrole_PerformSetUserMetadataOutput: {} - cloudrole_PerformStatusOutput: {} - cloudrole_ValidateCreateDataOutput: - schema: - properties: - cloudrole: - $ref: '#/definitions/CloudroleDetails' - type: object - cloudrole_ValidateUpdateDataOutput: - schema: - properties: - cloudrole: - $ref: '#/definitions/CloudroleDetails' - type: object - clouduser_CustomizeDeleteOutput: - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserDetails' - type: object - clouduser_FetchCustomizeColumnsOutput: - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserDetails' - type: object - clouduser_GetDetailsAccessKeysOutput: {} - clouduser_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - clouduser: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - clouduser_GetDetailsClassMetadataOutput: - schema: - properties: - clouduser: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - clouduser_GetDetailsMetadataOutput: - schema: - properties: - clouduser: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - clouduser_GetDetailsStatusOutput: - schema: - properties: - clouduser: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - clouduser_GetPropertyDistinctFieldOutput: {} - clouduser_GetPropertyDomainTagValuePairsOutput: {} - clouduser_GetPropertyDomainTagValueTreeOutput: {} - clouduser_GetPropertySplitableExportOutput: {} - clouduser_GetPropertySplitableOutput: {} - clouduser_GetPropertyTagValuePairsOutput: {} - clouduser_GetPropertyTagValueTreeOutput: {} - clouduser_ListItemFilterOutput: - schema: - properties: - cloudusers: - items: - $ref: '#/definitions/ClouduserDetails' - type: array - x-go-name: Output - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - clouduser_PerformAttachPolicyOutput: {} - clouduser_PerformChangeOwnerOutput: {} - clouduser_PerformClassMetadataOutput: {} - clouduser_PerformCreateAccessKeyOutput: {} - clouduser_PerformDeleteAccessKeyOutput: {} - clouduser_PerformDetachPolicyOutput: {} - clouduser_PerformJoinGroupOutput: {} - clouduser_PerformLeaveGroupOutput: {} - clouduser_PerformPurgeSplitableOutput: {} - clouduser_PerformResetPasswordOutput: {} - clouduser_PerformSetClassMetadataOutput: {} - clouduser_PerformSetGroupsOutput: {} - clouduser_PerformSetPoliciesOutput: {} - clouduser_PerformSetUserMetadataOutput: {} - clouduser_PerformStatusOutput: {} - clouduser_PerformSyncOutput: {} - clouduser_PerformSyncstatusOutput: {} - clouduser_ValidateCreateDataOutput: - schema: - properties: - clouduser: - $ref: '#/definitions/ClouduserDetails' - type: object - saml_provider_CustomizeDeleteOutput: - schema: - properties: - saml_provider: - $ref: '#/definitions/SAMLProviderDetails' - type: object - saml_provider_FetchCustomizeColumnsOutput: - schema: - properties: - saml_provider: - $ref: '#/definitions/SAMLProviderDetails' - type: object - saml_provider_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - saml_provider: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - saml_provider_GetDetailsClassMetadataOutput: - schema: - properties: - saml_provider: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - saml_provider_GetDetailsMetadataOutput: - schema: - properties: - saml_provider: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - saml_provider_GetDetailsStatusOutput: - schema: - properties: - saml_provider: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - saml_provider_GetPropertyDistinctFieldOutput: {} - saml_provider_GetPropertyDomainTagValuePairsOutput: {} - saml_provider_GetPropertyDomainTagValueTreeOutput: {} - saml_provider_GetPropertySplitableExportOutput: {} - saml_provider_GetPropertySplitableOutput: {} - saml_provider_GetPropertyStatisticsOutput: - schema: - properties: - saml_provider: - $ref: '#/definitions/StatusStatistic' - type: object - saml_provider_GetPropertyTagValuePairsOutput: {} - saml_provider_GetPropertyTagValueTreeOutput: {} - saml_provider_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - saml_providers: - items: - $ref: '#/definitions/SAMLProviderDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - saml_provider_PerformChangeOwnerOutput: {} - saml_provider_PerformClassMetadataOutput: {} - saml_provider_PerformPrivateOutput: {} - saml_provider_PerformPublicOutput: {} - saml_provider_PerformPurgeSplitableOutput: {} - saml_provider_PerformSetClassMetadataOutput: {} - saml_provider_PerformSetUserMetadataOutput: {} - saml_provider_PerformStatusOutput: {} - saml_provider_ValidateCreateDataOutput: - schema: - properties: - saml_provider: - $ref: '#/definitions/SAMLProviderDetails' - type: object - saml_provider_ValidateUpdateDataOutput: - schema: - properties: - saml_provider: - $ref: '#/definitions/SAMLProviderDetails' - type: object - samluser_CustomizeDeleteOutput: - schema: - properties: - samluser: - $ref: '#/definitions/SamluserDetails' - type: object - samluser_FetchCustomizeColumnsOutput: - schema: - properties: - samluser: - $ref: '#/definitions/SamluserDetails' - type: object - samluser_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - samluser: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - samluser_GetDetailsClassMetadataOutput: - schema: - properties: - samluser: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - samluser_GetDetailsMetadataOutput: - schema: - properties: - samluser: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - samluser_GetDetailsStatusOutput: - schema: - properties: - samluser: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - samluser_GetPropertyDistinctFieldOutput: {} - samluser_GetPropertyDomainTagValuePairsOutput: {} - samluser_GetPropertyDomainTagValueTreeOutput: {} - samluser_GetPropertySplitableExportOutput: {} - samluser_GetPropertySplitableOutput: {} - samluser_GetPropertyTagValuePairsOutput: {} - samluser_GetPropertyTagValueTreeOutput: {} - samluser_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - samlusers: - items: - $ref: '#/definitions/SamluserDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - samluser_PerformChangeOwnerOutput: {} - samluser_PerformClassMetadataOutput: {} - samluser_PerformPurgeSplitableOutput: {} - samluser_PerformSetClassMetadataOutput: {} - samluser_PerformSetUserMetadataOutput: {} - samluser_PerformStatusOutput: {} - samluser_ValidateCreateDataOutput: - schema: - properties: - samluser: - $ref: '#/definitions/SamluserDetails' - type: object - samluser_ValidateUpdateDataOutput: - schema: - properties: - samluser: - $ref: '#/definitions/SamluserDetails' - type: object + cloudgroup_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetails' + type: object + cloudgroup_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetails' + type: object + cloudgroup_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + cloudgroup: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudgroup_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudgroup_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudgroup_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudgroup_GetDetailsSamlOutput: + description: "" + schema: + properties: + cloudgroup: + $ref: '#/definitions/GetCloudaccountSamlOutput' + type: object + cloudgroup_GetDetailsStatusOutput: + description: "" + schema: + properties: + cloudgroup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudgroup_GetPropertyDistinctFieldOutput: + description: "" + cloudgroup_GetPropertyDomainTagValuePairsOutput: + description: "" + cloudgroup_GetPropertyDomainTagValueTreeOutput: + description: "" + cloudgroup_GetPropertySplitableExportOutput: + description: "" + cloudgroup_GetPropertySplitableOutput: + description: "" + cloudgroup_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + cloudgroup: + $ref: '#/definitions/StatusStatistic' + type: object + cloudgroup_GetPropertyTagValuePairsOutput: + description: "" + cloudgroup_GetPropertyTagValueTreeOutput: + description: "" + cloudgroup_ListItemFilterOutput: + description: "" + schema: + properties: + cloudgroups: + items: + $ref: '#/definitions/CloudgroupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudgroup_PerformAddUserOutput: + description: "" + cloudgroup_PerformAttachPolicyOutput: + description: "" + cloudgroup_PerformChangeOwnerOutput: + description: "" + cloudgroup_PerformClassMetadataOutput: + description: "" + cloudgroup_PerformDetachPolicyOutput: + description: "" + cloudgroup_PerformPrivateOutput: + description: "" + cloudgroup_PerformPublicOutput: + description: "" + cloudgroup_PerformPurgeSplitableOutput: + description: "" + cloudgroup_PerformRemoveUserOutput: + description: "" + cloudgroup_PerformSetClassMetadataOutput: + description: "" + cloudgroup_PerformSetOrgMetadataOutput: + description: "" + cloudgroup_PerformSetPoliciesOutput: + description: "" + cloudgroup_PerformSetUserMetadataOutput: + description: "" + cloudgroup_PerformSetUsersOutput: + description: "" + cloudgroup_PerformStatusOutput: + description: "" + cloudgroup_PerformSyncstatusOutput: + description: "" + cloudgroup_ValidateCreateDataOutput: + description: "" + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetails' + type: object + cloudgroup_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetails' + type: object + cloudpolicy_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyDetails' + type: object + cloudpolicy_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyDetails' + type: object + cloudpolicy_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + cloudpolicy: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudpolicy_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudpolicy_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudpolicy_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudpolicy_GetDetailsStatusOutput: + description: "" + schema: + properties: + cloudpolicy: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudpolicy_GetPropertyDistinctFieldOutput: + description: "" + cloudpolicy_GetPropertyDomainTagValuePairsOutput: + description: "" + cloudpolicy_GetPropertyDomainTagValueTreeOutput: + description: "" + cloudpolicy_GetPropertySplitableExportOutput: + description: "" + cloudpolicy_GetPropertySplitableOutput: + description: "" + cloudpolicy_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + cloudpolicy: + $ref: '#/definitions/StatusStatistic' + type: object + cloudpolicy_GetPropertyTagValuePairsOutput: + description: "" + cloudpolicy_GetPropertyTagValueTreeOutput: + description: "" + cloudpolicy_ListItemFilterOutput: + description: "" + schema: + properties: + cloudpolicies: + items: + $ref: '#/definitions/CloudpolicyDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudpolicy_PerformChangeOwnerOutput: + description: "" + cloudpolicy_PerformClassMetadataOutput: + description: "" + cloudpolicy_PerformPrivateOutput: + description: "" + cloudpolicy_PerformPublicOutput: + description: "" + cloudpolicy_PerformPurgeSplitableOutput: + description: "" + cloudpolicy_PerformSetClassMetadataOutput: + description: "" + cloudpolicy_PerformSetOrgMetadataOutput: + description: "" + cloudpolicy_PerformSetUserMetadataOutput: + description: "" + cloudpolicy_PerformStatusOutput: + description: "" + cloudrole_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudrole: + $ref: '#/definitions/CloudroleDetails' + type: object + cloudrole_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudrole: + $ref: '#/definitions/CloudroleDetails' + type: object + cloudrole_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + cloudrole: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudrole_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudrole_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudrole_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudrole_GetDetailsStatusOutput: + description: "" + schema: + properties: + cloudrole: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudrole_GetPropertyDistinctFieldOutput: + description: "" + cloudrole_GetPropertyDomainTagValuePairsOutput: + description: "" + cloudrole_GetPropertyDomainTagValueTreeOutput: + description: "" + cloudrole_GetPropertySplitableExportOutput: + description: "" + cloudrole_GetPropertySplitableOutput: + description: "" + cloudrole_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + cloudrole: + $ref: '#/definitions/StatusStatistic' + type: object + cloudrole_GetPropertyTagValuePairsOutput: + description: "" + cloudrole_GetPropertyTagValueTreeOutput: + description: "" + cloudrole_ListItemFilterOutput: + description: "" + schema: + properties: + cloudroles: + items: + $ref: '#/definitions/CloudroleDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudrole_PerformChangeOwnerOutput: + description: "" + cloudrole_PerformClassMetadataOutput: + description: "" + cloudrole_PerformDisableOutput: + description: "" + cloudrole_PerformEnableOutput: + description: "" + cloudrole_PerformPrivateOutput: + description: "" + cloudrole_PerformPublicOutput: + description: "" + cloudrole_PerformPurgeSplitableOutput: + description: "" + cloudrole_PerformSetClassMetadataOutput: + description: "" + cloudrole_PerformSetOrgMetadataOutput: + description: "" + cloudrole_PerformSetUserMetadataOutput: + description: "" + cloudrole_PerformStatusOutput: + description: "" + cloudrole_ValidateCreateDataOutput: + description: "" + schema: + properties: + cloudrole: + $ref: '#/definitions/CloudroleDetails' + type: object + cloudrole_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cloudrole: + $ref: '#/definitions/CloudroleDetails' + type: object + clouduser_CustomizeDeleteOutput: + description: "" + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDetails' + type: object + clouduser_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDetails' + type: object + clouduser_GetDetailsAccessKeysOutput: + description: "" + clouduser_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + clouduser: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + clouduser_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + clouduser_GetDetailsMetadataOutput: + description: "" + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + clouduser_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + clouduser_GetDetailsStatusOutput: + description: "" + schema: + properties: + clouduser: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + clouduser_GetPropertyDistinctFieldOutput: + description: "" + clouduser_GetPropertyDomainTagValuePairsOutput: + description: "" + clouduser_GetPropertyDomainTagValueTreeOutput: + description: "" + clouduser_GetPropertySplitableExportOutput: + description: "" + clouduser_GetPropertySplitableOutput: + description: "" + clouduser_GetPropertyTagValuePairsOutput: + description: "" + clouduser_GetPropertyTagValueTreeOutput: + description: "" + clouduser_ListItemFilterOutput: + description: "" + schema: + properties: + cloudusers: + items: + $ref: '#/definitions/ClouduserDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + clouduser_PerformAttachPolicyOutput: + description: "" + clouduser_PerformChangeOwnerOutput: + description: "" + clouduser_PerformClassMetadataOutput: + description: "" + clouduser_PerformCreateAccessKeyOutput: + description: "" + clouduser_PerformDeleteAccessKeyOutput: + description: "" + clouduser_PerformDetachPolicyOutput: + description: "" + clouduser_PerformJoinGroupOutput: + description: "" + clouduser_PerformLeaveGroupOutput: + description: "" + clouduser_PerformPurgeSplitableOutput: + description: "" + clouduser_PerformResetPasswordOutput: + description: "" + clouduser_PerformSetClassMetadataOutput: + description: "" + clouduser_PerformSetGroupsOutput: + description: "" + clouduser_PerformSetOrgMetadataOutput: + description: "" + clouduser_PerformSetPoliciesOutput: + description: "" + clouduser_PerformSetUserMetadataOutput: + description: "" + clouduser_PerformStatusOutput: + description: "" + clouduser_PerformSyncstatusOutput: + description: "" + clouduser_ValidateCreateDataOutput: + description: "" + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDetails' + type: object + saml_provider_CustomizeDeleteOutput: + description: "" + schema: + properties: + saml_provider: + $ref: '#/definitions/SAMLProviderDetails' + type: object + saml_provider_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + saml_provider: + $ref: '#/definitions/SAMLProviderDetails' + type: object + saml_provider_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + saml_provider: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + saml_provider_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + saml_provider_GetDetailsMetadataOutput: + description: "" + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + saml_provider_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + saml_provider_GetDetailsStatusOutput: + description: "" + schema: + properties: + saml_provider: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + saml_provider_GetPropertyDistinctFieldOutput: + description: "" + saml_provider_GetPropertyDomainTagValuePairsOutput: + description: "" + saml_provider_GetPropertyDomainTagValueTreeOutput: + description: "" + saml_provider_GetPropertySplitableExportOutput: + description: "" + saml_provider_GetPropertySplitableOutput: + description: "" + saml_provider_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + saml_provider: + $ref: '#/definitions/StatusStatistic' + type: object + saml_provider_GetPropertyTagValuePairsOutput: + description: "" + saml_provider_GetPropertyTagValueTreeOutput: + description: "" + saml_provider_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + saml_providers: + items: + $ref: '#/definitions/SAMLProviderDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + saml_provider_PerformChangeOwnerOutput: + description: "" + saml_provider_PerformClassMetadataOutput: + description: "" + saml_provider_PerformPrivateOutput: + description: "" + saml_provider_PerformPublicOutput: + description: "" + saml_provider_PerformPurgeSplitableOutput: + description: "" + saml_provider_PerformSetClassMetadataOutput: + description: "" + saml_provider_PerformSetOrgMetadataOutput: + description: "" + saml_provider_PerformSetUserMetadataOutput: + description: "" + saml_provider_PerformStatusOutput: + description: "" + saml_provider_ValidateCreateDataOutput: + description: "" + schema: + properties: + saml_provider: + $ref: '#/definitions/SAMLProviderDetails' + type: object + saml_provider_ValidateUpdateDataOutput: + description: "" + schema: + properties: + saml_provider: + $ref: '#/definitions/SAMLProviderDetails' + type: object + samluser_CustomizeDeleteOutput: + description: "" + schema: + properties: + samluser: + $ref: '#/definitions/SamluserDetails' + type: object + samluser_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + samluser: + $ref: '#/definitions/SamluserDetails' + type: object + samluser_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + samluser: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + samluser_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + samluser_GetDetailsMetadataOutput: + description: "" + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + samluser_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + samluser_GetDetailsStatusOutput: + description: "" + schema: + properties: + samluser: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + samluser_GetPropertyDistinctFieldOutput: + description: "" + samluser_GetPropertyDomainTagValuePairsOutput: + description: "" + samluser_GetPropertyDomainTagValueTreeOutput: + description: "" + samluser_GetPropertySplitableExportOutput: + description: "" + samluser_GetPropertySplitableOutput: + description: "" + samluser_GetPropertyTagValuePairsOutput: + description: "" + samluser_GetPropertyTagValueTreeOutput: + description: "" + samluser_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + samlusers: + items: + $ref: '#/definitions/SamluserDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + samluser_PerformChangeOwnerOutput: + description: "" + samluser_PerformClassMetadataOutput: + description: "" + samluser_PerformPurgeSplitableOutput: + description: "" + samluser_PerformSetClassMetadataOutput: + description: "" + samluser_PerformSetOrgMetadataOutput: + description: "" + samluser_PerformSetUserMetadataOutput: + description: "" + samluser_PerformStatusOutput: + description: "" + samluser_ValidateCreateDataOutput: + description: "" + schema: + properties: + samluser: + $ref: '#/definitions/SamluserDetails' + type: object + samluser_ValidateUpdateDataOutput: + description: "" + schema: + properties: + samluser: + $ref: '#/definitions/SamluserDetails' + type: object schemes: -- https -- http + - https + - http securityDefinitions: - keystone: - in: header - name: X-Auth-Token - type: apiKey + keystone: + in: header + name: X-Auth-Token + type: apiKey swagger: "2.0" diff --git a/docs/swagger/swagger_compute.yaml b/docs/swagger/swagger_compute.yaml index d7d973de75..9681964112 100644 --- a/docs/swagger/swagger_compute.yaml +++ b/docs/swagger/swagger_compute.yaml @@ -1,165452 +1,178876 @@ basePath: / consumes: -- application/json + - application/json definitions: - AccessGroupCacheDetails: - properties: - access_group: - description: 权限组名称 - type: string - x-go-name: AccessGroup - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - AccessGroupCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - AccessGroupDetails: - 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 - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - 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' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - AccessGroupRuleCreateInput: - properties: - AccessGroupId: - type: string - Description: - type: string - Priority: - format: int64 - type: integer - RWAccessType: - type: string - Source: - type: string - UserAccessType: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - AccessGroupRuleDetails: - properties: - access_group: - description: 权限组名称 - type: string - x-go-name: AccessGroup - 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/compute - AccessGroupRuleUpdateInput: - properties: - Description: - type: string - Priority: - format: int64 - type: integer - RWAccessType: - type: string - Source: - type: string - UserAccessType: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - AppDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - AppEnvironmentDetails: - 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 - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - AttachNetworkInput: - properties: - nets: - description: 添加的网卡的配置 - items: - $ref: '#/definitions/NetworkConfig' - type: array - x-go-name: Nets - required: - - nets - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - AutoRenewInput: - properties: - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - BackupStorageCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - capacity_mb: - description: 'description: Capacity size in MB' - format: int64 - type: integer - x-go-name: CapacityMb - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - 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 - nfs_host: - description: 'description: host of nfs, storage_type 为 nfs 时, 此参数必传' - example: 192.168.222.2 - type: string - x-go-name: NfsHost - nfs_shared_dir: - description: 'description: shared dir of nfs, storage_type 为 nfs 时, 此参数必传' - example: /nfs_root/ - type: string - x-go-name: NfsSharedDir - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - storage_type: - description: 'description: storage type' - enum: - - nfs - type: string - x-go-name: StorageType - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BackupStorageDetails: - properties: - NfsHost: - type: string - NfsSharedDir: - type: string - 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 - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - 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' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BaremetalDiskConfig: - properties: - adapter: - format: int64 - type: integer - x-go-name: Adapter - cachedbadbbu: - type: boolean - x-go-name: Cachedbadbbu - conf: - description: raid config - type: string - x-go-name: Conf - count: - format: int64 - type: integer - x-go-name: Count - direct: - type: boolean - x-go-name: Direct - driver: - type: string - x-go-name: Driver - ra: - type: boolean - x-go-name: RA - range: - items: - format: int64 - type: integer - type: array - x-go-name: Range - size: - items: - format: int64 - type: integer - type: array - x-go-name: Size - splits: - type: string - x-go-name: Splits - strip: - format: int64 - type: integer - x-go-name: Strip - type: - description: |- - Index int `json:"index"` - disk type - type: string - x-go-name: Type - wt: - type: boolean - x-go-name: WT - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BaremetalagentCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - access_ip: - type: string - x-go-name: AccessIp - agent_type: - type: string - x-go-name: AgentType - 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 - manager_uri: - type: string - x-go-name: ManagerUri - 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 - version: - type: string - x-go-name: Version - zone_id: - description: 可用区ID或名称 - example: zone1 - type: string - x-go-name: ZoneId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BaremetalagentDetails: - properties: - access_ip: - type: string - x-go-name: AccessIp - agent_type: - type: string - x-go-name: AgentType - 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 - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - 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 - disable_image_cache: - type: boolean - x-go-name: DisableImageCache - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager_uri: - type: string - x-go-name: ManagerUri - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - status: - type: string - x-go-name: Status - storagecache_id: - type: string - x-go-name: StoragecacheId - 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 - version: - type: string - x-go-name: Version - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BaremetalagentUpdateInput: - properties: - access_ip: - type: string - x-go-name: AccessIp - agent_type: - type: string - x-go-name: AgentType - description: - description: 资源描述 - type: string - x-go-name: Description - manager_uri: - type: string - x-go-name: ManagerUri - name: - description: 资源名称 - type: string - x-go-name: Name - version: - type: string - x-go-name: Version - zone_id: - description: 可用区ID或名称 - example: zone1 - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketAclInput: - properties: - Acl: - $ref: '#/definitions/TBucketACLType' - Key: - items: - type: string - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketCORSRule: - properties: - AllowedHeaders: - items: - type: string - type: array - AllowedMethods: - items: - type: string - type: array - AllowedOrigins: - description: 允许的源站，可以是* - items: - type: string - type: array - ExposeHeaders: - items: - type: string - type: array - Id: - description: 规则区别标识 - type: string - MaxAgeSeconds: - format: int64 - type: integer - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketCORSRuleDeleteInput: - properties: - Id: - items: - type: string - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketCORSRules: - properties: - data: - items: - $ref: '#/definitions/BucketCORSRule' - type: array - x-go-name: Data - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - cloudprovider_id: - description: 列出关联指定云订阅(ID或Name)的资源 - type: string - x-go-name: CloudproviderId - cloudregion_id: - description: 区域名称或ID - type: string - x-go-name: CloudregionId - 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 - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - storage_class: - type: string - x-go-name: StorageClass - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketDetails: - properties: - access_urls: - description: 访问URL列表 - items: - $ref: '#/definitions/SBucketAccessUrl' - type: array - x-go-name: AccessUrls - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - acl: - type: string - x-go-name: Acl - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - location: - type: string - x-go-name: Location - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - object_cnt: - format: int64 - type: integer - x-go-name: ObjectCnt - object_cnt_limit: - format: int64 - type: integer - x-go-name: ObjectCntLimit - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - 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 - size_bytes: - format: int64 - type: integer - x-go-name: SizeBytes - size_bytes_limit: - format: int64 - type: integer - x-go-name: SizeBytesLimit - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - storage_class: - type: string - x-go-name: StorageClass - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - BucketGetAclOutput: - properties: - acl: - description: ACL - type: string - x-go-name: Acl - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketGetObjectsOutput: - properties: - data: - description: 对象列表 - items: - $ref: '#/definitions/SCloudObject' - type: array - x-go-name: Data - marker_field: - description: 排序字段，总是key - example: key - type: string - x-go-name: MarkerField - marker_order: - description: 排序顺序，总是降序 - example: DESC - type: string - x-go-name: MarkerOrder - next_marker: - description: 下一页请求的paging_marker标识 - type: string - x-go-name: NextMarker - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketMetadataInput: - properties: - Key: - items: - type: string - type: array - Metadata: - $ref: '#/definitions/Header' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketPerformDeleteInput: - properties: - keys: - description: 待删除对象KEY - items: - type: string - type: array - x-go-name: Keys - required: - - keys - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketPerformMakedirInput: - properties: - key: - description: 目录对象KEY - type: string - x-go-name: Key - required: - - key - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketPerformTempUrlInput: - properties: - expire_seconds: - description: 过期时间，单位秒 - format: int64 - type: integer - x-go-name: ExpireSeconds - key: - description: 对象KEY - type: string - x-go-name: Key - method: - description: 访问对象方法 - type: string - x-go-name: Method - required: - - key - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketPerformTempUrlOutput: - properties: - url: - description: 生成的临时URL - type: string - x-go-name: Url - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketPolicy: - properties: - Data: - items: - $ref: '#/definitions/BucketPolicyStatement' - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketPolicyDeleteInput: - properties: - Id: - items: - type: string - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketPolicyStatement: - properties: - Action: - description: 授权的行为 - items: - type: string - type: array - CannedAction: - description: Read|ReadWrite|FullControl - type: string - Condition: - additionalProperties: - additionalProperties: - type: object - type: object - description: 触发授权的条件 - type: object - Effect: - description: Allow|Deny - type: string - Id: - description: 根据index 生成 - type: string - Principal: - additionalProperties: - items: - type: string - type: array - description: 授权的目标主体 - type: object - PrincipalId: - description: 解析字段，主账号id:子账号id - items: - type: string - type: array - PrincipalNames: - additionalProperties: - type: string - description: map[主账号id:子账号id]子账号name - type: object - Resource: - description: 被授权的资源地址 - items: - type: string - type: array - ResourcePath: - description: 资源路径 - items: - type: string - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketPolicyStatementInput: - properties: - CannedAction: - description: Read|ReadWrite|FullControl - type: string - Effect: - description: Allow|Deny - type: string - IpEquals: - description: ip 条件 - items: - type: string - type: array - IpNotEquals: - items: - type: string - type: array - PrincipalId: - description: 主账号id:子账号id - items: - type: string - type: array - ResourcePath: - description: 被授权的资源地址,/* - items: - type: string - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketRefererConf: - properties: - AllowEmptyRefer: - description: 是否允许空referer 访问 - type: boolean - DomainList: - description: 域名列表 - items: - type: string - type: array - RefererType: - description: |- - Referer Type - enmu: Black-List, White-List - type: string - enabled: - description: 是否开启 - type: boolean - x-go-name: Enabled - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketWebsiteConf: - properties: - ErrorDocument: - description: 错误时返回的文档 - type: string - Index: - description: 主页 - type: string - Protocol: - description: http或https - type: string - Rules: - items: - $ref: '#/definitions/BucketWebsiteRoutingRule' - type: array - Url: - description: 访问网站url - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - BucketWebsiteRoutingRule: - properties: - ConditionErrorCode: - type: string - ConditionPrefix: - type: string - RedirectProtocol: - type: string - RedirectReplaceKey: - type: string - RedirectReplaceKeyPrefix: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CAGuestNet: - properties: - ip_nets: - items: - $ref: '#/definitions/CAIPNet' - type: array - x-go-name: IPNets - name: - description: 'description: Host 的 Name' - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CAHostNet: - properties: - ip: - description: 'description: IP' - type: string - x-go-name: IP - name: - description: 'description: Host 的 Name' - type: string - x-go-name: Name - suitable_network: - description: 'description: 合适的已有网络' - type: string - x-go-name: SuitableNetwork - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CAIPNet: - properties: - ip: - description: 'description: IP' - type: string - x-go-name: IP - suitable_network: - description: 'description: 合适的已有网络' - type: string - x-go-name: SuitableNetwork - vlan_id: - format: int32 - type: integer - x-go-name: VlanID - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CANetConf: - properties: - description: - type: string - x-go-name: Description - guest_gateway: - type: string - x-go-name: GuestGateway - guest_ip_end: - type: string - x-go-name: GuestIpEnd - guest_ip_mask: - format: int8 - type: integer - x-go-name: GuestIpMask - guest_ip_start: - type: string - x-go-name: GuestIpStart - name: - type: string - x-go-name: Name - vlan_id: - format: int32 - type: integer - x-go-name: VlanID - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CAPWire: - properties: - distributed: - type: boolean - x-go-name: Distributed - guest_networks: - items: - $ref: '#/definitions/CANetConf' - type: array - x-go-name: GuestNetworks - host_networks: - items: - $ref: '#/definitions/CANetConf' - type: array - x-go-name: HostNetworks - hosts: - items: - $ref: '#/definitions/SimpleHost' - type: array - x-go-name: Hosts - 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/compute - CAWireConf: - properties: - description: - description: 'description: wire description' - type: string - x-go-name: Description - name: - description: 'description: wire name' - type: string - x-go-name: Name - zone_ids: - description: Zoneids to be selected - items: - type: string - type: array - x-go-name: ZoneIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CAWireNet: - properties: - host_suggested_networks: - description: 'description: 没有合适的已有网络，推荐的网络配置' - items: - $ref: '#/definitions/CANetConf' - type: array - x-go-name: HostSuggestedNetworks - hosts: - items: - $ref: '#/definitions/CAHostNet' - type: array - x-go-name: Hosts - suggested_wire: - $ref: '#/definitions/CAWireConf' - suitable_wire: - type: string - x-go-name: SuitableWire - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CDNDomainCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - Origins: - $ref: '#/definitions/SCdnOrigins' - area: - description: |- - 加速区域 - enmu: mainland, overseas, global - requrired: true - type: string - x-go-name: Area - cloudprovider_id: - description: 列出关联指定云订阅(ID或Name)的资源 - type: string - x-go-name: CloudproviderId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disable_delete: - default: true - description: 删除保护,创建的资源默认不允许删除 - type: boolean - x-go-name: DisableDelete - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - 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 - service_type: - description: 服务类型 - type: string - x-go-name: ServiceType - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - - Origins - - service_type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CDNDomainDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CacheImageInput: - properties: - checksum: - description: 'swagger: ignore' - type: string - x-go-name: Checksum - format: - type: string - x-go-name: Format - image: - type: string - x-go-name: Image - image_id: - type: string - x-go-name: ImageId - image_name: - description: 'swagger: ignore' - type: string - x-go-name: ImageName - is_force: - type: boolean - x-go-name: IsForce - os_arch: - description: 'swagger: ignore' - type: string - x-go-name: OsArch - os_distribution: - description: 'swagger: ignore' - type: string - x-go-name: OsDistribution - os_full_version: - description: 'swagger: ignore' - type: string - x-go-name: OsFullVersion - os_type: - description: 'swagger: ignore' - type: string - x-go-name: OsType - os_version: - description: 'swagger: ignore' - type: string - x-go-name: OsVersion - parent_task_id: - description: 'swagger: ignore' - type: string - x-go-name: ParentTaskId - server_id: - description: 'swagger: ignore' - type: string - x-go-name: ServerId - source_host_id: - description: 'swagger: ignore' - type: string - x-go-name: SourceHostId - src_url: - description: 'swagger: ignore' - type: string - x-go-name: SrcUrl - storagecache_id: - description: 'swagger: ignore' - type: string - x-go-name: StoragecacheId - zone: - description: 'swagger: ignore' - type: string - x-go-name: Zone - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CachedImageManagerCacheImageInput: - properties: - image_id: - type: string - x-go-name: ImageId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CachedImageUncacheImageInput: - properties: - is_force: - default: false - description: 是否强制清除缓存 - type: boolean - x-go-name: IsForce - storagecache_id: - description: 存储缓存名Id - type: string - x-go-name: StoragecacheId - required: - - storagecache_id - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CachedimageDetails: - properties: - cached_count: - description: 此镜像被使用次数 - example: 0 - format: int64 - type: integer - x-go-name: CachedCount - 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 - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - hypervisor: - description: 虚拟化类型 - type: string - x-go-name: Hypervisor - id: - description: 资源UUID - type: string - x-go-name: Id - image_type: - description: '镜像类型, system: 公有云镜像, customized: 自定义镜像' - example: system - type: string - x-go-name: ImageType - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - info: - description: 镜像详情信息 - example: - deleted: false - disk_format: qcow2 - id: img-a6uucnfl - is_public: true - min_disk: 51200 - min_ram: 0 - name: FreeBSD 11.1 64bit - properties: - os_arch: x86_64 - os_distribution: FreeBSD - os_type: FreeBSD - os_version: "11" - protected: true - size: 53687091200 - status: active - type: object - x-go-name: Info - 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 - last_ref: - description: |- - 最近一次缓存引用时间 - 2020-01-17T05:20:54.000000Z - format: date-time - type: string - x-go-name: LastRef - last_sync: - description: 上此同步时间 - example: "2020-01-17T05:28:54.000000Z" - format: date-time - type: string - x-go-name: LastSync - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - os_distribution: - description: 操作系统发行版 - example: FreeBSD - type: string - x-go-name: OsDistribution - os_type: - description: 操作系统类型 - example: FreeBSD - type: string - x-go-name: OsType - os_version: - description: 操作系统版本 - example: "11" - type: string - x-go-name: OsVersion - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - ref_count: - description: 引用次数 - example: 0 - format: int64 - type: integer - x-go-name: RefCount - 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 - size: - description: '镜像大小单位: Byte' - example: 53687091200 - format: int64 - type: integer - x-go-name: Size - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 镜像状态, 和info里面的status一致 - example: active - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - uefi: - description: 是否支持UEFI - example: false - type: boolean - x-go-name: UEFI - 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/compute - CdnDomain: - properties: - Area: - description: 区域 mainland|overseas|global - type: string - Cname: - description: cdn Cname - type: string - Domain: - description: cdn加速域名 - type: string - Origin: - description: 源站 - type: string - OriginType: - description: 源站类型 domain|ip|bucket - type: string - Status: - description: 状态 rejected(域名未审核)|processing(部署中)|online|offline - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CdnDomains: - properties: - data: - items: - $ref: '#/definitions/CdnDomain' - type: array - x-go-name: Data - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - Cdrom: - properties: - boot_index: - format: int8 - type: integer - x-go-name: BootIndex - detail: - type: string - x-go-name: Detail - ordinal: - format: int64 - type: integer - x-go-name: Ordinal - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ChangeOwnerCandidateDomainsOutput: - properties: - candidates: - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: Candidates - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - CloudaccountCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - As: - description: 弹性伸缩服务 - type: string - Bms: - description: 裸金属服务器 - type: string - Bss: - description: 合作伙伴运营能力 - type: string - Cce: - description: 云容器服务 - type: string - Cci: - description: 云容器实例 CCI - type: string - Ces: - description: 监控服务 CloudEye - type: string - Csbs: - description: 云服务器备份服务 - type: string - Cts: - description: 云审计服务 - type: string - Dcs: - description: 分布式缓存服务 - type: string - DefaultRegion: - description: 默认区域Id, Apara及HCSO需要此参数 - example: cn-north-2 - type: string - DefaultSubnetDns: - description: 默认DNS - example: 10.125.0.26,10.125.0.27 - type: string - Ecs: - description: 弹性云服务 - type: string - Elb: - description: 弹性负载均衡 ELB - type: string - EndpointDomain: - description: 华为私有云Endpoint域名 - example: hcso.com.cn - type: string - Eps: - description: 企业项目 - type: string - Evs: - description: 云硬盘 EVS - type: string - Iam: - description: 统一身份认证服务 - type: string - Ims: - description: 镜像服务 - type: string - Modelarts: - description: Modelarts - type: string - Nat: - description: Nat网关 NAT - type: string - Obs: - description: 对象存储服务 OBS - type: string - Rds: - description: 关系型数据库 RDS - type: string - SfsTurbo: - description: 文件系统 - type: string - SkipDuplicateAccountCheck: - description: 跳过重复账号注册检查 - type: boolean - Vbs: - description: 云硬盘备份 VBS - type: string - Vpc: - description: 虚拟私有云 VPC - type: string - access_key_id: - description: 秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) - type: string - x-go-name: AccessKeyId - access_key_secret: - description: 秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) - type: string - x-go-name: AccessKeySecret - access_url: - description: 认证地址 - type: string - x-go-name: AccessUrl - account: - description: |- - 账号信息，各个平台字段不尽相同，以下是各个平台账号创建所需要的字段 - - - - 云平台 |字段 | 翻译 | 是否必传 | 默认值 | 可否更新 | 获取方式 | - ------ |------ | ------ | --------- | -------- |-------- |-------- | - Aliyun |access_key_id |秘钥ID | 是 | | 是 | | - Aliyun |access_key_secret |秘钥Key | 是 | | 是 | | - Qcloud |app_id |APP ID | 是 | | 否 | | - Qcloud |secret_id |秘钥ID | 是 | | 是 | | - Qcloud |secret_key |秘钥Key | 是 | | 是 | | - OpenStack |project_name |用户所在项目 | 是 | | 是 | | - OpenStack |username |用户名 | 是 | | 是 | | - OpenStack |password |用户密码 | 是 | | 是 | | - OpenStack |auth_url |认证地址 | 是 | | 否 | | - OpenStack |domain_name |用户所在的域 | 否 |Default | 是 | | - VMware |username |用户名 | 是 | | 是 | | - VMware |password |密码 | 是 | | 是 | | - VMware |host |主机IP或域名 | 是 | | 否 | | - VMware |port |主机端口 | 否 |443 | 否 | | - Azure |directory_id |目录ID | 是 | | 否 | | - Azure |environment |区域 | 是 | | 否 | | - Azure |client_id |客户端ID | 是 | | 是 | | - Azure |client_secret |客户端密码 | 是 | | 是 | | - Huawei |access_key_id |秘钥ID | 是 | | 是 | | - Huawei |access_key_secret |秘钥 | 是 | | 是 | | - Huawei |environment |区域 | 是 | | 否 | | - Aws |access_key_id |秘钥ID | 是 | | 是 | | - Aws |access_key_secret |秘钥 | 是 | | 是 | | - Aws |environment |区域 | 是 | | 否 | | - Ucloud |access_key_id |秘钥ID | 是 | | 是 | | - Ucloud |access_key_secret |秘钥 | 是 | | 是 | | - Google |project_id |项目ID | 是 | | 否 | | - Google |client_email |客户端email | 是 | | 否 | | - Google |private_key_id |秘钥ID | 是 | | 是 | | - Google |private_key |秘钥Key | 是 | | 是 | | - type: string - x-go-name: Account - app_id: - description: app id (Qcloud) - type: string - x-go-name: AppId - auto_create_project: - default: false - description: 自动根据云上项目或订阅创建本地项目, OpenStack此参数为true - type: boolean - x-go-name: AutoCreateProject - auto_url: - description: 认证地址 (openstack,zstack) - type: string - x-go-name: AuthUrl - brand: - description: |- - 指定云平台品牌, 此参数默认和provider相同 - requried: false - - - - provider | 支持的参数 | - -------- | ---------- | - VMware | VMware | - Aliyun | Aliyun | - Qcloud | Qcloud | - Azure | Azure | - Aws | Aws | - Huawei | Huawei | - OpenStack | OpenStack | - Ucloud | Ucloud | - ZStack | ZStack, DStack | - Google | Google | - Ctyun | Ctyun | - type: string - x-go-name: Brand - client_id: - description: 客户端ID (Azure) - type: string - x-go-name: ClientId - client_secret: - description: 客户端秘钥 (Azure) - type: string - x-go-name: ClientSecret - crm_biz_id: - description: customInfo type=1 - type: string - x-go-name: CrmBizId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - directory_id: - description: 目录ID (Azure) - type: string - x-go-name: DirectoryId - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - domain_name: - default: Default - description: 账号所在的域 (openstack) - type: string - x-go-name: DomainName - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - enable_project_sync: - type: boolean - x-go-name: EnableProjectSync - enable_resource_sync: - type: boolean - x-go-name: EnableResourceSync - enabled: - description: 该资源是否被管理员*人为*启用或者禁用 - type: boolean - x-go-name: Enabled - endpoint: - description: 端点 (s3) 或 Apsara(飞天) - type: string - x-go-name: Endpoint - environment: - description: 环境 (Azure, Aws, huawei, ctyun, aliyun) - type: string - x-go-name: Environment - gcp_client_email: - description: Google服务账号email (gcp) - type: string - x-go-name: GCPClientEmail - gcp_private_key: - description: Google服务账号秘钥 (gcp) - type: string - x-go-name: GCPPrivateKey - gcp_private_key_id: - description: Google服务账号秘钥id (gcp) - type: string - x-go-name: GCPPrivateKeyId - gcp_project_id: - description: Google服务账号project id (gcp) - type: string - x-go-name: GCPProjectId - 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 - host: - description: 主机IP (esxi) - type: string - x-go-name: Host - 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 - options: - description: 额外信息,例如账单的access key - type: object - x-go-name: Options - organization_id: - description: 飞天允许的最高组织id, 默认为1 - format: int64 - type: integer - x-go-name: OrganizationId - password: - description: 密码 (openstack, zstack, esxi) - type: string - x-go-name: Password - port: - description: 主机端口 (esxi) - format: int64 - type: integer - x-go-name: Port - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - project_mapping_id: - type: string - x-go-name: ProjectMappingId - project_name: - description: 账号所在的项目 (openstack) - type: string - x-go-name: ProjectName - provider: - description: |- - 指定云平台 - Qcloud: 腾讯云 - Ctyun: 天翼云 - enum: - - VMware - - ' Aliyun' - - ' Qcloud' - - ' Azure' - - ' Aws' - - ' Huawei' - - ' OpenStack' - - ' Ucloud' - - ' ZStack' - - ' Google' - - ' Ctyun' - - ' JDcloud' - type: string - x-go-name: Provider - proxy_setting_id: - description: 代理配置 - type: string - x-go-name: ProxySettingId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - read_only: - type: boolean - x-go-name: ReadOnly - saml_auth: - default: false - description: 是否启用SAML认证 - type: boolean - x-go-name: SAMLAuth - secret_id: - description: 秘钥ID (Qcloud) - type: string - x-go-name: SecretId - secret_key: - description: 秘钥key (Qcloud) - type: string - x-go-name: SecretKey - show_sub_accounts: - description: 仅当show_sub_accounts=true并且dry_run=true时才返回sub accounts 信息, 且不会创建云账号 - type: boolean - x-go-name: ShowSubAccounts - start_sync: - description: 是否立即开始同步资源 - type: boolean - x-go-name: StartSync - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - username: - description: 用户名 (openstack, zstack, esxi) - type: string - x-go-name: Username - zone: - description: VMware 账号有zone属性 - type: string - x-go-name: Zone - required: - - name - - EndpointDomain - - DefaultRegion - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudaccountDetail: - properties: - LastSyncCost: - description: 上次同步耗时 - type: string - ProjectMapping: - type: string - access_url: - description: 云环境连接地址 - type: string - x-go-name: AccessUrl - account: - description: 云账号 - type: string - x-go-name: Account - account_id: - description: 云环境唯一标识 - type: string - x-go-name: AccountId - auto_create_project: - description: 是否根据云上项目自动在本地创建对应项目 - example: false - type: boolean - x-go-name: AutoCreateProject - balance: - description: 账户余额 - example: 124.2 - format: double - type: number - x-go-name: Balance - brand: - description: 品牌信息, 一般和provider相同 - example: DStack - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: |- - 云账号环境类型 - public: 公有云 - private: 私有云 - onpremise: 本地IDC - example: public - type: string - x-go-name: CloudEnv - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - disk_count: - description: 云盘数量 - example: 12 - format: int64 - type: integer - x-go-name: DiskCount - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - eip_count: - description: 弹性公网Ip数量 - example: 2 - format: int64 - type: integer - x-go-name: EipCount - enable_project_sync: - type: boolean - x-go-name: EnableProjectSync - enable_resource_sync: - type: boolean - x-go-name: EnableResourceSync - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - error_count: - description: 账号探测异常错误次数 - format: int64 - type: integer - x-go-name: ErrorCount - guest_count: - description: 云主机数量 - example: 4 - format: int64 - type: integer - x-go-name: GuestCount - health_status: - description: 账号健康状态 - example: normal - type: string - x-go-name: HealthStatus - host_count: - description: 宿主机数量(不计算虚拟机宿主机数量) - example: 0 - format: int64 - type: integer - x-go-name: HostCount - iam_login_url: - description: 公有云子账号登录地址 - type: string - x-go-name: IamLoginUrl - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_on_premise: - description: 是否是本地IDC账号 - example: false - type: boolean - x-go-name: IsOnPremise - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - is_public_cloud: - description: 是否是公有云账号 - example: true - type: boolean - x-go-name: IsPublicCloud - lake_of_permissions: - $ref: '#/definitions/SAccountPermissions' - 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 - options: - description: 额外信息 - type: object - x-go-name: Options - probe_at: - description: 上次账号探测时间 - format: date-time - type: string - x-go-name: ProbeAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_mapping_id: - type: string - x-go-name: ProjectMappingId - projects: - description: 子订阅项目信息 - items: - $ref: '#/definitions/ProviderProject' - type: array - x-go-name: Projects - provider: - description: 云平台类型 - example: google - type: string - x-go-name: Provider - provider_count: - description: 子订阅数量 - example: 1 - format: int64 - type: integer - x-go-name: ProviderCount - proxy_setting: - $ref: '#/definitions/SProxySetting' - proxy_setting_id: - description: 默认值proxyapi.ProxySettingId_DIRECT - type: string - x-go-name: ProxySettingId - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - read_only: - type: boolean - x-go-name: ReadOnly - routetable_count: - description: 路由表数量 - example: 0 - format: int64 - type: integer - x-go-name: RoutetableCount - saml_auth: - type: boolean - x-go-name: SAMLAuth - secret: - description: 云账号密码 - type: string - x-go-name: Secret - share_mode: - default: '"false" nullable:"false"`' - description: for backward compatiblity, keep is_public field, but not usable - type: string - x-go-name: ShareMode - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - status: - description: 资源状态 - type: string - x-go-name: Status - storage_count: - description: 块存储数量 - example: 12 - format: int64 - type: integer - x-go-name: StorageCount - storagecache_count: - description: 存储缓存数量 - example: 10 - format: int64 - type: integer - x-go-name: StoragecacheCount - sub_accounts: - $ref: '#/definitions/SubAccounts' - sync_interval_seconds: - description: 同步时间间隔 - example: 3600 - format: int64 - type: integer - x-go-name: SyncIntervalSeconds - sync_status: - type: string - x-go-name: SyncStatus - sync_stauts2: - description: 同步状态 - type: string - x-go-name: SyncStatus2 - sysinfo: - description: 云系统信息 - type: object - x-go-name: Sysinfo - tenant: - description: 云账号项目名称 - example: system - type: string - x-go-name: Tenant - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - version: - description: 云API版本 - type: string - x-go-name: Version - vpc_count: - description: 虚拟私有网络数量 - example: 4 - format: int64 - type: integer - x-go-name: VpcCount - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudaccountPerformPrepareNetsInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - As: - description: 弹性伸缩服务 - type: string - Bms: - description: 裸金属服务器 - type: string - Bss: - description: 合作伙伴运营能力 - type: string - Cce: - description: 云容器服务 - type: string - Cci: - description: 云容器实例 CCI - type: string - Ces: - description: 监控服务 CloudEye - type: string - Csbs: - description: 云服务器备份服务 - type: string - Cts: - description: 云审计服务 - type: string - Dcs: - description: 分布式缓存服务 - type: string - DefaultRegion: - description: 默认区域Id, Apara及HCSO需要此参数 - example: cn-north-2 - type: string - DefaultSubnetDns: - description: 默认DNS - example: 10.125.0.26,10.125.0.27 - type: string - Ecs: - description: 弹性云服务 - type: string - Elb: - description: 弹性负载均衡 ELB - type: string - EndpointDomain: - description: 华为私有云Endpoint域名 - example: hcso.com.cn - type: string - Eps: - description: 企业项目 - type: string - Evs: - description: 云硬盘 EVS - type: string - Iam: - description: 统一身份认证服务 - type: string - Ims: - description: 镜像服务 - type: string - Modelarts: - description: Modelarts - type: string - Nat: - description: Nat网关 NAT - type: string - Obs: - description: 对象存储服务 OBS - type: string - Rds: - description: 关系型数据库 RDS - type: string - SfsTurbo: - description: 文件系统 - type: string - SkipDuplicateAccountCheck: - description: 跳过重复账号注册检查 - type: boolean - Vbs: - description: 云硬盘备份 VBS - type: string - Vpc: - description: 虚拟私有云 VPC - type: string - access_key_id: - description: 秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) - type: string - x-go-name: AccessKeyId - access_key_secret: - description: 秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) - type: string - x-go-name: AccessKeySecret - access_url: - description: 认证地址 - type: string - x-go-name: AccessUrl - account: - description: |- - 账号信息，各个平台字段不尽相同，以下是各个平台账号创建所需要的字段 - - - - 云平台 |字段 | 翻译 | 是否必传 | 默认值 | 可否更新 | 获取方式 | - ------ |------ | ------ | --------- | -------- |-------- |-------- | - Aliyun |access_key_id |秘钥ID | 是 | | 是 | | - Aliyun |access_key_secret |秘钥Key | 是 | | 是 | | - Qcloud |app_id |APP ID | 是 | | 否 | | - Qcloud |secret_id |秘钥ID | 是 | | 是 | | - Qcloud |secret_key |秘钥Key | 是 | | 是 | | - OpenStack |project_name |用户所在项目 | 是 | | 是 | | - OpenStack |username |用户名 | 是 | | 是 | | - OpenStack |password |用户密码 | 是 | | 是 | | - OpenStack |auth_url |认证地址 | 是 | | 否 | | - OpenStack |domain_name |用户所在的域 | 否 |Default | 是 | | - VMware |username |用户名 | 是 | | 是 | | - VMware |password |密码 | 是 | | 是 | | - VMware |host |主机IP或域名 | 是 | | 否 | | - VMware |port |主机端口 | 否 |443 | 否 | | - Azure |directory_id |目录ID | 是 | | 否 | | - Azure |environment |区域 | 是 | | 否 | | - Azure |client_id |客户端ID | 是 | | 是 | | - Azure |client_secret |客户端密码 | 是 | | 是 | | - Huawei |access_key_id |秘钥ID | 是 | | 是 | | - Huawei |access_key_secret |秘钥 | 是 | | 是 | | - Huawei |environment |区域 | 是 | | 否 | | - Aws |access_key_id |秘钥ID | 是 | | 是 | | - Aws |access_key_secret |秘钥 | 是 | | 是 | | - Aws |environment |区域 | 是 | | 否 | | - Ucloud |access_key_id |秘钥ID | 是 | | 是 | | - Ucloud |access_key_secret |秘钥 | 是 | | 是 | | - Google |project_id |项目ID | 是 | | 否 | | - Google |client_email |客户端email | 是 | | 否 | | - Google |private_key_id |秘钥ID | 是 | | 是 | | - Google |private_key |秘钥Key | 是 | | 是 | | - type: string - x-go-name: Account - app_id: - description: app id (Qcloud) - type: string - x-go-name: AppId - auto_create_project: - default: false - description: 自动根据云上项目或订阅创建本地项目, OpenStack此参数为true - type: boolean - x-go-name: AutoCreateProject - auto_url: - description: 认证地址 (openstack,zstack) - type: string - x-go-name: AuthUrl - brand: - description: |- - 指定云平台品牌, 此参数默认和provider相同 - requried: false - - - - provider | 支持的参数 | - -------- | ---------- | - VMware | VMware | - Aliyun | Aliyun | - Qcloud | Qcloud | - Azure | Azure | - Aws | Aws | - Huawei | Huawei | - OpenStack | OpenStack | - Ucloud | Ucloud | - ZStack | ZStack, DStack | - Google | Google | - Ctyun | Ctyun | - type: string - x-go-name: Brand - client_id: - description: 客户端ID (Azure) - type: string - x-go-name: ClientId - client_secret: - description: 客户端秘钥 (Azure) - type: string - x-go-name: ClientSecret - crm_biz_id: - description: customInfo type=1 - type: string - x-go-name: CrmBizId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - directory_id: - description: 目录ID (Azure) - type: string - x-go-name: DirectoryId - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - domain_name: - default: Default - description: 账号所在的域 (openstack) - type: string - x-go-name: DomainName - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - dvs: - type: boolean - x-go-name: Dvs - enable_project_sync: - type: boolean - x-go-name: EnableProjectSync - enable_resource_sync: - type: boolean - x-go-name: EnableResourceSync - enabled: - description: 该资源是否被管理员*人为*启用或者禁用 - type: boolean - x-go-name: Enabled - endpoint: - description: 端点 (s3) 或 Apsara(飞天) - type: string - x-go-name: Endpoint - environment: - description: 环境 (Azure, Aws, huawei, ctyun, aliyun) - type: string - x-go-name: Environment - gcp_client_email: - description: Google服务账号email (gcp) - type: string - x-go-name: GCPClientEmail - gcp_private_key: - description: Google服务账号秘钥 (gcp) - type: string - x-go-name: GCPPrivateKey - gcp_private_key_id: - description: Google服务账号秘钥id (gcp) - type: string - x-go-name: GCPPrivateKeyId - gcp_project_id: - description: Google服务账号project id (gcp) - type: string - x-go-name: GCPProjectId - 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 - host: - description: 主机IP (esxi) - type: string - x-go-name: Host - 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 - options: - description: 额外信息,例如账单的access key - type: object - x-go-name: Options - organization_id: - description: 飞天允许的最高组织id, 默认为1 - format: int64 - type: integer - x-go-name: OrganizationId - password: - description: 密码 (openstack, zstack, esxi) - type: string - x-go-name: Password - port: - description: 主机端口 (esxi) - format: int64 - type: integer - x-go-name: Port - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - project_mapping_id: - type: string - x-go-name: ProjectMappingId - project_name: - description: 账号所在的项目 (openstack) - type: string - x-go-name: ProjectName - provider: - description: |- - 指定云平台 - Qcloud: 腾讯云 - Ctyun: 天翼云 - enum: - - VMware - - ' Aliyun' - - ' Qcloud' - - ' Azure' - - ' Aws' - - ' Huawei' - - ' OpenStack' - - ' Ucloud' - - ' ZStack' - - ' Google' - - ' Ctyun' - - ' JDcloud' - type: string - x-go-name: Provider - proxy_setting_id: - description: 代理配置 - type: string - x-go-name: ProxySettingId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - read_only: - type: boolean - x-go-name: ReadOnly - saml_auth: - default: false - description: 是否启用SAML认证 - type: boolean - x-go-name: SAMLAuth - secret_id: - description: 秘钥ID (Qcloud) - type: string - x-go-name: SecretId - secret_key: - description: 秘钥key (Qcloud) - type: string - x-go-name: SecretKey - show_sub_accounts: - description: 仅当show_sub_accounts=true并且dry_run=true时才返回sub accounts 信息, 且不会创建云账号 - type: boolean - x-go-name: ShowSubAccounts - start_sync: - description: 是否立即开始同步资源 - type: boolean - x-go-name: StartSync - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - username: - description: 用户名 (openstack, zstack, esxi) - type: string - x-go-name: Username - wire_level_for_vmware: - type: string - x-go-name: WireLevelForVmware - zone: - description: VMware 账号有zone属性 - type: string - x-go-name: Zone - required: - - name - - EndpointDomain - - DefaultRegion - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudaccountPerformPrepareNetsOutput: - properties: - hosts: - items: - $ref: '#/definitions/CAGuestNet' - type: array - x-go-name: Hosts - vswitchs: - items: - $ref: '#/definitions/VSwitch' - type: array - x-go-name: VSwitchs - wire_networks: - items: - $ref: '#/definitions/CAWireNet' - type: array - x-go-name: CAWireNets - wires: - description: Guests []CAGuestNet `json:"guests"` - items: - $ref: '#/definitions/CAPWire' - type: array - x-go-name: Wires - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudaccountPerformPublicInput: - properties: - scope: - description: 共享项目资源的共享范围，可能的值为：project, domain和system - pattern: project|domain|system - type: string - x-go-name: Scope - share_mode: - description: 共享模式，可能值为provider_domain, system - example: provider_domain - type: string - x-go-name: ShareMode - shared_domain_ids: - description: 如果共享范围为域，则在此列表中指定共享的目标域 - items: - type: string - type: array - x-go-name: SharedDomainIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudaccountProjectMappingInput: - properties: - auto_create_project: - type: boolean - x-go-name: AutoCreateProject - enable_project_sync: - type: boolean - x-go-name: EnableProjectSync - enable_resource_sync: - type: boolean - x-go-name: EnableResourceSync - project_id: - type: string - x-go-name: ProjectId - project_mapping_id: - description: |- - 同步策略Id, 若不传此参数则解绑 - 绑定同步策略要求当前云账号此刻未绑定其他同步策略 - type: string - x-go-name: ProjectMappingId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudaccountShareModeInput: - properties: - ShareMode: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudaccountSyncSkusInput: - properties: - Force: - type: boolean - Resource: - type: string - cloudprovider_id: - description: 列出关联指定云订阅(ID或Name)的资源 - type: string - x-go-name: CloudproviderId - cloudregion_id: - description: 区域名称或ID - type: string - x-go-name: CloudregionId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudaccountUpdateInput: - properties: - clean_lake_of_permissions: - description: 临时清除缺失的权限提示，云账号权限缺失依然会自动刷新 - type: boolean - x-go-name: CleanLakeOfPermissions - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - options: - description: 待更新的options key/value - type: object - x-go-name: Options - proxy_setting_id: - description: 代理配置 - type: string - x-go-name: ProxySettingId - read_only: - type: boolean - x-go-name: ReadOnly - remove_options: - description: 带删除的options key - items: - type: string - type: array - x-go-name: RemoveOptions - saml_auth: - type: boolean - x-go-name: SAMLAuth - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudproviderDetails: - properties: - LastSyncCost: - description: 上次同步耗时 - type: string - ProjectMapping: - type: string - access_url: - type: string - x-go-name: AccessUrl - account: - description: 云账号的用户信息，例如用户名，access key等 - type: string - x-go-name: Account - brand: - description: 子订阅品牌信息 - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - capabilities: - description: 支持服务列表 - items: - type: string - type: array - x-go-name: Capabilities - cloudaccount: - description: 云账号名称 - example: google-account - type: string - x-go-name: Cloudaccount - cloudaccount_id: - description: 归属云账号ID - type: string - x-go-name: CloudaccountId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - dbinstance_count: - description: 数据库实例数量 - example: 2 - format: int64 - type: integer - x-go-name: DBInstanceCount - 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 - eip_count: - description: 弹性公网IP数量 - example: 12 - format: int64 - type: integer - x-go-name: EipCount - elasticcache_count: - description: 弹性缓存实例数量 - example: 2 - format: int64 - type: integer - x-go-name: ElasticcacheCount - enable_project_sync: - type: boolean - x-go-name: EnableProjectSync - enable_resource_sync: - type: boolean - x-go-name: EnableResourceSync - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - guest_count: - description: 云主机数量 - example: 1 - format: int64 - type: integer - x-go-name: GuestCount - health_status: - description: |- - 云端服务健康状态。例如欠费、项目冻结都属于不健康状态。 - HealthStatus | 说明 | - ---------------|----------------------| - normal | 远端处于健康状态 | - insufficient | 不足按需资源余额 | - suspended | 远端处于冻结状态 | - arrears | 远端处于欠费状态 | - unknown | 未知状态，查询失败 | - no permission | 没有权限获取账单信息 | - type: string - x-go-name: HealthStatus - host_count: - description: 宿主机数量 - example: 2 - format: int64 - type: integer - x-go-name: HostCount - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - 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 - loadbalancer_count: - description: 负载均衡器数量 - example: 2 - format: int64 - type: integer - x-go-name: LoadbalancerCount - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_count: - description: 项目数量 - format: int64 - type: integer - x-go-name: ProjectCount - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_mapping_id: - type: string - x-go-name: ProjectMappingId - provider: - description: 云账号的平台信息 - type: string - x-go-name: Provider - proxy_setting: - $ref: '#/definitions/SProxySetting' - read_only: - type: boolean - x-go-name: ReadOnly - secret: - description: 云账号的密码信息，例如密码，access key secret等。该字段在数据库加密存储。Google需要存储秘钥证书,需要此字段比较长 - type: string - x-go-name: Secret - snapshot_count: - description: 快照数量 - example: 0 - format: int64 - type: integer - x-go-name: SnapshotCount - status: - description: 资源状态 - type: string - x-go-name: Status - storage_count: - description: 块存储梳理 - example: 4 - format: int64 - type: integer - x-go-name: StorageCount - storagecache_count: - description: 存储缓存数量 - example: 1 - format: int64 - type: integer - x-go-name: StorageCacheCount - sync_region_count: - description: 同步区域数量 - format: int64 - type: integer - x-go-name: SyncRegionCount - sync_status: - type: string - x-go-name: SyncStatus - sync_status2: - description: 子订阅同步状态 - type: string - x-go-name: SyncStatus2 - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - vpc_count: - description: 虚拟私有网络数量 - example: 4 - format: int64 - type: integer - x-go-name: VpcCount - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudproviderGetCannedAclOutput: - properties: - bucket_canned_acls: - description: Bucket支持的预置ACL列表 - items: - type: string - type: array - x-go-name: BucketCannedAcls - object_canned_acls: - description: Object支持的预置ACL列表 - items: - type: string - type: array - x-go-name: ObjectCannedAcls - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudproviderGetStorageClassOutput: - properties: - storage_classes: - description: 对象存储存储类型 - items: - type: string - type: array - x-go-name: StorageClasses - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudproviderSync: - properties: - cloudregion_ids: - description: 指定区域信息 - items: - type: string - type: array - x-go-name: CloudregionIds - enabled: - default: false - description: 指定区域启用或禁用同步 - type: boolean - x-go-name: Enabled - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudproviderUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudproviderregionDetails: - 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 - capabilities: - description: 支持服务列表 - items: - type: string - type: array - x-go-name: Capabilities - cloudaccount: - description: 云账号名称 - example: googl-account - type: string - x-go-name: Cloudaccount - cloudaccount_domain_id: - description: 云账号所在域Id - example: 0df40413-eb69-49c7-895e-618ddeb80f55 - type: string - x-go-name: CloudaccountDomainId - cloudaccount_id: - description: 云账号Id - example: fa4aaf88-aed8-422d-84e7-56dea533b364 - type: string - x-go-name: CloudaccountId - cloudprovider: - type: string - x-go-name: Cloudprovider - cloudprovider_sync_status: - description: 云订阅同步状态 - type: string - x-go-name: CloudproviderSyncStatus - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - last_sync_cost: - description: 上次同步耗时 - type: string - x-go-name: LastSyncCost - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudregionDetails: - properties: - City: - description: 城市 - example: Guiyang - type: string - CountryCode: - description: 国家代码 - example: CN - type: string - Latitude: - description: 纬度 - example: 26.647003 - format: float - type: number - Longitude: - description: 经度 - example: 106.630211 - format: float - type: number - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云类型, public, private or onpremise - example: public - type: string - x-go-name: CloudEnv - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - environment: - description: 云环境 - example: ChinaCloud - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - guest_count: - description: 云主机梳理 - example: 2 - format: int64 - type: integer - x-go-name: GuestCount - guest_increment_count: - description: 距离前天0点新增云主机数量 - example: 0 - format: int64 - type: integer - x-go-name: GuestIncrementCount - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - network_count: - description: IP子网数量 - example: 12 - format: int64 - type: integer - x-go-name: NetworkCount - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台 - example: Huawei - type: string - x-go-name: Provider - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vpc_count: - description: 虚拟私有网络数量 - example: 2 - format: int64 - type: integer - x-go-name: VpcCount - zone_count: - description: 可用区数量 - example: 3 - format: int64 - type: integer - x-go-name: ZoneCount - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CloudregionSkuSyncInput: - properties: - cloudregion_ids: - description: 区域ID - items: - type: string - type: array - x-go-name: CloudregionIds - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - resource: - description: |- - 同步资源类型 - choices: serversku|elasticcachesku|dbinstance_sku - type: string - x-go-name: Resource - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ConvertEsxiToKvmInput: - properties: - prefer_host: - description: 指定转换的宿主机 - type: string - x-go-name: PreferHost - target_hypervisor: - description: target hypervisor - type: string - x-go-name: TargetHypervisor - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CycleTimerCreateInput: - properties: - cycle_type: - description: 'description: 周期类型' - enum: - - day - - week - - month - type: string - x-go-name: CycleType - end_time: - description: 'description: 截止时间' - format: date-time - type: string - x-go-name: EndTime - hour: - description: 'description: 时(0-23)' - example: 13 - format: int64 - type: integer - x-go-name: Hour - minute: - description: 'description: 分(0-59)' - example: 13 - format: int64 - type: integer - x-go-name: Minute - month_days: - description: 'description: 每月的哪几天; 1-31' - example: - - 1 - - 4 - - 31 - items: - format: int64 - type: integer - type: array - x-go-name: MonthDays - start_time: - description: 'description: 开始时间' - format: date-time - type: string - x-go-name: StartTime - week_days: - description: 'description: 每周的周几; 1-7, 1: Monday, 7: Sunday' - example: - - 1 - - 3 - - 5 - - 7 - items: - format: int64 - type: integer - type: array - x-go-name: WeekDays - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - CycleTimerDetails: - properties: - cycle_type: - description: 'description: 周期类型：按天/周/月' - type: string - x-go-name: CycleType - end_time: - description: 'description: 此周期任务的截止时间' - format: date-time - type: string - x-go-name: EndTime - hour: - description: 'description: 小时' - format: int64 - type: integer - x-go-name: Hour - minute: - description: 'description: 分钟' - format: int64 - type: integer - x-go-name: Minute - month_days: - description: 'description: 每月的几天' - items: - format: int64 - type: integer - type: array - x-go-name: MonthDays - start_time: - description: 'description: 此周期任务的开始时间' - format: date-time - type: string - x-go-name: StartTime - week_days: - description: 'description: 每周的几天' - items: - format: int64 - type: integer - type: array - x-go-name: WeekDays - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceAccountCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - dbinstance: - description: |- - rds实例名称或Id,建议使用Id - - - - 平台 |支持Rds引擎 | - ---- |------- | - Aliyun |MySQL, MariaBD, SQLServer | - 华为云 |MySQL, MariaBD | - 腾讯云 |MySQL | - type: string - x-go-name: DBInstance - 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 - password: - description: 账号密码，若不指定,则会随机生成 - type: string - x-go-name: Password - privileges: - description: 账号权限 - items: - $ref: '#/definitions/SDBInstanceAccountPrivilege' - type: array - x-go-name: Privileges - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - - dbinstance - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceAccountDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - dbinstance: - description: RDS实例名称 - type: string - x-go-name: DBInstance - dbinstance_id: - type: string - x-go-name: DBInstanceId - dbinstanceprivileges: - description: 账号权限列表 - items: - $ref: '#/definitions/DBInstancePrivilege' - type: array - x-go-name: DBInstanceprivileges - 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 - environment: - description: Environment - type: string - x-go-name: Environment - host: - type: string - x-go-name: Host - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - secret: - description: 数据库密码 - type: string - x-go-name: Secret - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceAccountUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceAutoRenewInput: - properties: - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceBackupCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - databases: - description: 需要备份的Rds数据库列表 - items: - type: string - type: array - x-go-name: Databases - dbinstance: - description: Rds实例名称或Id, 建议使用Id - type: string - x-go-name: DBInstance - 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - - dbinstance - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceBackupDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - backup_method: - description: 备份方式 Logical|Physical - type: string - x-go-name: BackupMethod - backup_mode: - description: 备份模式 - type: string - x-go-name: BackupMode - backup_size_mb: - description: 备份大小 - example: 32 - format: int64 - type: integer - x-go-name: BackupSizeMb - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - db_names: - description: 备份数据库名称 - type: string - x-go-name: DBNames - dbinstance: - description: RDS实例名称 - type: string - x-go-name: DBInstance - dbinstance_id: - type: string - x-go-name: DBInstanceId - 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 - end_time: - description: 备份结束时间 - format: date-time - type: string - x-go-name: EndTime - engine: - description: RDS引擎 - example: MySQL - type: string - x-go-name: Engine - engine_version: - description: RDS引擎版本 - example: "5.7" - type: string - x-go-name: EngineVersion - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - start_time: - description: 备份开始时间 - format: date-time - type: string - x-go-name: StartTime - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - DBInstanceCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - BillingType: - description: 计费方式 - enum: - - postpaid - - ' prepaid' - type: string - address: - description: Ip子网内的地址,不填则按照ip子网的地址分配策略分配一个ip - type: string - x-go-name: Address - auto_renew: - default: false - description: 是否自动续费(仅包年包月时生效) - type: boolean - x-go-name: AutoRenew - category: - description: |- - rds类型 - - - - 平台 | 支持类型 | 说明 | - ----- | ------ | --- | - 华为云 |ha, single, replica| ha: 高可用, single: 单机, replica: 只读| - 阿里云 |basic, high_availability, always_on, finance|basic: 基础版, high_availability: 高可用, always_on: 集群版, finance: 金融版, 三节点| - Google |Zonal, Regional | Zonal: 单区域, Regional: 区域级| - 腾讯云 |fe, ha, basic | ha: 高可用, basic: 基础版, fe: 金融版| - type: string - x-go-name: Category - dbinstancebackup_id: - description: 从备份中创建新实例 - type: string - x-go-name: DBInstancebackupId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disable_delete: - default: true - description: 删除保护,创建的资源默认不允许删除 - type: boolean - x-go-name: DisableDelete - disk_size_gb: - description: |- - rds存储大小 - 可参考rds套餐的大小范围和步长情况 - format: int64 - type: integer - x-go-name: DiskSizeGB - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - duration: - description: 包年包月时间周期 - type: string - x-go-name: Duration - engine: - description: rds引擎 - enum: - - MySQL - - ' SQLServer' - - ' PostgreSQL' - - ' MariaDB' - - ' Oracle' - - ' PPAS' - type: string - x-go-name: Engine - engine_version: - description: |- - rds引擎版本 - 根据各个引擎版本各不相同 - type: string - x-go-name: EngineVersion - 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 - instance_type: - description: |- - 套餐名称, 若此参数不填, 则必须有vmem_size_mb及vcpu_count参数 - 套餐列表可以通过 dbinstancesku 获取 - type: string - x-go-name: InstanceType - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - master_instance: - description: |- - rds实例名称或Id,建议使用Id - 创建只读实例时此参数必传 - type: string - x-go-name: MasterInstance - multi_az: - description: 多可用区部署 - type: boolean - x-go-name: MultiAZ - 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 - network_id: - description: |- - Ip子网名称或Id,建议使用Id - 谷歌云并不实际使用Ip子网,仅仅通过Ip子网确定Vpc - type: string - x-go-name: NetworkId - password: - description: |- - rds初始化密码 - 阿里云不需要此参数 - 华为云会默认创建一个用户,若不传此参数, 则为随机密码 - 谷歌云会默认创建一个用户,若不传此参数, 则为随机密码 - 腾讯云会默认创建一个用户,若不传此参数, 则为随机密码 - type: string - x-go-name: Password - port: - description: 指定连接端口 - format: int64 - type: integer - x-go-name: Port - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - reset_password: - description: |- - 是否不设置初始密码 - 华为云不支持此参数 - 谷歌云仅mysql支持此参数 - type: boolean - x-go-name: ResetPassword - secgroup_ids: - description: |- - 安全组Id列表 - - - 云平台 | 最大支出安全组数量 | - -------------|---------- | - 腾讯云 | 5 | - 华为云 | 1 | - 阿里云 | 不支持 | - items: - type: string - type: array - x-go-name: SecgroupIds - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - storage_type: - description: |- - rds存储类型 - - - - 平台 | 支持类型 | 说明 | - ----- | ------ | --- | - 华为云 |SSD, SAS, SATA| | - 阿里云 |local_ssd, cloud_essd, cloud_ssd| | - Google |PD_SSD, PD_HDD| PD_SSD: SSD, PD_HDD: HDD| - 腾讯云 |cloud_ssd, local_ssd| | - type: string - x-go-name: StorageType - vcpu_count: - description: |- - rds实例cpu大小 - 若指定实例套餐，此参数将根据套餐设置 - format: int64 - type: integer - x-go-name: VcpuCount - vmem_size_mb: - description: |- - rds实例内存大小 - 若指定实例套餐，此参数将根据套餐设置 - format: int64 - type: integer - x-go-name: VmemSizeMb - zone1: - description: 主可用区名称或Id, 此参数从指定的套餐所在的可用区获取 - type: string - x-go-name: Zone1 - zone2: - description: 次可用区名称或Id, 此参数从指定的套餐所在的可用区获取 - type: string - x-go-name: Zone2 - zone3: - description: 三节点可用区名称或Id,, 此参数从指定的套餐所在的可用区获取 - type: string - x-go-name: Zone3 - required: - - name - - network_id - - engine - - engine_version - - category - - storage_type - - disk_size_gb - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceDatabaseCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - accounts: - description: 赋予账号权限 - items: - $ref: '#/definitions/SDBInstanceDatabasePrivilege' - type: array - x-go-name: Accounts - character_set: - description: 数据库字符集 - type: string - x-go-name: CharacterSet - dbinstance: - description: |- - rds实例名称或Id,建议使用Id - - - - 平台 |支持Rds引擎 | - ---- |------- | - Aliyun |MySQL, MariaBD, SQLServer | - 华为云 |MySQL, MariaBD | - 腾讯云 | | - type: string - x-go-name: DBInstance - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - - dbinstance - - character_set - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceDatabaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - category: - description: 实例类型 - example: ha - type: string - x-go-name: Category - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - connection_str: - description: 外部连接地址 - type: string - x-go-name: ConnectionStr - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - databases: - items: - $ref: '#/definitions/IdNameDetails' - type: array - x-go-name: Databases - dbinstancebackup_id: - description: 从备份创建新实例 - type: string - x-go-name: DBInstancebackupId - 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 - disable_delete: - description: 是否开启删除保护 - example: true - type: boolean - x-go-name: DisableDelete - disk_size_gb: - description: 存储大小 - example: 10240 - format: int64 - type: integer - x-go-name: DiskSizeGB - disk_size_used_mb: - description: 已使用的存储大小 - format: int64 - type: integer - x-go-name: DiskSizeUsedMB - domain_id: - description: 域Id - type: string - x-go-name: DomainId - engine: - description: 引擎 - example: MySQL - type: string - x-go-name: Engine - engine_version: - description: 引擎版本 - example: "5.7" - type: string - x-go-name: EngineVersion - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - instance_type: - description: 套餐名称 - example: mysql.x4.large.2c - type: string - x-go-name: InstanceType - internal_connection_str: - description: 内部连接地址 - type: string - x-go-name: InternalConnectionStr - iops: - description: iops - example: 0 - format: int64 - type: integer - x-go-name: Iops - ip_addrs: - description: 内网IP地址, 若有多个以 ',' 分隔 - type: string - x-go-name: IpAddrs - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - maintain_time: - description: 维护时间 - type: string - x-go-name: MaintainTime - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - master_instance_id: - description: 主实例Id - type: string - x-go-name: MasterInstanceId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - network: - description: IP子网名称, 若有多个以 ',' 分隔 - example: test-network - type: string - x-go-name: Network - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - port: - description: 端口 - example: 3306 - format: int64 - type: integer - x-go-name: Port - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - secgroup: - description: 安全组名称 - example: Default - type: string - x-go-name: Secgroup - secgroups: - items: - $ref: '#/definitions/StandaloneShortDesc' - type: array - x-go-name: Secgroups - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - storage_type: - description: 存储类型 - example: local_ssd - type: string - x-go-name: StorageType - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - vcpu_count: - description: CPU数量 - example: 1 - format: int64 - type: integer - x-go-name: VcpuCount - vmem_size_mb: - description: 内存大小 - example: 1024 - format: int64 - type: integer - x-go-name: VmemSizeMb - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 虚拟私有网络Id - example: ed20d84e-3158-41b1-870c-1725e412e8b6 - type: string - x-go-name: VpcId - zone1: - description: 可用区1 - type: string - x-go-name: Zone1 - zone1_name: - description: Zone1名称 - type: string - x-go-name: Zone1Name - zone2: - description: 可用区2 - type: string - x-go-name: Zone2 - zone2_name: - description: Zone2名称 - type: string - x-go-name: Zone2Name - zone3: - description: 可用区3 - type: string - x-go-name: Zone3 - zone3_name: - description: Zone3名称 - type: string - x-go-name: Zone3Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstancePrivilege: - properties: - account: - description: 账号名称 - type: string - x-go-name: Account - database: - description: 数据库名称 - type: string - x-go-name: Database - dbinstancedatabase_id: - description: 数据库Id - type: string - x-go-name: DBInstancedatabaseId - privileges: - description: 权限 - type: string - x-go-name: Privileges - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceRemoteUpdateInput: - properties: - replace_tags: - description: 是否覆盖替换所有标签 - type: boolean - x-go-name: ReplaceTags - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceSecgroupDetails: - 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 - dbinstance: - description: RDS名称 - type: string - x-go-name: DBInstance - delete_fail_reason: - $ref: '#/definitions/Error' - secgroup: - description: 安全组名称 - type: string - x-go-name: Secgroup - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceSetSecgroupInput: - properties: - secgroup_ids: - items: - type: string - type: array - x-go-name: SecgroupIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceSkuDetails: - 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 - category: - type: string - x-go-name: Category - cloud_env: - description: 云环境 - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - disk_size_step: - format: int64 - type: integer - x-go-name: DiskSizeStep - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - engine: - type: string - x-go-name: Engine - engine_version: - type: string - x-go-name: EngineVersion - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - iops: - format: int64 - type: integer - x-go-name: IOPS - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - max_connections: - format: int64 - type: integer - x-go-name: MaxConnections - max_disk_size_gb: - description: 步长 - format: int64 - type: integer - x-go-name: MaxDiskSizeGb - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - min_disk_size_gb: - format: int64 - type: integer - x-go-name: MinDiskSizeGb - multi_az: - type: boolean - x-go-name: MultiAZ - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - type: string - x-go-name: Provider - qps: - format: int64 - type: integer - x-go-name: QPS - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - storage_type: - type: string - x-go-name: StorageType - tps: - format: int64 - type: integer - x-go-name: TPS - 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 - vcpu_count: - format: int64 - type: integer - x-go-name: VcpuCount - vmem_size_mb: - format: int64 - type: integer - x-go-name: VmemSizeMb - zone_id: - type: string - x-go-name: ZoneId - zone1: - type: string - x-go-name: Zone1 - zone1_name: - type: string - x-go-name: Zone1Name - zone2: - type: string - x-go-name: Zone2 - zone2_name: - type: string - x-go-name: Zone2Name - zone3: - type: string - x-go-name: Zone3 - zone3_name: - type: string - x-go-name: Zone3Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstancedatabaseDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - character_set: - description: 字符集 - example: utf-8 - type: string - x-go-name: CharacterSet - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - dbinstance: - description: RDS实例名称 - type: string - x-go-name: DBInstance - dbinstance_id: - type: string - x-go-name: DBInstanceId - dbinstanceprivileges: - description: 数据库权限 - items: - $ref: '#/definitions/DBInstancePrivilege' - type: array - x-go-name: DBInstanceprivileges - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DBInstanceparameterDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - dbinstance: - description: RDS实例名称 - type: string - x-go-name: DBInstance - dbinstance_id: - type: string - x-go-name: DBInstanceId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - key: - description: 数据库参数名称 - type: string - x-go-name: Key - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - 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 - value: - description: 数据库参数值 - type: string - x-go-name: Value - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DefaultAction: - description: +onecloud:model-api-gen - properties: - Action: - $ref: '#/definitions/TWafAction' - InsertHeaders: - additionalProperties: - type: string - description: 仅Action为Allow时生效 - type: object - Response: - description: 仅Action为Block时生效 - type: string - ResponseCode: - description: 仅Action为Block时生效 - format: int64 - type: integer - ResponseHeaders: - additionalProperties: - type: string - description: 仅Action为Block时生效 - type: object - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - DeployConfig: - properties: - action: - type: string - x-go-name: Action - content: - type: string - x-go-name: Content - path: - type: string - x-go-name: Path - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskBackupCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - back_storage_id: - description: 'description: backup storage id' - type: string - x-go-name: BackupStorageId - cloudregion_id: - description: 'swagger: ignore' - type: string - x-go-name: CloudregionId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disk_id: - description: 'description: disk id' - type: string - x-go-name: DiskId - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - encrypt_key_alg: - description: 新建密钥算法 - type: string - x-go-name: EncryptKeyAlg - encrypt_key_id: - description: 加密密钥的ID - type: string - x-go-name: EncryptKeyId - encrypt_key_new: - description: 是否新建密钥 - type: boolean - x-go-name: EncryptKeyNew - encrypt_key_user_id: - description: 加密密钥的用户ID - type: string - x-go-name: EncryptKeyUserId - 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskBackupDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - backup_storage_name: - description: 'description: backup storage name' - type: string - x-go-name: BackupStorageName - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - disk_name: - description: 'description: disk name' - type: string - x-go-name: DiskName - encrypt_alg: - description: 加密算法，aes-256 or sm4 - type: string - x-go-name: EncryptAlg - encrypt_key: - description: 秘钥名称 - type: string - x-go-name: EncryptKey - encrypt_key_user: - description: 密钥用户 - type: string - x-go-name: EncryptKeyUser - encrypt_key_user_domain: - description: 密钥用户域 - type: string - x-go-name: EncryptKeyUserDomain - encrypt_key_user_domain_id: - description: 密钥用户域ID - type: string - x-go-name: EncryptKeyUserDomainId - encrypt_key_user_id: - description: 密钥用户ID - type: string - x-go-name: EncryptKeyUserId - environment: - description: Environment - type: string - x-go-name: Environment - is_sub_backup: - description: 'description: 是否是子备份' - type: boolean - x-go-name: IsSubBackup - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskBackupRecoveryInput: - properties: - Name: - description: 'description: name of disk' - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskBackupSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskConfig: - properties: - backend: - description: |- - 后端存储类型,若指定了存储ID,此参数会根据存储设置,若不指定，则作为调度的一个参考 - - - - 平台 | 存储类型 | 中文 | 数据盘 | 系统盘 | 可否扩容 | 可否单独创建 | 扩容步长 | 说明 | - ---- | ---- | ---- | ----- | ----- | ------- | ----------- | ------- | ----- | - Esxi |local |本地盘 |1-500GB |30~500GB | 是 | 否 | 1G | | - Esxi |nas |NAS盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | - Esxi |vsan |VSAN盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | - KVM |local |本地盘盘 |1-500GB |30~500GB | 是 | 否 | 1G | | - KVM |rbd |云硬盘 |1-3072GB |30~500GB | 是 | 是 | 1G | | - Azure |standard_lrs |标准 HDD |1-4095GB |30~4095GB | 是 | 是 | 1G | | - Azure |standardssd_lrs |标准 SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | - Azure |premium_lrs |高级SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | - AWS |gp2 |通用型SSD |1-16384GB |20~16384GB | 是 | 是 | 1G | | - AWS |io1 |预配置 IOPS SSD |4-16384GB |20-16384GB | 是 | 是 | 1G | | - AWS |st1 |吞吐优化HDD |500-16384GB |不支持 | 是 | 是 | 1G | | - AWS |sc1 |Cold HDD |500-16384GB |不支持 | 是 | 是 | 1G | | - AWS |standard |磁介质 |1-1024GB |20-1024GB | 是 | 是 | 1G | | - 腾讯云 |cloud_ssd |SSD云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | - 腾讯云 |cloud_basic |普通云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | - 腾讯云 |cloud_preium |高性能云硬盘 |10-16000GB |50~1024GB | 是 | 是 | 10G | | - 腾讯云 |local_basic |普通本地盘 |10-1600GB |不支持 | 否 | 否 | | | - 腾讯云 |local_ssd |SSD本地盘 |10-7000GB |部分区域套餐支持 | 否 | 否 | | | - 腾讯云 |local_pro |HDD本地盘 |跟随套餐 |部分区域套餐支持 | 否 | 否 | | | - 华为云或天翼云 |SSD |超高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | - 华为云或天翼云 |SAS |高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | - 华为云或天翼云 |SATA |普通IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | - OpenStack |nova |nova |不支持 |30-500GB | 否 | 否 | | | - OpenStack |自定义 |... |无限制 |无限制 | 是 | 是 | 1G | | - Ucloud |CLOUD_NORMAL |普通云盘 |20-8000GB |不支持 | 是 | 是 | 1G | | - Ucloud |CLOUD_SSD |SSD云盘 |20-4000GB |20-500GB | 是 | 是 | 1G | | - Ucloud |LOCAL_NORMAL |普通本地盘 | | | 是 | 是 | 1G | | - Ucloud |LOCAL_SSD |SSD本地盘 | | | 是 | 是 | 1G | | - Ucloud |EXCLUSIVE_LOCAL_DISK |独享本地盘 | | | 是 | 是 | 1G | | - ZStack |localstorage |本地盘 | | | 是 | 是 | 1G | | - ZStack |ceph |云硬盘 | | | 是 | 是 | 1G | | - Google |local-ssd |本地SSD暂存盘 |375GB |不支持 | 否 | 否 | | 跟随实例创建，一次最多添加8个 | - Google |pd-standard |标准永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | - Google |pd-ssd |SSD永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | - type: string - x-go-name: Backend - backup_id: - type: string - x-go-name: BackupId - boot_index: - format: int8 - type: integer - x-go-name: BootIndex - cache: - description: 磁盘缓存模式 - enum: - - writeback - - ' none' - - ' writethrough' - type: string - x-go-name: Cache - disk_type: - description: 磁盘类型 - enum: - - sys - - ' data' - - ' swap' - type: string - x-go-name: DiskType - driver: - description: 磁盘驱动方式 - enum: - - virtio - - ' ide' - - ' scsi' - - ' sata' - - ' pvscsi' - type: string - x-go-name: Driver - format: - description: 磁盘存储格式 - enum: - - qcow2 - - ' raw' - - ' docker' - - ' iso' - - ' vmdk' - - ' vmdkflatver1' - - ' vmdkflatver2' - - ' vmdkflat' - - ' vmdksparse' - - ' vmdksparsever1' - - ' vmdksparsever2' - - ' vmdksepsparse vhd' - type: string - x-go-name: Format - fs: - description: 文件系统,仅kvm支持自动格式化磁盘,私有云和公有云此参数不会生效 - enum: - - swap - - ' ext2' - - ' ext3' - - ' ext4' - - ' xfs' - - ' ntfs' - - ' fat' - - ' hfsplus' - type: string - x-go-name: Fs - image_encrypt_key_id: - description: 镜像加密key ID - type: string - x-go-name: ImageEncryptKeyId - image_id: - description: 镜像ID,通过镜像创建磁盘,创建虚拟机时第一块磁盘需要指定此参数 - type: string - x-go-name: ImageId - index: - default: -1 - description: 挂载到虚拟机的磁盘顺序, -1代表不挂载任何虚拟机 - format: int64 - type: integer - x-go-name: Index - medium: - default: hybird - description: |- - 介质类型 - rotate: 机械盘 - ssd: 固态硬盘 - hybird: 混合盘 - emum: [rotate, ssd, hybrid] - type: string - x-go-name: Medium - mountpoint: - description: |- - 挂载点,必须以 '/' 开头,例如 /opt 仅KVM此参数有效 - requried: false - type: string - x-go-name: Mountpoint - nvme_device: - $ref: '#/definitions/IsolatedDeviceConfig' - os_arch: - description: 操作系统CPU架构 - type: string - x-go-name: OsArch - schedtags: - items: - $ref: '#/definitions/SchedtagConfig' - type: array - x-go-name: Schedtags - size: - description: |- - 磁盘大小,单位Mb - 若创建裸金属服务器是, -1代表自动向后扩展存储 - requried:true - format: int64 - type: integer - x-go-name: SizeMb - snapshot_id: - description: 快照ID,通过快照创建磁盘,此参数必须加上 'snapshot-' 前缀 - example: snapshot-3140cecb-ccc4-4865-abae-3a5ba8c69d9b - type: string - x-go-name: SnapshotId - storage_id: - description: |- - 存储ID, 指定存储后，磁盘会在此存储上创建 - 存储列表可以参数 storage 列表API - type: string - x-go-name: Storage - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - backend: - description: |- - 后端存储类型,若指定了存储ID,此参数会根据存储设置,若不指定，则作为调度的一个参考 - - - - 平台 | 存储类型 | 中文 | 数据盘 | 系统盘 | 可否扩容 | 可否单独创建 | 扩容步长 | 说明 | - ---- | ---- | ---- | ----- | ----- | ------- | ----------- | ------- | ----- | - Esxi |local |本地盘 |1-500GB |30~500GB | 是 | 否 | 1G | | - Esxi |nas |NAS盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | - Esxi |vsan |VSAN盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | - KVM |local |本地盘盘 |1-500GB |30~500GB | 是 | 否 | 1G | | - KVM |rbd |云硬盘 |1-3072GB |30~500GB | 是 | 是 | 1G | | - Azure |standard_lrs |标准 HDD |1-4095GB |30~4095GB | 是 | 是 | 1G | | - Azure |standardssd_lrs |标准 SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | - Azure |premium_lrs |高级SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | - AWS |gp2 |通用型SSD |1-16384GB |20~16384GB | 是 | 是 | 1G | | - AWS |io1 |预配置 IOPS SSD |4-16384GB |20-16384GB | 是 | 是 | 1G | | - AWS |st1 |吞吐优化HDD |500-16384GB |不支持 | 是 | 是 | 1G | | - AWS |sc1 |Cold HDD |500-16384GB |不支持 | 是 | 是 | 1G | | - AWS |standard |磁介质 |1-1024GB |20-1024GB | 是 | 是 | 1G | | - 腾讯云 |cloud_ssd |SSD云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | - 腾讯云 |cloud_basic |普通云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | - 腾讯云 |cloud_preium |高性能云硬盘 |10-16000GB |50~1024GB | 是 | 是 | 10G | | - 腾讯云 |local_basic |普通本地盘 |10-1600GB |不支持 | 否 | 否 | | | - 腾讯云 |local_ssd |SSD本地盘 |10-7000GB |部分区域套餐支持 | 否 | 否 | | | - 腾讯云 |local_pro |HDD本地盘 |跟随套餐 |部分区域套餐支持 | 否 | 否 | | | - 华为云或天翼云 |SSD |超高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | - 华为云或天翼云 |SAS |高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | - 华为云或天翼云 |SATA |普通IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | - OpenStack |nova |nova |不支持 |30-500GB | 否 | 否 | | | - OpenStack |自定义 |... |无限制 |无限制 | 是 | 是 | 1G | | - Ucloud |CLOUD_NORMAL |普通云盘 |20-8000GB |不支持 | 是 | 是 | 1G | | - Ucloud |CLOUD_SSD |SSD云盘 |20-4000GB |20-500GB | 是 | 是 | 1G | | - Ucloud |LOCAL_NORMAL |普通本地盘 | | | 是 | 是 | 1G | | - Ucloud |LOCAL_SSD |SSD本地盘 | | | 是 | 是 | 1G | | - Ucloud |EXCLUSIVE_LOCAL_DISK |独享本地盘 | | | 是 | 是 | 1G | | - ZStack |localstorage |本地盘 | | | 是 | 是 | 1G | | - ZStack |ceph |云硬盘 | | | 是 | 是 | 1G | | - Google |local-ssd |本地SSD暂存盘 |375GB |不支持 | 否 | 否 | | 跟随实例创建，一次最多添加8个 | - Google |pd-standard |标准永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | - Google |pd-ssd |SSD永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | - type: string - x-go-name: Backend - backup_id: - type: string - x-go-name: BackupId - boot_index: - format: int8 - type: integer - x-go-name: BootIndex - cache: - description: 磁盘缓存模式 - enum: - - writeback - - ' none' - - ' writethrough' - type: string - x-go-name: Cache - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disk_type: - description: 磁盘类型 - enum: - - sys - - ' data' - - ' swap' - type: string - x-go-name: DiskType - driver: - description: 磁盘驱动方式 - enum: - - virtio - - ' ide' - - ' scsi' - - ' sata' - - ' pvscsi' - type: string - x-go-name: Driver - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - encrypt_key_alg: - description: 新建密钥算法 - type: string - x-go-name: EncryptKeyAlg - encrypt_key_id: - description: 加密密钥的ID - type: string - x-go-name: EncryptKeyId - encrypt_key_new: - description: 是否新建密钥 - type: boolean - x-go-name: EncryptKeyNew - encrypt_key_user_id: - description: 加密密钥的用户ID - type: string - x-go-name: EncryptKeyUserId - format: - description: 磁盘存储格式 - enum: - - qcow2 - - ' raw' - - ' docker' - - ' iso' - - ' vmdk' - - ' vmdkflatver1' - - ' vmdkflatver2' - - ' vmdkflat' - - ' vmdksparse' - - ' vmdksparsever1' - - ' vmdksparsever2' - - ' vmdksepsparse vhd' - type: string - x-go-name: Format - fs: - description: 文件系统,仅kvm支持自动格式化磁盘,私有云和公有云此参数不会生效 - enum: - - swap - - ' ext2' - - ' ext3' - - ' ext4' - - ' xfs' - - ' ntfs' - - ' fat' - - ' hfsplus' - type: string - x-go-name: Fs - 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 - hypervisor: - default: kvm - description: 此参数仅适用于未指定storage时进行调度到指定平台创建磁盘 - enum: - - kvm - - ' openstack' - - ' esxi' - - ' aliyun' - - ' aws' - - ' qcloud' - - ' azure' - - ' huawei' - - ' openstack' - - ' ucloud' - - ' zstack google' - - ' ctyun' - type: string - x-go-name: Hypervisor - image_encrypt_key_id: - description: 镜像加密key ID - type: string - x-go-name: ImageEncryptKeyId - image_id: - description: 镜像ID,通过镜像创建磁盘,创建虚拟机时第一块磁盘需要指定此参数 - type: string - x-go-name: ImageId - index: - default: -1 - description: 挂载到虚拟机的磁盘顺序, -1代表不挂载任何虚拟机 - format: int64 - type: integer - x-go-name: Index - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - medium: - default: hybird - description: |- - 介质类型 - rotate: 机械盘 - ssd: 固态硬盘 - hybird: 混合盘 - emum: [rotate, ssd, hybrid] - type: string - x-go-name: Medium - mountpoint: - description: |- - 挂载点,必须以 '/' 开头,例如 /opt 仅KVM此参数有效 - requried: false - type: string - x-go-name: Mountpoint - 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 - nvme_device: - $ref: '#/definitions/IsolatedDeviceConfig' - os_arch: - description: 操作系统CPU架构 - type: string - x-go-name: OsArch - prefer_host_id: - description: 此参数仅适用于未指定storage时进行调度到指定可用区区创建磁盘 - type: string - x-go-name: PreferHost - prefer_manager_id: - description: 调度使用指定的云账号 - type: string - x-go-name: PreferManager - prefer_region_id: - description: 此参数仅适用于未指定storage时进行调度到指定区域创建磁盘 - type: string - x-go-name: PreferRegion - prefer_zone_id: - description: 此参数仅适用于未指定storage时进行调度到指定可用区区创建磁盘 - type: string - x-go-name: PreferZone - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - schedtags: - items: - $ref: '#/definitions/SchedtagConfig' - type: array - x-go-name: Schedtags - size: - description: |- - 磁盘大小,单位Mb - 若创建裸金属服务器是, -1代表自动向后扩展存储 - requried:true - format: int64 - type: integer - x-go-name: SizeMb - snapshot_id: - description: 快照ID,通过快照创建磁盘,此参数必须加上 'snapshot-' 前缀 - example: snapshot-3140cecb-ccc4-4865-abae-3a5ba8c69d9b - type: string - x-go-name: SnapshotId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - storage_id: - description: |- - 存储ID, 指定存储后，磁盘会在此存储上创建 - 存储列表可以参数 storage 列表API - type: string - x-go-name: Storage - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskDetails: - properties: - access_path: - description: 磁盘路径 - type: string - x-go-name: AccessPath - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - auto_delete: - description: 是否跟随资源自动删除 - example: false - type: boolean - x-go-name: AutoDelete - auto_delete_at: - description: 自动清理时间 - format: date-time - type: string - x-go-name: AutoDeleteAt - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - backup_id: - description: 备份Id - type: string - x-go-name: BackupId - backup_storage_id: - description: 备份磁盘实例的存储ID - type: string - x-go-name: BackupStorageId - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - 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 - disk_format: - description: 磁盘存储类型 - example: qcow2 - type: string - x-go-name: DiskFormat - disk_size: - description: 磁盘大小, 单位Mb - example: 10240 - format: int64 - type: integer - x-go-name: DiskSize - disk_type: - description: |- - 磁盘类型 - sys: 系统盘 - data: 数据盘 - swap: 交换盘 - example: sys - type: string - x-go-name: DiskType - domain_id: - description: 域Id - type: string - x-go-name: DomainId - encrypt_alg: - description: 加密算法，aes-256 or sm4 - type: string - x-go-name: EncryptAlg - encrypt_key: - description: 秘钥名称 - type: string - x-go-name: EncryptKey - encrypt_key_id: - description: 加密密钥ID - type: string - x-go-name: EncryptKeyId - encrypt_key_user: - description: 密钥用户 - type: string - x-go-name: EncryptKeyUser - encrypt_key_user_domain: - description: 密钥用户域 - type: string - x-go-name: EncryptKeyUserDomain - encrypt_key_user_domain_id: - description: 密钥用户域ID - type: string - x-go-name: EncryptKeyUserDomainId - encrypt_key_user_id: - description: 密钥用户ID - type: string - x-go-name: EncryptKeyUserId - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - fs_format: - description: 文件系统 - type: string - x-go-name: FsFormat - guest: - description: 所挂载的虚拟机 - type: string - x-go-name: Guest - guest_count: - description: 所挂载虚拟机的数量 - format: int64 - type: integer - x-go-name: GuestCount - guest_status: - description: 所挂载虚拟机状态 - type: string - x-go-name: GuestStatus - guests: - description: 所挂载的虚拟机 - items: - $ref: '#/definitions/SimpleGuest' - type: array - x-go-name: Guests - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - iops: - description: 最大连接数 - format: int64 - type: integer - x-go-name: Iops - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_ssd: - description: 是否标记为SSD磁盘 - type: boolean - x-go-name: IsSsd - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - manual_snapshot_count: - description: 手动快照数量 - format: int64 - type: integer - x-go-name: ManualSnapshotCount - max_manual_snapshot_count: - description: 最多可创建手动快照数量 - format: int64 - type: integer - x-go-name: MaxManualSnapshotCount - medium_type: - description: 存储介质类型 - type: string - x-go-name: MediumType - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - nonpersistent: - description: '# is persistent' - type: boolean - x-go-name: Nonpersistent - os_arch: - description: 操作系统 CPU 架构 - example: x86 arm - type: string - x-go-name: OsArch - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - snapshot_id: - description: 快照Id - type: string - x-go-name: SnapshotId - snapshotpolicies: - description: 自动快照策略 - items: - $ref: '#/definitions/SimpleSnapshotPolicy' - type: array - x-go-name: Snapshotpolicies - snapshotpolicy_status: - description: 自动快照策略状态 - type: string - x-go-name: SnapshotpolicyStatus - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - storage: - description: 存储名称 - type: string - x-go-name: Storage - storage_id: - type: string - x-go-name: StorageId - storage_status: - description: 存储状态 - type: string - x-go-name: StorageStatus - storage_type: - description: 存储类型 - type: string - x-go-name: StorageType - template_id: - description: 镜像Id - type: string - x-go-name: TemplateId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - throughput: - description: 磁盘吞吐量 - format: int64 - type: integer - x-go-name: Throughput - 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 - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 归属可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskResetInput: - properties: - auto_start: - type: boolean - x-go-name: AutoStart - snapshot_id: - type: string - x-go-name: SnapshotId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskResizeInput: - properties: - size: - description: 'default unit: Mb' - example: 1024; 40G; 1024M - type: string - x-go-name: Size - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskSaveInput: - properties: - Format: - type: string - ImageId: - description: 'swagger: ignore' - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DiskUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - disk_type: - description: 磁盘类型 - type: string - x-go-name: DiskType - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsRecordDetails: - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - 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 - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - records: - type: string - x-go-name: Records - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - ttl: - description: DNS记录的过期时间，单位为秒 - example: 60 - format: int64 - type: integer - x-go-name: Ttl - 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/compute - DnsRecordDisableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsRecordEnableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsRecordPolicy: - properties: - policy_options: - type: object - x-go-name: PolicyOptions - policy_type: - type: string - x-go-name: PolicyType - policy_value: - type: string - x-go-name: PolicyValue - provider: - description: 平台 - type: string - x-go-name: Provider - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsRecordSetCreateInput: - 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 - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - dns_type: - type: string - x-go-name: DnsType - dns_value: - type: string - x-go-name: DnsValue - dns_zone_id: - type: string - x-go-name: DnsZoneId - 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 - mx_priority: - format: int64 - type: integer - x-go-name: MxPriority - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - traffic_policies: - items: - $ref: '#/definitions/DnsRecordPolicy' - type: array - x-go-name: TrafficPolicies - ttl: - format: int64 - type: integer - x-go-name: TTL - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsRecordSetDetails: - properties: - TrafficPolicies: - items: - $ref: '#/definitions/DnsRecordPolicy' - type: array - 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 - dns_type: - type: string - x-go-name: DnsType - dns_value: - type: string - x-go-name: DnsValue - dns_zone: - type: string - x-go-name: DnsZone - dns_zone_id: - type: string - x-go-name: DnsZoneId - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - 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 - mx_priority: - format: int64 - type: integer - x-go-name: MxPriority - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - status: - description: 资源状态 - type: string - x-go-name: Status - ttl: - format: int64 - type: integer - x-go-name: TTL - 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/compute - DnsRecordSetTrafficPoliciesInput: - properties: - traffic_policies: - items: - $ref: '#/definitions/DnsRecordPolicy' - type: array - x-go-name: TrafficPolicies - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsRecordSetUpdateInput: - properties: - TrafficPolicies: - items: - $ref: '#/definitions/DnsRecordPolicy' - type: array - description: - description: 资源描述 - type: string - x-go-name: Description - dns_type: - type: string - x-go-name: DnsType - dns_value: - type: string - x-go-name: DnsValue - mx_priority: - format: int64 - type: integer - x-go-name: MxPriority - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - ttl: - format: int64 - type: integer - x-go-name: TTL - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsTrafficPolicyCreateInput: - 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 - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - 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 - options: - description: 额外参数 - type: object - x-go-name: Options - policy_type: - type: string - x-go-name: PolicyType - policy_value: - type: string - x-go-name: PolicyValue - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - provider: - type: string - x-go-name: Provider - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsTrafficPolicyDetails: - 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 - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - options: - type: object - x-go-name: Options - policy_type: - type: string - x-go-name: PolicyType - policy_value: - type: string - x-go-name: PolicyValue - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneAddVpcsInput: - properties: - vpc_ids: - description: VPC id列表 - items: - type: string - type: array - x-go-name: VpcIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneCacheCreateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneCacheDetails: - properties: - Account: - type: string - Brand: - type: string - Provider: - type: string - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloudaccount_id: - description: 归属云账号ID - type: string - x-go-name: CloudaccountId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - dns_zone_id: - type: string - x-go-name: DnsZoneId - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - product_type: - type: string - x-go-name: ProductType - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneCacheInput: - properties: - CloudaccountId: - description: |- - 云账号Id - - - 要求 | - ---------- | - 1. dns zone 状态必须为available | - 2. dns zone zone_type 必须为PublicZone | - 3. 指定云账号未在云上创建相应的 dns zone | - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - cloudaccount_id: - description: 云账号Id, 仅在zone_type为PublicZone时生效, 若为空则不会在云上创建 - type: string - x-go-name: CloudaccountId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - 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 - options: - description: 额外信息 - type: object - x-go-name: Options - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - vpc_ids: - description: VPC id列表, 仅在zone_type为PrivateZone时生效, vpc列表必须属于同一个账号 - items: - type: string - type: array - x-go-name: VpcIds - zone_type: - description: |- - 区域类型 - - - 类型 | 说明 | - ---------- |---------| - PublicZone | 公有 | - PrivateZone | 私有 | - type: string - x-go-name: ZoneType - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneDetails: - properties: - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_caches: - description: Cache info - items: - type: object - type: array - x-go-name: CloudCaches - 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 - dns_recordset_count: - description: Dns记录数量 - format: int64 - type: integer - x-go-name: DnsRecordsetCount - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - id: - description: 资源UUID - type: string - x-go-name: Id - is_dirty: - type: boolean - x-go-name: IsDirty - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - options: - type: object - x-go-name: Options - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - 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 - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vpc_count: - description: 关联vpc数量 - format: int64 - type: integer - x-go-name: VpcCount - zone_type: - type: string - x-go-name: ZoneType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZonePurgeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneRemoveVpcsInput: - properties: - vpc_ids: - description: VPC id列表 - items: - type: string - type: array - x-go-name: VpcIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneSyncRecordSetsInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneSyncStatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DnsZoneUnacheInput: - properties: - CloudaccountId: - description: 云账号Id - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - DomainLevelResourceBaseUpdateInput: - 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 - DynamicschedtagDetails: - 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 - condition: - description: 动态调度标间的匹配条件 - example: host.sys_load > 1.5 || host.mem_used_percent > 0.7 => "high_load" - type: string - x-go-name: Condition - 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 - 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 - resource_type: - description: 调度标签管理的资源类型 - type: string - x-go-name: ResourceType - schedtag: - description: 调度标签名称 - type: string - x-go-name: Schedtag - schedtag_id: - description: 归属调度标签ID - type: string - x-go-name: SchedtagId - 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/compute - ElasticDissociateInput: - properties: - auto_delete: - default: false - description: |- - 注意: 若关联到aws NAT网关后，目前没办法解除关联关系 - 是否解绑后自动删除弹性公网IP - type: boolean - x-go-name: AutoDelete - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticSearchAccessInfo: - description: +onecloud:model-api-gen - properties: - Domain: - type: string - KibanaPrivateUrl: - type: string - KibanaUrl: - type: string - Port: - format: int64 - type: integer - PrivateDomain: - type: string - PrivatePort: - format: int64 - type: integer - Vip: - type: string - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - ElasticSearchCreateInput: - description: 资源创建参数, 目前仅占位 - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticSearchDetails: - description: 资源返回详情 - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - network: - description: IP子网名称 - type: string - x-go-name: Network - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheAccountDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - account_privilege: - description: 账号类型 normal |admin - type: string - x-go-name: AccountPrivilege - account_type: - type: string - x-go-name: AccountType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - 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 - elasticcache: - description: 弹性缓存实例名称 - type: string - x-go-name: Elasticcache - elasticcache_id: - description: 弹性缓存ID - type: string - x-go-name: ElasticcacheId - engine: - description: 引擎 - type: string - x-go-name: Engine - engine_version: - description: 引擎版本 - type: string - x-go-name: EngineVersion - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - password: - description: 账号权限 read | write | repl（复制, 复制权限支持读写，且开放SYNC/PSYNC命令） - type: string - x-go-name: Password - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 归属Zone ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheAclDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - 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 - elasticcache: - description: 弹性缓存实例名称 - type: string - x-go-name: Elasticcache - elasticcache_id: - description: 弹性缓存ID - type: string - x-go-name: ElasticcacheId - engine: - description: 引擎 - type: string - x-go-name: Engine - engine_version: - description: 引擎版本 - type: string - x-go-name: EngineVersion - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - ip_list: - description: Ip地址白名单列表 - type: string - x-go-name: IpList - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 归属Zone ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheBackupDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - backup_mode: - description: 备份模式，自动|手动 - type: string - x-go-name: BackupMode - backup_size_mb: - description: 备份大小 - format: int64 - type: integer - x-go-name: BackupSizeMb - backup_type: - description: 备份类型, 全量|增量额 - type: string - x-go-name: BackupType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - 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 - download_url: - description: 下载地址 - type: string - x-go-name: DownloadURL - elasticcache: - description: 弹性缓存实例名称 - type: string - x-go-name: Elasticcache - elasticcache_id: - description: 弹性缓存ID - type: string - x-go-name: ElasticcacheId - end_time: - description: 结束备份时间 - format: date-time - type: string - x-go-name: EndTime - engine: - description: 引擎 - type: string - x-go-name: Engine - engine_version: - description: 引擎版本 - type: string - x-go-name: EngineVersion - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - start_time: - description: 开始备份时间 - format: date-time - type: string - x-go-name: StartTime - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 归属Zone ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - BillingType: - description: 计费方式 - enum: - - postpaid - - ' prepaid' - type: string - auto_renew: - default: false - description: 是否自动续费(仅包年包月时生效) - type: boolean - x-go-name: AutoRenew - capacity_mb: - format: int64 - type: integer - x-go-name: CapacityMb - cloudregion_id: - type: string - x-go-name: CloudregionId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - duration: - description: 包年包月时间周期 - type: string - x-go-name: Duration - engine: - description: 弹性缓存Engine - enum: - - redis - - ' memcached' - type: string - x-go-name: Engine - engine_version: - description: 弹性缓存Engine版本 - type: string - x-go-name: EngineVersion - 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 - instance_type: - description: 实例规格 - type: string - x-go-name: InstanceType - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - local_category: - type: string - x-go-name: LocalCategory - maintain_start_time: - description: |- - 弹性缓存维护时间段 - 华为云此参数可选,其它云该参数无效 - enum: - - "22:00:00" - - ' 02:00:00' - - ' 06:00:00' - - ' 10:00:00' - - ' 14:00:00' - - ' 18:00:00' - type: string - x-go-name: MaintainStartTime - memory_size_mb: - description: 'swagger: ignore' - format: int64 - type: integer - x-go-name: MemorySizeMb - 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 - network: - description: 'swagger: ignore' - type: string - x-go-name: Network - network_id: - description: Ip子网名称或Id,建议使用Id - type: string - x-go-name: NetworkId - network_type: - description: 网络类型 - enum: - - vpc - - ' cLassic' - type: string - x-go-name: NetworkType - node_type: - type: string - x-go-name: NodeType - password: - description: 初始密码 - type: string - x-go-name: Password - private_ip: - description: |- - 内网IP - 阿里云、华为云此参数可选，其它公有云该参数无效 - type: string - x-go-name: PrivateIp - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - reset_password: - type: boolean - x-go-name: ResetPassword - secgroup_ids: - default: default - description: 安全组名称或Id - items: - type: string - type: array - x-go-name: SecgroupIds - slave_zones: - description: |- - 备可用区名称或Id列表, split by: , - 默认副本与主可用区一致 - 支持此参数的云厂商: 腾讯云 - type: string - x-go-name: SlaveZones - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - zone: - description: 'swagger: ignore' - type: string - x-go-name: Zone - zone_id: - description: 主可用区名称或Id - type: string - x-go-name: ZoneId - required: - - name - - network_id - - network_type - - engine - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - auth_mode: - description: 访问密码？ on （开启密码）|off （免密码访问） - type: string - x-go-name: AuthMode - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - bandwidth: - description: 带宽 - format: int64 - type: integer - x-go-name: Bandwidth - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - capacity_mb: - description: 容量 - example: 1024 - format: int64 - type: integer - x-go-name: CapacityMB - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - connections: - description: 最大连接数 - format: int64 - type: integer - x-go-name: Connections - 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 - disable_delete: - description: 是否开启删除保护 - example: true - type: boolean - x-go-name: DisableDelete - domain_id: - description: 域Id - type: string - x-go-name: DomainId - engine: - description: |- - 后端存储引擎 - Redis | Memcache - example: redis - type: string - x-go-name: Engine - engine_version: - description: 后端存储引擎版本 - example: "4.0" - type: string - x-go-name: EngineVersion - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - instance_type: - description: 实例规格 - example: redis.master.micro.default - type: string - x-go-name: InstanceType - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - local_category: - description: 对应Sku - type: string - x-go-name: LocalCategory - maintain_end_time: - description: 维护结束时间 - type: string - x-go-name: MaintainEndTime - maintain_start_time: - description: 维护开始时间，格式为HH:mmZ - example: 02:00Z - type: string - x-go-name: MaintainStartTime - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - network: - description: IP子网名称 - type: string - x-go-name: Network - network_id: - description: 所属网络ID - type: string - x-go-name: NetworkId - network_type: - description: 网络类型, CLASSIC（经典网络） VPC（专有网络） - example: CLASSIC - type: string - x-go-name: NetworkType - node_type: - description: |- - 类型 - single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | readfive（5只读） - type: string - x-go-name: NodeType - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - private_connect_port: - description: 内网访问端口 - format: int64 - type: integer - x-go-name: PrivateConnectPort - private_dns: - description: 内网DNS - type: string - x-go-name: PrivateDNS - private_ip_addr: - description: 内网IP地址 - type: string - x-go-name: PrivateIpAddr - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_connect_port: - description: 外网访问端口 - format: int64 - type: integer - x-go-name: PublicConnectPort - public_dns: - description: 公网DNS - type: string - x-go-name: PublicDNS - public_ip_addr: - description: 公网IP地址 - type: string - x-go-name: PublicIpAddr - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - secgroups: - description: 关联安全组列表 - items: - $ref: '#/definitions/StandaloneShortDesc' - type: array - x-go-name: Secgroups - slave_zone_infos: - description: 备可用区列表 - items: - $ref: '#/definitions/StandaloneShortDesc' - type: array - x-go-name: SlaveZoneInfos - slave_zones: - description: 备可用区 - type: string - x-go-name: SlaveZones - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheJointBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheParameterDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - 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 - elasticcache: - description: 弹性缓存实例名称 - type: string - x-go-name: Elasticcache - elasticcache_id: - description: 弹性缓存ID - type: string - x-go-name: ElasticcacheId - engine: - description: 引擎 - type: string - x-go-name: Engine - engine_version: - description: 引擎版本 - type: string - x-go-name: EngineVersion - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - force_restart: - description: True（重启生效） False（无需重启，提交后即生效） - type: boolean - x-go-name: ForceRestart - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - key: - description: Parameter KEY - type: string - x-go-name: Key - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - modifiable: - description: True（可修改） False（不可修改） - type: boolean - x-go-name: Modifiable - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - value: - description: Parameter Value - type: string - x-go-name: Value - value_range: - description: 校验代码，参数的可选范围。 - type: string - x-go-name: ValueRange - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 归属Zone ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheRemoteUpdateInput: - properties: - replace_tags: - description: 是否覆盖替换所有标签 - type: boolean - x-go-name: ReplaceTags - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheSecgroupsInput: - properties: - secgroup_ids: - description: |- - 安全组Id列表 - 实例必须处于运行状态 - - - 平台 | 最多绑定安全组数量 | - -------------|------------------- | - 腾讯云 | 10 | - 华为云 | 不支持安全组 | - 阿里云 | 不支持安全组 | - items: - type: string - type: array - x-go-name: SecgroupIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheSkuDetails: - properties: - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - cpu_arch: - description: CPU 架构 x86|ARM - type: string - x-go-name: CpuArch - 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 - disk_size_gb: - description: 套餐附带硬盘容量 - format: int64 - type: integer - x-go-name: DiskSizeGB - engine: - description: "引擎\tredis|memcached" - type: string - x-go-name: Engine - engine_arch: - type: string - x-go-name: EngineArch - engine_version: - description: "引擎版本\t3.0" - type: string - x-go-name: EngineVersion - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - instance_spec: - type: string - x-go-name: InstanceSpec - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - local_category: - type: string - x-go-name: LocalCategory - max_clients: - description: 最大客户端数 - format: int64 - type: integer - x-go-name: MaxClients - max_connections: - description: 最大连接数 - format: int64 - type: integer - x-go-name: MaxConnections - max_in_bandwidth_mb: - description: 最大内网带宽 - format: int64 - type: integer - x-go-name: MaxInBandwidthMb - max_memory_mb: - description: 实际可使用的最大内存 - format: int64 - type: integer - x-go-name: MaxMemoryMB - max_replicas_num: - description: 最大副本数量 - format: int64 - type: integer - x-go-name: MaxReplicasNum - max_shard_num: - description: 最大分片数量 - format: int64 - type: integer - x-go-name: MaxShardNum - memory_size_mb: - description: 内存容量 - format: int64 - type: integer - x-go-name: MemorySizeMB - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - node_type: - description: single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | - readfive（5只读） - type: string - x-go-name: NodeType - performance_type: - description: standrad|enhanced - type: string - x-go-name: PerformanceType - postpaid_status: - type: string - x-go-name: PostpaidStatus - prepaid_status: - type: string - x-go-name: PrepaidStatus - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: "公有云厂商\tAliyun/Azure/AWS/Qcloud/..." - type: string - x-go-name: Provider - qps: - description: QPS参考值 - format: int64 - type: integer - x-go-name: QPS - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - replicas_num: - description: 最小副本数量 - format: int64 - type: integer - x-go-name: ReplicasNum - shard_num: - description: 最小分片数量 - format: int64 - type: integer - x-go-name: ShardNum - slave_zone: - description: 可用区名称 - example: 北京2区 - type: string - x-go-name: SlaveZone - slave_zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: SlaveZoneExtId - slave_zone_id: - type: string - x-go-name: SlaveZoneId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - storage_type: - description: "存储类型\tDRAM|SCM" - type: string - x-go-name: StorageType - 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 - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcacheSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticcachesecgroupDetails: - 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 - elasticcache: - description: 弹性缓存实例名称 - type: string - x-go-name: Elasticcache - elasticcache_id: - description: 弹性缓存ID - type: string - x-go-name: ElasticcacheId - row_id: - format: int64 - type: integer - x-go-name: RowId - secgroup: - description: 安全组名称 - type: string - x-go-name: Secgroup - secgroup_id: - description: 本地安全组ID - type: string - x-go-name: SecgroupId - 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/compute - ElasticipAssociateInput: - properties: - instance_id: - description: 待绑定实例Id - type: string - x-go-name: InstanceId - instance_type: - default: server - description: |- - 实例类型 - enmu: server, natgateway - type: string - x-go-name: InstanceType - ip_addr: - description: EIP映射的内网IP地址，可选 - type: string - x-go-name: IpAddr - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ElasticipDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - associate_id: - description: 绑定资源Id - type: string - x-go-name: AssociateId - associate_name: - description: 绑定资源名称 - type: string - x-go-name: AssociateName - associate_type: - description: 绑定资源类型 - type: string - x-go-name: AssociateType - auto_dellocate: - description: 是否跟随主机删除而自动释放 - type: boolean - x-go-name: AutoDellocate - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - bandwidth: - description: 带宽大小 - format: int64 - type: integer - x-go-name: Bandwidth - bgp_type: - description: 线路类型 - type: string - x-go-name: BgpType - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - charge_type: - description: '计费类型: 流量、带宽' - example: bandwidth - type: string - x-go-name: ChargeType - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - ip_addr: - description: IP地址 - type: string - x-go-name: IpAddr - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - mode: - description: |- - 标识弹性或非弹性 - Mode | 说明 | - ------------|------------| - public_ip | 公网IP | - elastic_ip | 弹性公网IP | - example: elastic_ip - type: string - x-go-name: Mode - name: - description: 资源名称 - type: string - x-go-name: Name - network_id: - description: IP子网Id, 仅私有云不为空 - type: string - x-go-name: NetworkId - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - ElasticipSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - EnabledStatusInfrasResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - EnabledStatusStandaloneResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - EnabledStatusStandaloneResourceCreateInput: - 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 - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - Error: - properties: - class: - type: string - x-go-name: Class - code: - format: int64 - type: integer - x-go-name: Code - details: - type: string - x-go-name: Details - type: object - x-go-package: yunion.io/x/onecloud/pkg/httperrors - ExternalProjectChangeProjectInput: - properties: - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ExternalProjectCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - cloudaccount_id: - type: string - x-go-name: CloudaccountId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - manager_id: - type: string - x-go-name: ManagerId - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ExternalProjectDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudaccount_id: - description: 归属云账号ID - type: string - x-go-name: CloudaccountId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - environment: - description: Environment - type: string - x-go-name: Environment - external_domain_id: - type: string - x-go-name: ExternalDomainId - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - FileSystemCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - auto_renew: - default: false - description: 是否自动续费(仅包年包月时生效) - type: boolean - x-go-name: AutoRenew - billing_type: - description: 计费方式 - enum: - - postpaid - - ' prepaid' - type: string - x-go-name: BillingType - capacity: - description: 容量大小 - format: int64 - type: integer - x-go-name: Capacity - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - duration: - description: 包年包月时间周期 - type: string - x-go-name: Duration - expired_at: - description: 到期释放时间，仅后付费支持 - format: date-time - type: string - x-go-name: ExpiredAt - file_system_type: - description: |- - 文件系统类型 - enmu: extreme, standard, cpfs - type: string - x-go-name: FileSystemType - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager_id: - description: 订阅Id, 若传入network_id此参数可忽略 - type: string - x-go-name: ManagerId - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - network_id: - description: IP子网Id - type: string - x-go-name: NetworkId - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - protocol: - description: 协议类型 - enum: - - NFS - - ' SMB' - - ' CPFS' - type: string - x-go-name: Protocol - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - storage_type: - description: |- - 存储类型 - enmu: performance, capacity, standard, advance, advance_100, advance_200 - type: string - x-go-name: StorageType - zone_id: - description: 可用区Id, 若不指定IP子网，此参数必填 - type: string - x-go-name: ZoneId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - FileSystemDetails: - properties: - Network: - type: string - Vpc: - type: string - Zone: - type: string - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - 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' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - FileSystemRemoteUpdateInput: - properties: - replace_tags: - description: 是否覆盖替换所有标签 - type: boolean - x-go-name: ReplaceTags - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - FileSystemSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - Floppy: - properties: - detail: - type: string - x-go-name: Detail - ordinal: - format: int64 - type: integer - x-go-name: Ordinal - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GetCloudaccountSamlOutput: - properties: - entity_id: - description: cloudaccount SAML ServiceProvider entity ID - type: string - x-go-name: EntityId - init_login_url: - description: initial SAML SSO login URL for this cloudaccount - type: string - x-go-name: InitLoginUrl - metadata_url: - description: metadata URL for this cloudaccount - type: string - x-go-name: MetadataUrl - redirect_login_url: - description: redirect login URL for this cloudaccount - type: string - x-go-name: RedirectLoginUrl - redirect_logout_url: - description: redirect logout URL for this cloudaccount - type: string - x-go-name: RedirectLogoutUrl - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GetDetailsStatusOutput: - properties: - status: - description: 状态 - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - GetNetworkAddressesOutput: - properties: - addresses: - description: IP子网地址记录 - items: - $ref: '#/definitions/SNetworkUsedAddress' - type: array - x-go-name: Addresses - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GlobalVpcCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - cloudprovider_id: - description: 列出关联指定云订阅(ID或Name)的资源 - type: string - x-go-name: CloudproviderId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GlobalVpcDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vpc_count: - description: vpc数量 - format: int64 - type: integer - x-go-name: VpcCount - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GlobalvpcUpdateInput: - 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/compute - GroupAttachNetworkInput: - properties: - alloc_dir: - $ref: '#/definitions/IPAllocationDirection' - ip_addr: - description: candidate IPaddr - type: string - x-go-name: IpAddr - network_id: - description: network id or name - type: string - x-go-name: NetworkId - require_designated_ip: - description: Required Designed IP - type: boolean - x-go-name: RequireDesignatedIp - reserved: - description: Reserved - type: boolean - x-go-name: Reserved - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GroupDetachNetworkInput: - properties: - ip_addr: - description: candidate IPaddr - type: string - x-go-name: IpAddr - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GroupguestDetails: - properties: - Guest: - type: string - Server: - type: string - 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 - group_id: - type: string - x-go-name: GroupId - guest_id: - type: string - x-go-name: GuestId - guest_status: - type: string - x-go-name: GuestStatus - instance_group: - description: 主机组的名称 - type: string - x-go-name: Instancegroup - row_id: - format: int64 - type: integer - x-go-name: RowId - tag: - type: string - x-go-name: Tag - 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/compute - GroupnetworkDetails: - 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 - eip_addr: - description: EipAddr if eip is associated with this groupnetwork - type: string - x-go-name: EipAddr - eip_id: - type: string - x-go-name: EipId - group_id: - type: string - x-go-name: GroupId - index: - format: uint8 - type: integer - x-go-name: Index - instance_group: - description: 主机组的名称 - type: string - x-go-name: Instancegroup - ip_addr: - type: string - x-go-name: IpAddr - network: - description: IP子网名称 - type: string - x-go-name: Network - network_id: - type: string - x-go-name: NetworkId - row_id: - format: int64 - type: integer - x-go-name: RowId - 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/compute - GuestAddSecgroupInput: - properties: - secgroup_ids: - description: |- - 安全组Id列表 - 实例必须处于运行,休眠或者关机状态 - - - 平台 | 最多绑定安全组数量 | - -------------|------------------- | - Azure | 1 | - VMware | 不支持安全组 | - Baremetal | 不支持安全组 | - ZStack | 1 | - 其他 | 5 | - items: - type: string - type: array - x-go-name: SecgroupIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestAssignSecgroupInput: - properties: - secgroup_id: - description: |- - 安全组Id - 实例必须处于运行,休眠或者关机状态 - type: string - x-go-name: SecgroupId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestAutoRenewInput: - properties: - auto_renew: - default: false - description: 设置自动续费 - type: boolean - x-go-name: AutoRenew - duration: - default: 1M - description: 续费周期 - example: 1Y, 1M, 1W - type: string - x-go-name: Duration - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestDiskDetails: - properties: - Disk: - description: 磁盘名称 - type: string - aio_mode: - description: Column(VARCHAR(32, charset='ascii'), nullable=True) - type: string - x-go-name: AioMode - boot_index: - description: Column(TINYINT(4), nullable=False, default=0) - format: uint8 - type: integer - x-go-name: BootIndex - bps: - format: int64 - type: integer - x-go-name: Bps - cache_mode: - description: Column(VARCHAR(32, charset='ascii'), nullable=True) - type: string - x-go-name: CacheMode - 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 - disk_id: - type: string - x-go-name: DiskId - disk_size: - description: 磁盘大小, 单位Mb - example: 10240 - format: int64 - type: integer - x-go-name: DiskSize - disk_type: - description: 磁盘类型 - example: data - type: string - x-go-name: DiskType - driver: - type: string - x-go-name: Driver - guest: - description: 云主机名称 - type: string - x-go-name: Guest - guest_id: - type: string - x-go-name: GuestId - image_path: - type: string - x-go-name: ImagePath - index: - format: uint8 - type: integer - x-go-name: Index - iops: - description: Column(VARCHAR(32, charset='ascii'), nullable=True) - format: int64 - type: integer - x-go-name: Iops - medium_type: - description: 介质类型 - example: ssd - type: string - x-go-name: MediumType - mountpoint: - type: string - x-go-name: Mountpoint - row_id: - format: int64 - type: integer - x-go-name: RowId - server: - description: 云主机名称 - type: string - x-go-name: Server - status: - description: 磁盘状态 - example: ready - type: string - x-go-name: Status - storage_type: - description: 存储类型 - example: local - type: string - x-go-name: StorageType - 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/compute - GuestDiskInfo: - properties: - aio_mode: - type: string - x-go-name: AioMode - boot_index: - format: int8 - type: integer - x-go-name: BootIndex - bps: - format: int64 - type: integer - x-go-name: Bps - cache_mode: - type: string - x-go-name: CacheMode - disk_format: - type: string - x-go-name: DiskFormat - disk_type: - type: string - x-go-name: DiskType - driver: - type: string - x-go-name: Driver - fs: - type: string - x-go-name: FsFormat - id: - type: string - x-go-name: Id - image: - type: string - x-go-name: Image - image_id: - type: string - x-go-name: ImageId - index: - format: int8 - type: integer - x-go-name: Index - iops: - format: int64 - type: integer - x-go-name: Iops - medium_type: - type: string - x-go-name: MediumType - name: - type: string - x-go-name: Name - size: - format: int64 - type: integer - x-go-name: SizeMb - storage_id: - type: string - x-go-name: StorageId - storage_type: - type: string - x-go-name: StorageType - title: GuestDiskInfo describe the information of disk on the guest. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestHaveAgentInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestHaveAgentOutput: - properties: - Have: - type: boolean - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestJointBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestJointResourceDetails: - 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' - guest: - description: 云主机名称 - type: string - x-go-name: Guest - server: - description: 云主机名称 - type: string - x-go-name: Server - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestLiveMigrateInput: - properties: - enable_tls: - description: 是否启用 tls - type: boolean - x-go-name: EnableTLS - keep_dest_guest_on_failed: - type: boolean - x-go-name: KeepDestGuestOnFailed - max_bandwidth_mb: - description: 迁移带宽限制 - format: int64 - type: integer - x-go-name: MaxBandwidthMb - prefer_host: - description: 'swagger: ignore' - type: string - x-go-name: PreferHost - prefer_host_id: - description: 指定期望的迁移目标宿主机 - type: string - x-go-name: PreferHostId - quickly_finish: - description: 快速完成，内存同步一定周期后调整 downtime - type: boolean - x-go-name: QuicklyFinish - skip_cpu_check: - description: 是否跳过CPU检查，默认要做CPU检查 - type: boolean - x-go-name: SkipCpuCheck - skip_kernel_check: - description: 是否跳过kernel检查 - type: boolean - x-go-name: SkipKernelCheck - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestMakeSshableCmdOutput: - properties: - ShellCmd: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestMakeSshableInput: - properties: - Password: - type: string - Port: - format: int64 - type: integer - PrivateKey: - type: string - User: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestMakeSshableOutput: - properties: - AnsiblePlaybookId: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestMigrateInput: - properties: - auto_start: - type: boolean - x-go-name: AutoStart - prefer_host: - description: 'swagger: ignore' - type: string - x-go-name: PreferHost - prefer_host_id: - type: string - x-go-name: PreferHostId - rescue_mode: - type: boolean - x-go-name: IsRescueMode - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestPublicipToEipInput: - properties: - auto_start: - default: false - description: 转换完成后是否自动启动 - type: boolean - x-go-name: AutoStart - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestRevokeSecgroupInput: - properties: - secgroup_ids: - description: |- - 安全组Id列表 - 实例必须处于运行,休眠或者关机状态 - items: - type: string - type: array - x-go-name: SecgroupIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestSaveToTemplateInput: - properties: - generate_name: - description: The generate name of guest template - type: string - x-go-name: GenerateName - name: - description: The name of guest template - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestSetSecgroupInput: - properties: - secgroup_ids: - description: |- - 安全组Id列表 - 实例必须处于运行,休眠或者关机状态 - - - 平台 | 最多绑定安全组数量 | - -------------|------------------- | - Azure | 1 | - VMware | 不支持安全组 | - Baremetal | 不支持安全组 | - ZStack | 1 | - 其他 | 5 | - items: - type: string - type: array - x-go-name: SecgroupIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestSetSshportInput: - properties: - Port: - format: int64 - type: integer - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestSshportOutput: - properties: - Port: - format: int64 - type: integer - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestSyncFixNicsInput: - properties: - ip: - description: 需要修正的IP地址列表 - items: - type: string - type: array - x-go-name: Ip - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestTemplateConfigInfo: - properties: - disks: - items: - $ref: '#/definitions/GuestTemplateDisk' - type: array - x-go-name: Disks - image: - type: string - x-go-name: Image - isolated_device_config: - items: - $ref: '#/definitions/IsolatedDeviceConfig' - type: array - x-go-name: IsolatedDeviceConfig - keypair: - type: string - x-go-name: Keypair - metadata: - additionalProperties: - type: string - type: object - x-go-name: Metadata - nets: - items: - $ref: '#/definitions/GuestTemplateNetwork' - type: array - x-go-name: Nets - reset_password: - type: boolean - x-go-name: ResetPassword - secgroup: - type: string - x-go-name: Secgroup - sku: - $ref: '#/definitions/GuestTemplateSku' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestTemplateCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - billing_type: - type: string - x-go-name: BillingType - cloudregion_id: - type: string - x-go-name: CloudregionId - content: - description: 'description: the content of guest template' - type: object - x-go-name: Content - 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 - hypervisor: - type: string - x-go-name: Hypervisor - image_id: - type: string - x-go-name: ImageId - image_type: - type: string - x-go-name: ImageType - instance_type: - type: string - x-go-name: InstanceType - 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: 'description: indicate the resource is a system resource, which - is not visible to user' - 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 - os_type: - type: string - x-go-name: OsType - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - vcpu_count: - format: int64 - type: integer - x-go-name: VcpuCount - vmem_size: - format: int64 - type: integer - x-go-name: VmemSize - vpc_id: - type: string - x-go-name: VpcId - required: - - name - - content - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestTemplateDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - billing_type: - description: 计费方式 - type: string - x-go-name: BillingType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - config_info: - $ref: '#/definitions/GuestTemplateConfigInfo' - content: - description: 其他配置信息 - type: object - x-go-name: Content - 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 - environment: - description: Environment - type: string - x-go-name: Environment - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - hypervisor: - description: 虚拟机技术 - type: string - x-go-name: Hypervisor - id: - description: 资源UUID - type: string - x-go-name: Id - image_id: - description: 镜像ID - type: string - x-go-name: ImageId - image_type: - description: 镜像类型 - type: string - x-go-name: ImageType - 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 - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - os_type: - description: 虚拟机操作系统类型 - pattern: Linux|Windows|VMWare - type: string - x-go-name: OsType - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - secgroups: - items: - type: string - type: array - x-go-name: Secgroups - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - vcpu_count: - description: 虚拟机CPU数量 - format: int64 - type: integer - x-go-name: VcpuCount - vmem_size: - description: 虚拟机内存大小（MB） - format: int64 - type: integer - x-go-name: VmemSize - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - type: string - x-go-name: VpcId - zone: - type: string - x-go-name: Zone - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestTemplateDisk: - properties: - backend: - type: string - x-go-name: Backend - disk_type: - type: string - x-go-name: DiskType - index: - format: int64 - type: integer - x-go-name: Index - size_mb: - format: int64 - type: integer - x-go-name: SizeMb - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestTemplateNetwork: - properties: - guest_ip_end: - type: string - x-go-name: GuestIpEnd - guest_ip_start: - type: string - x-go-name: GuestIpStart - id: - type: string - x-go-name: ID - name: - type: string - x-go-name: Name - vlan_id: - format: int64 - type: integer - x-go-name: VlanId - vpc_id: - type: string - x-go-name: VpcId - vpc_name: - type: string - x-go-name: VpcName - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestTemplateSku: - properties: - cpu_core_count: - format: int64 - type: integer - x-go-name: CpuCoreCount - instance_type_category: - type: string - x-go-name: InstanceTypeCategory - instance_type_family: - type: string - x-go-name: InstanceTypeFamily - memory_size_mb: - format: int64 - type: integer - x-go-name: MemorySizeMb - name: - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestTemplateUpdateInput: - properties: - billing_type: - type: string - x-go-name: BillingType - cloudregion_id: - type: string - x-go-name: CloudregionId - content: - description: 'description: the content of guest template' - type: object - x-go-name: Content - description: - description: 资源描述 - type: string - x-go-name: Description - hypervisor: - type: string - x-go-name: Hypervisor - image_id: - type: string - x-go-name: ImageId - image_type: - type: string - x-go-name: ImageType - instance_type: - type: string - x-go-name: InstanceType - name: - description: 资源名称 - type: string - x-go-name: Name - os_type: - type: string - x-go-name: OsType - progress: - format: float - type: number - x-go-name: Progress - vcpu_count: - format: int64 - type: integer - x-go-name: VcpuCount - vmem_size: - format: int64 - type: integer - x-go-name: VmemSize - vpc_id: - type: string - x-go-name: VpcId - required: - - content - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestdiskUpdateInput: - properties: - aio_mode: - type: string - x-go-name: AioMode - bps: - format: int64 - type: integer - x-go-name: Bps - cache_mode: - type: string - x-go-name: CacheMode - driver: - type: string - x-go-name: Driver - index: - format: int8 - type: integer - x-go-name: Index - iops: - format: int64 - type: integer - x-go-name: Iops - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestnetworkDetails: - properties: - bw_limit: - description: 带宽限制，单位mbps - format: int64 - type: integer - x-go-name: BwLimit - 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 - driver: - description: 虚拟网卡驱动 - type: string - x-go-name: Driver - eip_addr: - description: EipAddr associate with this guestnetwork - type: string - x-go-name: EipAddr - eip_id: - description: 网卡关联的Eip实例 - type: string - x-go-name: EipId - guest: - description: 云主机名称 - type: string - x-go-name: Guest - guest_id: - type: string - x-go-name: GuestId - ifname: - description: 虚拟网卡设备名称 - type: string - x-go-name: Ifname - index: - description: 网卡序号 - format: uint8 - type: integer - x-go-name: Index - ip_addr: - description: IPv4地址 - type: string - x-go-name: IpAddr - ip6_addr: - description: IPv6地址 - type: string - x-go-name: Ip6Addr - mac_addr: - description: MAC地址 - type: string - x-go-name: MacAddr - mapped_ip_addr: - description: IPv4映射地址，当子网属于私有云vpc的时候分配，用于访问外网 - type: string - x-go-name: MappedIpAddr - network: - description: IP子网名称 - type: string - x-go-name: Network - network_id: - type: string - x-go-name: NetworkId - num_queues: - description: 网卡队列数 - format: int64 - type: integer - x-go-name: NumQueues - row_id: - format: int64 - type: integer - x-go-name: RowId - server: - description: 云主机名称 - type: string - x-go-name: Server - team_with: - description: bind配对网卡MAC地址 - type: string - x-go-name: TeamWith - 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 - virtual: - description: 是否为虚拟接口（无IP） - type: boolean - x-go-name: Virtual - wire_id: - description: 所属Wire - type: string - x-go-name: WireId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestnetworkShortDesc: - properties: - ip_addr: - description: IP地址 - type: string - x-go-name: IpAddr - ip6_addr: - description: IPv6地址 - type: string - x-go-name: Ip6Addr - is_exit: - description: |- - 是否为外网网卡 - Deprecated - type: boolean - x-go-name: IsExit - mac: - description: Mac地址 - type: string - x-go-name: Mac - network_id: - description: 所属Network - type: string - x-go-name: NetworkId - team_with: - description: Bonding的配对网卡MAC - type: string - x-go-name: TeamWith - vpc_id: - description: 所属Vpc - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestnetworkUpdateInput: - properties: - bw_limit: - format: int64 - type: integer - x-go-name: BwLimit - driver: - type: string - x-go-name: Driver - index: - format: int8 - type: integer - x-go-name: Index - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - GuestsecgroupDetails: - 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 - guest: - description: 云主机名称 - type: string - x-go-name: Guest - guest_id: - type: string - x-go-name: GuestId - row_id: - format: int64 - type: integer - x-go-name: RowId - secgroup: - description: 安全组名称 - type: string - x-go-name: Secgroup - secgroup_id: - description: 本地安全组ID - type: string - x-go-name: SecgroupId - server: - description: 云主机名称 - type: string - x-go-name: Server - 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/compute - Header: - additionalProperties: - items: - type: string - type: array - description: |- - The keys should be in canonical form, as returned by - CanonicalHeaderKey. - title: A Header represents the key-value pairs in an HTTP header. - type: object - x-go-package: net/http - Host: - description: Host represents an ansible host - properties: - Name: - description: Name denotes the host to operate on - type: string - Vars: - additionalProperties: - type: string - description: Vars is a map recording host vars - type: object - type: object - x-go-package: yunion.io/x/onecloud/pkg/util/ansible - HostAutoMigrateInput: - properties: - auto_migrate_on_host_down: - type: string - x-go-name: AutoMigrateOnHostDown - auto_migrate_on_host_shutdown: - type: string - x-go-name: AutoMigrateOnHostShutdown - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - access_ip: - description: 物理机管理口IP - type: string - x-go-name: AccessIp - access_mac: - description: 物理机管理口MAC - type: string - x-go-name: AccessMac - access_net: - description: 物理机管理口IP子网 - type: string - x-go-name: AccessNet - access_wire: - description: 物理机管理口二次网络 - type: string - x-go-name: AccessWire - boot_mode: - description: 主机启动模式, 可能值位PXE和ISO - type: string - x-go-name: BootMode - cpu_architecture: - description: CPU架构 - type: string - x-go-name: CpuArchitecture - cpu_cache: - description: CPU缓存大小,单位KB - type: string - x-go-name: CpuCache - cpu_cmtbound: - description: CPU超分比 - format: float - type: number - x-go-name: CpuCmtbound - cpu_count: - description: CPU核数 - format: int64 - type: integer - x-go-name: CpuCount - cpu_desc: - description: CPU描述信息 - type: string - x-go-name: CpuDesc - cpu_mhz: - description: CPU频率 - format: int64 - type: integer - x-go-name: CpuMhz - cpu_microcode: - description: CPUMicrocode - type: string - x-go-name: CpuMicrocode - cpu_reserved: - description: 预留CPU大小 - format: int64 - type: integer - x-go-name: CpuReserved - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - enable_pxe_boot: - description: 是否允许PXE启动 - type: boolean - x-go-name: EnablePxeBoot - 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 - host_type: - description: Host类型 - type: string - x-go-name: HostType - hostname: - description: |- - 主机名 - 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 - 字符长度2-60个字符 - Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 - 若输入为空，则会根据资源名称自动生成主机名 - 输入不为空则会自动剔除不符合规则的字符, 并进行校验 - 若长度大于允许的最大长度，会自动截取 - type: string - x-go-name: Hostname - ipmi_cdrom_boot: - description: Cdrom boot support - type: boolean - x-go-name: IpmiCdromBoot - ipmi_ip_addr: - description: ip address - type: string - x-go-name: IpmiIpAddr - ipmi_lan_channel: - description: lan channel - format: int64 - type: integer - x-go-name: IpmiLanChannel - ipmi_password: - description: password - type: string - x-go-name: IpmiPassword - ipmi_present: - description: presence - type: boolean - x-go-name: IpmiPresent - ipmi_pxe_boot: - description: ipmi_pxe_boot - type: boolean - x-go-name: IpmiPxeBoot - ipmi_redfish_api: - description: Redfish API support - type: boolean - x-go-name: IpmiRedfishApi - ipmi_username: - description: username - type: string - x-go-name: IpmiUsername - ipmi_verified: - description: verified - type: boolean - x-go-name: IpmiVerified - is_baremetal: - description: 是否为裸金属 - type: boolean - x-go-name: IsBaremetal - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_import: - description: 是否为导入的宿主机 - type: boolean - x-go-name: IsImport - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager_uri: - description: 物理机管理URI - type: string - x-go-name: ManagerUri - mem_cmtbound: - description: 内存超分比 - format: float - type: number - x-go-name: MemCmtbound - mem_reserved: - description: 预留内存大小(单位MB) - type: string - x-go-name: MemReserved - mem_size: - description: 内存大小(单位MB) - type: string - x-go-name: MemSize - 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 - no_bmc: - description: 物理机不带 BMC 控制器 - type: boolean - x-go-name: NoBMC - no_probe: - description: 新建带IPMI信息的物理机时不进行IPMI信息探测 - type: boolean - x-go-name: NoProbe - node_count: - description: 物理CPU颗数 - format: int8 - type: integer - x-go-name: NodeCount - ovn_version: - description: OVN软件版本 - type: string - x-go-name: OvnVersion - page_size_kb: - description: 页大小 - format: int64 - type: integer - x-go-name: PageSizeKB - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - rack: - description: 机架 - type: string - x-go-name: Rack - slots: - description: 机位 - type: string - x-go-name: Slots - sn: - description: 物理机序列号信息 - type: string - x-go-name: SN - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - storage_driver: - description: 存储驱动类型 - type: string - x-go-name: StorageDriver - storage_info: - description: 存储详情 - type: object - x-go-name: StorageInfo - storage_size: - description: 存储大小,单位Mb - format: int64 - type: integer - x-go-name: StorageSize - storage_type: - description: 存储类型 - type: string - x-go-name: StorageType - sys_info: - description: 系统信息 - type: object - x-go-name: SysInfo - uuid: - description: host uuid - type: string - x-go-name: Uuid - version: - description: host服务软件版本 - type: string - x-go-name: Version - zone_id: - description: 可用区ID或名称 - example: zone1 - type: string - x-go-name: ZoneId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostDetails: - properties: - IsolatedDeviceCount: - description: isolated device count - format: int64 - type: integer - access_ip: - description: 管理口Ip地址 - type: string - x-go-name: AccessIp - access_mac: - description: 管理口MAC - type: string - x-go-name: AccessMac - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - actual_storage_used: - description: 实际已使用存储大小 - format: int64 - type: integer - x-go-name: ActualStorageUsed - allow_health_check: - description: 允许开启宿主机健康检查 - type: boolean - x-go-name: AllowHealthCheck - auto_migrate_on_host_down: - type: boolean - x-go-name: AutoMigrateOnHostDown - auto_migrate_on_host_shutdown: - type: boolean - x-go-name: AutoMigrateOnHostShutdown - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - boot_mode: - description: 主机启动模式, 可能值为PXE和ISO - type: string - x-go-name: BootMode - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_prepare: - type: boolean - x-go-name: CanPrepare - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - cpu_architecture: - description: CPU架构 - type: string - x-go-name: CpuArchitecture - cpu_cache: - description: CPU缓存大小,单位KB - format: int64 - type: integer - x-go-name: CpuCache - cpu_cmtbound: - description: CPU超分比 - format: float - type: number - x-go-name: CpuCmtbound - cpu_commit: - description: CPU超分比 - format: int64 - type: integer - x-go-name: CpuCommit - cpu_commit_bound: - description: CPU超售比 - format: float - type: number - x-go-name: CpuCommitBound - cpu_commit_rate: - description: CPU超分率 - format: double - type: number - x-go-name: CpuCommitRate - cpu_count: - description: CPU核数 - format: int64 - type: integer - x-go-name: CpuCount - cpu_desc: - description: CPU描述信息 - type: string - x-go-name: CpuDesc - cpu_mhz: - description: CPU频率 - format: int64 - type: integer - x-go-name: CpuMhz - cpu_microcode: - description: CPUMicrocode - type: string - x-go-name: CpuMicrocode - cpu_reserved: - description: 预留CPU大小 - format: int64 - type: integer - x-go-name: CpuReserved - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - enable_health_check: - description: health check enabled by host agent online - type: boolean - x-go-name: EnableHealthCheck - enable_pxe_boot: - description: 是否允许PXE启动 - type: boolean - x-go-name: EnablePxeBoot - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - guests: - description: 云主机数量 - example: 10 - format: int64 - type: integer - x-go-name: Guests - host_status: - description: 宿主机状态 - example: online - type: string - x-go-name: HostStatus - host_type: - description: 宿主机类型 - type: string - x-go-name: HostType - hostname: - type: string - x-go-name: Hostname - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - ipmi_info: - description: IPMI详情 - type: object - x-go-name: IpmiInfo - ipmi_ip: - description: IPMI地址 - type: string - x-go-name: IpmiIp - is_baremetal: - type: boolean - x-go-name: IsBaremetal - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_import: - description: 是否为导入的宿主机 - type: boolean - x-go-name: IsImport - is_maintenance: - description: 是否处于维护状态 - type: boolean - x-go-name: IsMaintenance - is_prepaid_recycle: - type: boolean - x-go-name: IsPrepaidRecycle - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - manager_uri: - description: 管理地址 - type: string - x-go-name: ManagerUri - mem_cmtbound: - description: 内存超分比 - format: float - type: number - x-go-name: MemCmtbound - mem_commit: - description: 内存超分比 - format: int64 - type: integer - x-go-name: MemCommit - mem_commit_bound: - description: 内存超售比 - format: float - type: number - x-go-name: MemCommitBound - mem_commit_rate: - description: 内存超分率 - format: double - type: number - x-go-name: MemCommitRate - mem_reserved: - description: 预留内存大小 - format: int64 - type: integer - x-go-name: MemReserved - mem_size: - description: 内存大小,单位Mb - format: int64 - type: integer - x-go-name: MemSize - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - nic_count: - description: 网卡数量 - format: int64 - type: integer - x-go-name: NicCount - nic_info: - description: 网卡详情 - items: - type: object - type: array - x-go-name: NicInfo - node_count: - description: 物理CPU颗数 - format: uint8 - type: integer - x-go-name: NodeCount - nonsystem_guests: - description: 非系统云主机数量 - example: 0 - format: int64 - type: integer - x-go-name: NonsystemGuests - other_guests: - description: 其他状态云主机数量 - example: 2 - format: int64 - type: integer - x-go-name: OtherGuests - ovn_mapped_ip_addr: - description: IPv4地址，作为私有云vpc访问外网时的网关 - type: string - x-go-name: OvnMappedIpAddr - ovn_version: - description: OVN软件版本 - type: string - x-go-name: OvnVersion - page_size_kb: - description: 页大小 - format: int64 - type: integer - x-go-name: PageSizeKB - pending_deleted_guests: - description: 回收站中云主机数量 - example: 2 - format: int64 - type: integer - x-go-name: PendingDeletedGuests - prepare_fail_reason: - type: string - x-go-name: PrepareFailReason - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - rack: - description: 机架 - type: string - x-go-name: Rack - ready_guests: - description: 关机状态云主机数量 - example: 2 - format: int64 - type: integer - x-go-name: ReadyGuests - real_external_id: - type: string - x-go-name: RealExternalId - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - reserved_resource_for_gpu: - $ref: '#/definitions/IsolatedDeviceReservedResourceInput' - resource_type: - type: string - x-go-name: ResourceType - running_guests: - description: 运行状态云主机数量 - example: 2 - format: int64 - type: integer - x-go-name: RunningGuests - schedtags: - items: - $ref: '#/definitions/SchedtagShortDescDetails' - type: array - x-go-name: Schedtags - server: - type: string - x-go-name: Server - server_id: - type: string - x-go-name: ServerId - server_ips: - type: string - x-go-name: ServerIps - server_pending_deleted: - type: boolean - x-go-name: ServerPendingDeleted - 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 - slots: - description: 机位 - type: string - x-go-name: Slots - sn: - description: 物理机序列号信息 - type: string - x-go-name: SN - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - spec: - type: object - x-go-name: Spec - status: - description: 资源状态 - type: string - x-go-name: Status - storage: - description: 存储大小 - format: int64 - type: integer - x-go-name: Storage - storage_commit_rate: - description: 存储超分率 - format: double - type: number - x-go-name: StorageCommitRate - storage_driver: - description: 存储驱动类型 - type: string - x-go-name: StorageDriver - storage_free: - description: 可用存储大小 - format: int64 - type: integer - x-go-name: StorageFree - storage_info: - description: 存储详情 - type: object - x-go-name: StorageInfo - storage_size: - description: 存储大小,单位Mb - format: int64 - type: integer - x-go-name: StorageSize - storage_type: - description: 存储类型 - type: string - x-go-name: StorageType - storage_used: - description: 已使用存储大小 - format: int64 - type: integer - x-go-name: StorageUsed - storage_virtual: - description: 虚拟存储大小 - format: int64 - type: integer - x-go-name: StorageVirtual - storage_waste: - description: 浪费存储大小(异常磁盘存储大小) - format: int64 - type: integer - x-go-name: StorageWaste - sys_error: - description: host init error info - type: string - x-go-name: SysError - sys_info: - description: 系统信息 - type: object - x-go-name: SysInfo - sys_warn: - description: host init warnning - type: string - x-go-name: SysWarn - uefi_info: - description: UEFI详情 - type: object - x-go-name: UefiInfo - 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 - uuid: - description: 主机UUID - type: string - x-go-name: Uuid - version: - description: host服务软件版本 - type: string - x-go-name: Version - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostOfflineInput: - properties: - Reason: - type: string - update_health_status: - type: boolean - x-go-name: UpdateHealthStatus - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostReserveCpusInput: - properties: - Cpus: - type: string - Mems: - type: string - disable_sched_load_balance: - type: boolean - x-go-name: DisableSchedLoadBalance - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostStorageCreateInput: - properties: - host_id: - type: string - x-go-name: HostId - mount_point: - type: string - x-go-name: MountPoint - storage_id: - type: string - x-go-name: StorageId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostTopologyOutput: - properties: - host_status: - type: string - x-go-name: HostStatus - host_type: - type: string - x-go-name: HostType - id: - type: string - x-go-name: Id - name: - type: string - x-go-name: Name - networks: - items: - $ref: '#/definitions/HostnetworkTopologyOutput' - type: array - x-go-name: Networks - schedtags: - items: - $ref: '#/definitions/SchedtagShortDescDetails' - type: array - x-go-name: Schedtags - status: - type: string - x-go-name: Status - storages: - items: - $ref: '#/definitions/StorageShortDesc' - type: array - x-go-name: Storages - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostUpdateInput: - properties: - access_ip: - description: 物理机管理口IP - type: string - x-go-name: AccessIp - access_mac: - description: 物理机管理口MAC - type: string - x-go-name: AccessMac - access_net: - description: 物理机管理口IP子网 - type: string - x-go-name: AccessNet - access_wire: - description: 物理机管理口二次网络 - type: string - x-go-name: AccessWire - boot_mode: - description: 主机启动模式, 可能值位PXE和ISO - type: string - x-go-name: BootMode - cpu_architecture: - description: CPU架构 - type: string - x-go-name: CpuArchitecture - cpu_cache: - description: CPU缓存大小,单位KB - type: string - x-go-name: CpuCache - cpu_cmtbound: - description: CPU超分比 - format: float - type: number - x-go-name: CpuCmtbound - cpu_count: - description: CPU核数 - format: int64 - type: integer - x-go-name: CpuCount - cpu_desc: - description: CPU描述信息 - type: string - x-go-name: CpuDesc - cpu_mhz: - description: CPU频率 - format: int64 - type: integer - x-go-name: CpuMhz - cpu_microcode: - description: CPUMicrocode - type: string - x-go-name: CpuMicrocode - cpu_reserved: - description: 预留CPU大小 - format: int64 - type: integer - x-go-name: CpuReserved - description: - description: 资源描述 - type: string - x-go-name: Description - enable_pxe_boot: - description: 是否允许PXE启动 - type: boolean - x-go-name: EnablePxeBoot - host_type: - description: 宿主机类型 - type: string - x-go-name: HostType - hostname: - description: |- - 主机名 - 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 - 字符长度2-60个字符 - Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 - 若输入为空，则会根据资源名称自动生成主机名 - 输入不为空则会自动剔除不符合规则的字符, 并进行校验 - 若长度大于允许的最大长度，会自动截取 - type: string - x-go-name: Hostname - ipmi_cdrom_boot: - description: Cdrom boot support - type: boolean - x-go-name: IpmiCdromBoot - ipmi_info: - description: IPMI info - type: object - x-go-name: IpmiInfo - ipmi_ip_addr: - description: ip address - type: string - x-go-name: IpmiIpAddr - ipmi_lan_channel: - description: lan channel - format: int64 - type: integer - x-go-name: IpmiLanChannel - ipmi_password: - description: password - type: string - x-go-name: IpmiPassword - ipmi_present: - description: presence - type: boolean - x-go-name: IpmiPresent - ipmi_pxe_boot: - description: ipmi_pxe_boot - type: boolean - x-go-name: IpmiPxeBoot - ipmi_redfish_api: - description: Redfish API support - type: boolean - x-go-name: IpmiRedfishApi - ipmi_username: - description: username - type: string - x-go-name: IpmiUsername - ipmi_verified: - description: verified - type: boolean - x-go-name: IpmiVerified - is_baremetal: - description: 是否为裸金属 - type: boolean - x-go-name: IsBaremetal - manager_uri: - description: 物理机管理URI - type: string - x-go-name: ManagerUri - mem_cmtbound: - description: 内存超分比 - format: float - type: number - x-go-name: MemCmtbound - mem_reserved: - description: 预留内存大小(单位MB) - type: string - x-go-name: MemReserved - mem_size: - description: 内存大小(单位MB) - type: string - x-go-name: MemSize - name: - description: 资源名称 - type: string - x-go-name: Name - node_count: - description: 物理CPU颗数 - format: int8 - type: integer - x-go-name: NodeCount - ovn_version: - description: OVN软件版本 - type: string - x-go-name: OvnVersion - page_size_kb: - description: 页大小 - format: int64 - type: integer - x-go-name: PageSizeKB - rack: - description: 机架 - type: string - x-go-name: Rack - slots: - description: 机位 - type: string - x-go-name: Slots - sn: - description: 物理机序列号信息 - type: string - x-go-name: SN - storage_driver: - description: 存储驱动类型 - type: string - x-go-name: StorageDriver - storage_info: - description: 存储详情 - type: object - x-go-name: StorageInfo - storage_size: - description: 存储大小,单位Mb - format: int64 - type: integer - x-go-name: StorageSize - storage_type: - description: 存储类型 - type: string - x-go-name: StorageType - sys_info: - description: 系统信息 - type: object - x-go-name: SysInfo - uuid: - description: 主机UUID - type: string - x-go-name: Uuid - version: - description: host服务软件版本 - type: string - x-go-name: Version - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostnetworkDetails: - properties: - baremetal: - description: |- - 裸金属服务器名称 - Deprecated - type: string - x-go-name: Baremetal - baremetal_id: - description: 宿主机ID - type: string - x-go-name: BaremetalId - 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 - host: - description: 宿主机名称 - type: string - x-go-name: Host - ip_addr: - description: IP地址 - type: string - x-go-name: IpAddr - mac_addr: - description: MAC地址 - type: string - x-go-name: MacAddr - network: - description: IP子网名称 - type: string - x-go-name: Network - network_id: - description: 网络ID - type: string - x-go-name: NetworkId - nic_type: - type: string - x-go-name: NicType - row_id: - format: int64 - type: integer - x-go-name: RowId - 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 - wire: - description: 二层网络名称 - type: string - x-go-name: Wire - wire_id: - description: 二层网络ID - type: string - x-go-name: WireId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostnetworkTopologyOutput: - properties: - ip_addr: - type: string - x-go-name: IpAddr - mac_addr: - type: string - x-go-name: MacAddr - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HoststorageDetails: - properties: - baremetal: - description: |- - 裸金属服务器名称 - Deprecated - type: string - x-go-name: Baremetal - 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 - capacity: - description: 存储大小 - format: int64 - type: integer - x-go-name: Capacity - cmtbound: - description: 超售比 - format: float - type: number - x-go-name: Cmtbound - config: - description: 配置信息 - type: object - x-go-name: Config - 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 - enabled: - description: 是否启用 - type: boolean - x-go-name: Enabled - free_capacity: - description: 可用存储大小 - format: int64 - type: integer - x-go-name: FreeCapacity - guest_disk_count: - format: int64 - type: integer - x-go-name: GuestDiskCount - host: - description: 宿主机名称 - type: string - x-go-name: Host - host_id: - description: 宿主机Id - type: string - x-go-name: HostId - imagecache_path: - description: 镜像缓存路径 - type: string - x-go-name: ImagecachePath - is_root_partition: - description: 是否是根分区 - type: boolean - x-go-name: IsRootPartition - medium_type: - description: 介质类型 - example: ssd - type: string - x-go-name: MediumType - mount_point: - description: |- - 挂载点 - nvme pci address - type: string - x-go-name: MountPoint - real_capacity: - description: 真实容量大小 - format: int64 - type: integer - x-go-name: RealCapacity - row_id: - format: int64 - type: integer - x-go-name: RowId - storage: - description: 存储名称 - type: string - x-go-name: Storage - storage_conf: - description: 存储配置信息 - type: object - x-go-name: StorageConf - storage_id: - description: 存储Id - type: string - x-go-name: StorageId - storage_type: - description: 存储类型 - example: local - type: string - x-go-name: StorageType - storagecache_id: - description: 存储缓存Id - type: string - x-go-name: StoragecacheId - 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 - used_capacity: - description: 已使用存储大小 - format: int64 - type: integer - x-go-name: UsedCapacity - waste_capacity: - description: 浪费存储大小(异常磁盘总大小) - format: int64 - type: integer - x-go-name: WasteCapacity - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - HostwireDetails: - properties: - bandwidth: - description: 带宽大小 - format: int64 - type: integer - x-go-name: Bandwidth - baremetal: - description: |- - 裸金属服务器名称 - Deprecated - type: string - x-go-name: Baremetal - bridge: - type: string - x-go-name: Bridge - 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 - host: - description: 宿主机名称 - type: string - x-go-name: Host - host_id: - description: 宿主机Id - type: string - x-go-name: HostId - interface: - description: 接口名称 - type: string - x-go-name: Interface - is_master: - description: 是否是主地址 - type: boolean - x-go-name: IsMaster - mac_addr: - description: MAC地址 - type: string - x-go-name: MacAddr - row_id: - format: int64 - type: integer - x-go-name: RowId - 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 - wire: - description: 二层网络名称 - type: string - x-go-name: Wire - wire_id: - description: 二层网络Id - type: string - x-go-name: WireId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IPAllocationDirection: - type: string - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IPv6GatewayCreateInput: - 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IPv6GatewayDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - 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 - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IPv6GatewayUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IdNameDetails: - 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 - InstanceBackupDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - backup_storage_name: - description: 存储类型 - type: string - x-go-name: BackupStorageName - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - delete_fail_reason: - $ref: '#/definitions/Error' - disk_backups: - description: 硬盘备份详情 - items: - $ref: '#/definitions/SSimpleBackup' - type: array - x-go-name: DiskBackups - encrypt_alg: - description: 加密算法，aes-256 or sm4 - type: string - x-go-name: EncryptAlg - encrypt_key: - description: 秘钥名称 - type: string - x-go-name: EncryptKey - encrypt_key_user: - description: 密钥用户 - type: string - x-go-name: EncryptKeyUser - encrypt_key_user_domain: - description: 密钥用户域 - type: string - x-go-name: EncryptKeyUserDomain - encrypt_key_user_domain_id: - description: 密钥用户域ID - type: string - x-go-name: EncryptKeyUserDomainId - encrypt_key_user_id: - description: 密钥用户ID - type: string - x-go-name: EncryptKeyUserId - environment: - description: Environment - type: string - x-go-name: Environment - guest: - description: 云主机名称 - type: string - x-go-name: Guest - guest_status: - description: 云主机状态 - type: string - x-go-name: GuestStatus - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - size: - description: 主机快照大小 - format: int64 - type: integer - x-go-name: Size - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InstanceBackupManagerCreateFromPackageInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - BackupStorageId: - type: string - PackageName: - type: string - 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InstanceBackupManagerSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InstanceBackupPackInput: - properties: - PackageName: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InstanceBackupRecoveryInput: - properties: - Name: - description: 'description: name of guest' - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InstanceGroupDetail: - 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 - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - force_dispersion: - type: boolean - x-go-name: ForceDispersion - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - granularity: - description: the upper limit number of guests with this group in a host - format: int64 - type: integer - x-go-name: Granularity - guest_count: - description: 云主机数量 - format: int64 - type: integer - x-go-name: GuestCount - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - 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 - network: - description: Attached Network - type: string - x-go-name: Network - network_id: - description: Attached NetworkId - type: string - x-go-name: NetworkId - parent_id: - type: string - x-go-name: ParentId - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - sched_strategy: - description: 调度策略 - type: string - x-go-name: SchedStrategy - service_type: - description: 服务类型 - type: string - x-go-name: ServiceType - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - vip_eip: - description: EIP of VIP - type: string - x-go-name: VipEip - vips: - description: VIP - items: - type: string - type: array - x-go-name: Vips - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InstanceSnapshotDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - auto_delete: - description: 是否自动删除 - type: boolean - x-go-name: AutoDelete - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - encrypt_alg: - description: 加密算法，aes-256 or sm4 - type: string - x-go-name: EncryptAlg - encrypt_key: - description: 秘钥名称 - type: string - x-go-name: EncryptKey - encrypt_key_id: - description: 加密密钥ID - type: string - x-go-name: EncryptKeyId - encrypt_key_user: - description: 密钥用户 - type: string - x-go-name: EncryptKeyUser - encrypt_key_user_domain: - description: 密钥用户域 - type: string - x-go-name: EncryptKeyUserDomain - encrypt_key_user_domain_id: - description: 密钥用户域ID - type: string - x-go-name: EncryptKeyUserDomainId - encrypt_key_user_id: - description: 密钥用户ID - type: string - x-go-name: EncryptKeyUserId - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - guest: - description: 云主机名称 - type: string - x-go-name: Guest - guest_id: - description: 云主机Id - type: string - x-go-name: GuestId - guest_status: - description: 云主机状态 - type: string - x-go-name: GuestStatus - id: - description: 资源UUID - type: string - x-go-name: Id - image_id: - description: 镜像ID - type: string - x-go-name: ImageId - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - instance_type: - description: 套餐名称 - type: string - x-go-name: InstanceType - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - keypair_id: - description: 秘钥Id - type: string - x-go-name: KeypairId - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - memory_file_checksum: - description: 内存文件校验和 - type: string - x-go-name: MemoryFileChecksum - memory_file_host_id: - description: 内存文件所在宿主机 - type: string - x-go-name: MemoryFileHostId - memory_file_path: - description: 内存文件路径 - type: string - x-go-name: MemoryFilePath - memory_size_mb: - description: 内存文件大小 - format: int64 - type: integer - x-go-name: MemorySizeMB - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - os_arch: - description: 操作系统 CPU 架构 - example: x86 arm - type: string - x-go-name: OsArch - os_type: - description: 操作系统类型 - type: string - x-go-name: OsType - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - properties: - additionalProperties: - type: string - type: object - x-go-name: Properties - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - ref_count: - description: 引用次数 - format: int64 - type: integer - x-go-name: RefCount - sec_groups: - description: 安全组 - type: object - x-go-name: SecGroups - server_config: - description: 云主机配置 - type: object - x-go-name: ServerConfig - server_metadata: - description: 云主机标签 - type: object - x-go-name: ServerMetadata - size: - description: 主机快照大小 - format: int64 - type: integer - x-go-name: Size - size_mb: - description: 主机快照磁盘容量和 - format: int64 - type: integer - x-go-name: SizeMb - snapshots: - description: 快照列表 - items: - $ref: '#/definitions/SimpleSnapshot' - type: array - x-go-name: Snapshots - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - storage_type: - description: 存储类型 - type: string - x-go-name: StorageType - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - with_memory: - description: 是否保存内存 - type: boolean - x-go-name: WithMemory - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InterVpcNetworkAddVpcInput: - properties: - vpc_id: - description: |- - 待加入的vpc id - vpc和当前vpc互联所必须是同一平台，且运营平台一致，例如aws中国区不能和aws国际区运营平台不一致 - 可以通过 /vpcs?usable_for_inter_vpc_network_id=<当前vpc互联id> 过滤可以加入的vpc列表 - type: string - x-go-name: VpcId - required: - - vpc_id - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InterVpcNetworkCreateInput: - 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 - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager_id: - type: string - x-go-name: ManagerId - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InterVpcNetworkDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - 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' - vpc_count: - format: int64 - type: integer - x-go-name: VpcCount - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InterVpcNetworkRemoveVpcInput: - properties: - VpcId: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InterVpcNetworkRouteSetDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - update_fail_reason: - $ref: '#/definitions/Error' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InterVpcNetworkRouteSetDisableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InterVpcNetworkRouteSetEnableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - InterVpcNetworkSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IsolateDeviceDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - addr: - description: '# pci address of `Bus:Device.Function` format, or usb bus address - of `bus.addr`' - type: string - x-go-name: Addr - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - 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 - dev_type: - description: |- - # PCI / GPU-HPC / GPU-VGA / USB / NIC - 设备类型 - type: string - x-go-name: DevType - disk_index: - description: guest disk index - format: uint8 - type: integer - x-go-name: DiskIndex - environment: - description: Environment - type: string - x-go-name: Environment - guest: - description: 云主机名称 - type: string - x-go-name: Guest - guest_id: - description: 云主机Id - type: string - x-go-name: GuestId - guest_status: - description: 云主机状态 - type: string - x-go-name: GuestStatus - host: - description: 宿主机名称 - type: string - x-go-name: Host - host_enabled: - description: 宿主是否启用 - type: boolean - x-go-name: HostEnabled - host_id: - type: string - x-go-name: HostId - host_service_status: - description: 宿主机服务状态` - type: string - x-go-name: HostServiceStatus - host_sn: - description: 宿主机序列号 - type: string - x-go-name: HostSN - host_status: - description: 宿主机状态 - type: string - x-go-name: HostStatus - host_type: - description: 宿主机类型 - type: string - x-go-name: HostType - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - model: - description: '# Specific device name read from lspci command, e.g. `Tesla - K40m` ...' - type: string - x-go-name: Model - name: - description: 资源名称 - type: string - x-go-name: Name - network_index: - description: guest network index - format: uint8 - type: integer - x-go-name: NetworkIndex - nvme_size_mb: - description: NVME disk size - format: int64 - type: integer - x-go-name: NvmeSizeMB - ovs_offload_interface: - description: Offload interface name - type: string - x-go-name: OvsOffloadInterface - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - reserved_cpu: - description: reserved cpu count for isolated device - format: int64 - type: integer - x-go-name: ReservedCpu - reserved_memory: - description: reserved memory size for isolated device - format: int64 - type: integer - x-go-name: ReservedMemory - reserved_storage: - description: reserved storage size for isolated device - format: int64 - type: integer - x-go-name: ReservedStorage - 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 - vendor_device_id: - type: string - x-go-name: VendorDeviceId - wire_id: - description: Nic wire id - type: string - x-go-name: WireId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 归属可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IsolatedDeviceConfig: - properties: - dev_type: - type: string - x-go-name: DevType - disk_index: - format: int8 - type: integer - x-go-name: DiskIndex - id: - type: string - x-go-name: Id - index: - format: int64 - type: integer - x-go-name: Index - model: - type: string - x-go-name: Model - network_index: - format: int8 - type: integer - x-go-name: NetworkIndex - vendor: - type: string - x-go-name: Vendor - wire_id: - type: string - x-go-name: WireId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IsolatedDeviceCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - addr: - description: |- - PCI地址 - # pci address of `Bus:Device.Function` format, or usb bus address of `bus.addr` - type: string - x-go-name: Addr - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dev_type: - description: 设备类型USB/GPU - example: GPU - type: string - x-go-name: DevType - 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 - host_id: - description: 宿主机或物理机（ID或Name） - type: string - x-go-name: HostId - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - model: - description: |- - 设备型号 - # Specific device name read from lspci command, e.g. `Tesla K40m` ... - type: string - x-go-name: Model - 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 - reserved_cpu: - description: GPU 预留CPU - format: int64 - type: integer - x-go-name: ReservedCpu - reserved_memory: - description: GPU 预留内存 - format: int64 - type: integer - x-go-name: ReservedMemory - reserved_storage: - description: GPU 预留磁盘 - format: int64 - type: integer - x-go-name: ReservedStorage - vendor_device_id: - description: 设备VendorId - type: string - x-go-name: VendorDeviceId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IsolatedDeviceModelCreateInput: - 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 - dev_type: - description: 设备类型 - example: NPU - type: string - x-go-name: DevType - device_id: - description: 设备DeviceId - type: string - x-go-name: DeviceId - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - hosts: - description: hosts scan isolated device after isolated_device_model created - items: - type: string - type: array - x-go-name: Hosts - hot_pluggable: - description: 支持热插拔 HotPluggable - type: boolean - x-go-name: HotPluggable - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - model: - description: 设备型号 - type: string - x-go-name: Model - vendor_id: - description: 设备VendorId - type: string - x-go-name: VendorId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IsolatedDeviceModelUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - dev_type: - description: 设备类型 - example: NPU - type: string - x-go-name: DevType - device_id: - description: 设备DeviceId - type: string - x-go-name: DeviceId - hot_pluggable: - description: 支持热插拔 HotPluggable - type: boolean - x-go-name: HotPluggable - model: - description: 设备型号 - type: string - x-go-name: Model - vendor_id: - description: 设备VendorId - type: string - x-go-name: VendorId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IsolatedDeviceReservedResourceInput: - properties: - reserved_cpu: - description: GPU 预留CPU - format: int64 - type: integer - x-go-name: ReservedCpu - reserved_memory: - description: GPU 预留内存 - format: int64 - type: integer - x-go-name: ReservedMemory - reserved_storage: - description: GPU 预留磁盘 - format: int64 - type: integer - x-go-name: ReservedStorage - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - IsolatedDeviceUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - dev_type: - type: string - x-go-name: DevType - name: - description: 资源名称 - type: string - x-go-name: Name - reserved_cpu: - description: GPU 预留CPU - format: int64 - type: integer - x-go-name: ReservedCpu - reserved_memory: - description: GPU 预留内存 - format: int64 - type: integer - x-go-name: ReservedMemory - reserved_storage: - description: GPU 预留磁盘 - format: int64 - type: integer - x-go-name: ReservedStorage - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - JoinResourceBaseCreateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - JointResourceBaseDetails: - 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 - JointResourceBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - KafkaCreateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KafkaDetails: - description: 资源返回详情 - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - network: - description: IP子网名称 - type: string - x-go-name: Network - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KeypairCreateInput: - 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 - owner_id: - description: 本地用户Id，若为空则使用当前用户Id作为此参数值 - type: string - x-go-name: OwnerId - public_key: - description: 公钥内容,若为空则自动生成公钥 - type: string - x-go-name: PublicKey - scheme: - default: RSA - description: 秘钥类型 - enum: - - RSA - type: string - x-go-name: Scheme - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KeypairDetails: - 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 - fingerprint: - description: 指纹信息 - example: 1d:3a:83:4a:a1:f3:75:97:ec:d1:ef:f8:3f:a7:5d:9e - type: string - x-go-name: Fingerprint - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - linked_guest_count: - description: 关联云主机次数 - format: int64 - type: integer - x-go-name: LinkedGuestCount - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - owner_id: - description: 本地用户Id - type: string - x-go-name: OwnerId - owner_name: - description: 用户名称 - type: string - x-go-name: OwnerName - private_key: - description: 私钥 - type: string - x-go-name: PrivateKey - private_key_len: - description: 私钥长度 - format: int64 - type: integer - x-go-name: PrivateKeyLen - public_key: - description: 公钥 - type: string - x-go-name: PublicKey - scheme: - description: 加密类型 - example: RSA - type: string - x-go-name: Scheme - 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/compute - KubeClusterCreateInput: - 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 - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - enabled: - description: 该资源是否被管理员*人为*启用或者禁用 - type: boolean - x-go-name: Enabled - external_access_mode: - description: Vpc外网访问模式 - type: string - x-go-name: ExternalAccessMode - 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 - network_ids: - $ref: '#/definitions/SKubeNetworkIds' - private_access: - type: boolean - x-go-name: PrivateAccess - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_access: - type: boolean - x-go-name: PublicAccess - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - role_name: - type: string - x-go-name: RoleName - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - version: - type: string - x-go-name: Version - vpc_id: - description: 关联VPC(ID或Name) - type: string - x-go-name: VpcId - required: - - name - - network_ids - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KubeClusterDeleteInput: - properties: - retain: - default: false - description: 是否保留集群关联的实例及slb - type: boolean - x-go-name: Retain - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KubeClusterDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - environment: - description: Environment - type: string - x-go-name: Environment - external_cluster_id: - description: 本地KubeserverId - type: string - x-go-name: ExternalClusterId - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - network_ids: - $ref: '#/definitions/SKubeNetworkIds' - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - version: - type: string - x-go-name: Version - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KubeClusterUpdateInput: - 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/compute - KubeNodeCreateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KubeNodeDetails: - properties: - DomainId: - type: string - 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 - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - 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' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KubeNodePoolCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - cloud_kube_cluster_id: - type: string - x-go-name: CloudKubeClusterId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - desired_instance_count: - default: 2 - description: 预期节点数量, 不得小于min_instance_count - format: int64 - type: integer - x-go-name: DesiredInstanceCount - 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 - instance_types: - $ref: '#/definitions/SInstanceTypes' - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - keypair_id: - description: 秘钥id，若不传，则使用系统级秘钥 - type: string - x-go-name: KeypairId - max_instance_count: - default: 2 - format: int64 - type: integer - x-go-name: MaxInstanceCount - min_instance_count: - default: 2 - format: int64 - type: integer - x-go-name: MinInstanceCount - 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 - network_ids: - $ref: '#/definitions/SKubeNetworkIds' - public_key: - description: 'swagger: ignore' - type: string - x-go-name: PublicKey - root_disk_size_gb: - format: int64 - type: integer - x-go-name: RootDiskSizeGb - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KubeNodePoolDetails: - properties: - DomainId: - type: string - 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 - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - 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' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KubeNodePoolUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - KubeNodeUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerAclCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - Fingerprint: - description: 'swagger: ignore' - type: string - acl_entries: - $ref: '#/definitions/SAclEntries' - 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 - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerAclDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - acl_entries: - $ref: '#/definitions/SAclEntries' - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - fingerprint: - type: string - x-go-name: Fingerprint - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_dirty: - description: 是否变化 - type: boolean - x-go-name: IsDirty - 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 - lb_listener_count: - format: int64 - type: integer - x-go-name: LbListenerCount - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - LoadbalancerAclPatchInput: - properties: - adds: - items: - $ref: '#/definitions/SAclEntry' - type: array - x-go-name: Adds - dels: - items: - $ref: '#/definitions/SAclEntry' - type: array - x-go-name: Dels - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerAclUpdateInput: - properties: - Fingerprint: - description: 'swagger: ignore' - type: string - acl_entries: - $ref: '#/definitions/SAclEntries' - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerAgentDeployInput: - properties: - DeployMethod: - type: string - Host: - $ref: '#/definitions/Host' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerAgentDetails: - 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 - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - cluster: - description: 负载均衡集群名称 - type: string - x-go-name: Cluster - cluster_id: - description: 归属LB集群 - type: string - x-go-name: ClusterId - 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 - deployment: - $ref: '#/definitions/SLoadbalancerAgentDeployment' - description: - description: 资源描述信息 - type: string - x-go-name: Description - ha_state: - type: string - x-go-name: HaState - hb_last_seen: - description: LB_HA_STATE_UNKNOWN - format: date-time - type: string - x-go-name: HbLastSeen - hb_timeout: - format: int64 - type: integer - x-go-name: HbTimeout - id: - description: 资源UUID - type: string - x-go-name: Id - interface: - type: string - x-go-name: Interface - ip: - type: string - x-go-name: IP - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - loadbalancer_acls: - format: date-time - type: string - x-go-name: LoadbalancerAcls - loadbalancer_backend_groups: - format: date-time - type: string - x-go-name: LoadbalancerBackendGroups - loadbalancer_backends: - format: date-time - type: string - x-go-name: LoadbalancerBackends - loadbalancer_certificates: - format: date-time - type: string - x-go-name: LoadbalancerCertificates - loadbalancer_listener_rules: - format: date-time - type: string - x-go-name: LoadbalancerListenerRules - loadbalancer_listeners: - format: date-time - type: string - x-go-name: LoadbalancerListeners - loadbalancer_networks: - format: date-time - type: string - x-go-name: LoadbalancerNetworks - loadbalancers: - format: date-time - type: string - x-go-name: Loadbalancers - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - networks: - format: date-time - type: string - x-go-name: Networks - params: - $ref: '#/definitions/SLoadbalancerAgentParams' - priority: - format: int64 - type: integer - x-go-name: Priority - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - 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 - version: - type: string - x-go-name: Version - vpc: - description: VPC名称 - type: string - x-go-name: Vpc - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - wire: - description: 二层网络(WIRE)的名称 - type: string - x-go-name: Wire - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerAgentJoinClusterInput: - properties: - cluster_id: - type: string - x-go-name: ClusterId - priority: - format: int64 - type: integer - x-go-name: Priority - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerAgentLeaveClusterInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerAssociateEipInput: - properties: - eip_id: - description: 弹性公网IP的ID - type: string - x-go-name: EipId - ip_addr: - description: 弹性IP映射的内网IP地址，可选 - type: string - x-go-name: IpAddr - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerBackendCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - address: - type: string - x-go-name: Address - backend: - description: 'swagger: ignore' - type: string - x-go-name: Backend - backend_group: - description: 'swagger: ignore' - type: string - x-go-name: BackendGroup - backend_group_id: - type: string - x-go-name: BackendGroupId - backend_id: - type: string - x-go-name: BackendId - backend_type: - type: string - x-go-name: BackendType - 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 - port: - format: int64 - type: integer - x-go-name: Port - send_proxy: - type: string - x-go-name: SendProxy - ssl: - type: string - x-go-name: Ssl - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - weight: - format: int64 - type: integer - x-go-name: Weight - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerBackendDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - address: - type: string - x-go-name: Address - backend_group: - description: 负载均衡后端组名称 - type: string - x-go-name: BackendGroup - backend_group_id: - description: 负载均衡后端组ID - type: string - x-go-name: BackendGroupId - backend_id: - type: string - x-go-name: BackendId - backend_role: - type: string - x-go-name: BackendRole - backend_type: - type: string - x-go-name: BackendType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - loadbalancer: - description: 负载均衡名称 - type: string - x-go-name: Loadbalancer - loadbalancer_id: - description: 负载均衡ID - type: string - x-go-name: LoadbalancerId - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - port: - format: int64 - type: integer - x-go-name: Port - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - send_proxy: - type: string - x-go-name: SendProxy - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - ssl: - type: string - x-go-name: Ssl - status: - description: 资源状态 - type: string - x-go-name: Status - tenant_id: - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - weight: - format: int64 - type: integer - x-go-name: Weight - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerBackendGroupCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - backends: - items: - properties: - Address: - type: string - BackendRole: - type: string - BackendType: - type: string - ExternalId: - type: string - HostName: - type: string + AccessGroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AccessGroupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AccessGroupRuleCreateInput: + properties: + AccessGroupId: + type: string + Description: + type: string + Priority: + format: int64 + type: integer + RWAccessType: + type: string + Source: + type: string + UserAccessType: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AccessGroupRuleDetails: + properties: + access_group: + description: 权限组名称 + type: string + x-go-name: AccessGroup + 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/compute + AccessGroupRuleUpdateInput: + properties: + Description: + type: string + Priority: + format: int64 + type: integer + RWAccessType: + type: string + Source: + type: string + UserAccessType: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AppDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AppEnvironmentDetails: + 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 + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AttachNetworkInput: + properties: + disable_sync_config: + description: 添加后不立即同步配置 + type: boolean + x-go-name: DisableSyncConfig + net_desc: + description: 添加的网卡的配置 + items: + type: string + type: array + x-go-name: NetDesc + nets: + description: 添加的网卡的配置 + items: + $ref: '#/definitions/NetworkConfig' + type: array + x-go-name: Nets + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AutoRenewInput: + properties: + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + BackupStorageCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + capacity_mb: + description: 'description: Capacity size in MB' + format: int64 + type: integer + x-go-name: CapacityMb + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + 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 + nfs_host: + description: 'description: host of nfs, storage_type 为 nfs 时, 此参数必传' + example: 192.168.222.2 + type: string + x-go-name: NfsHost + nfs_shared_dir: + description: 'description: shared dir of nfs, storage_type 为 nfs 时, 此参数必传' + example: /nfs_root/ + type: string + x-go-name: NfsSharedDir + object_access_key: + description: 'description: access key of object storage' + type: string + x-go-name: ObjectAccessKey + object_bucket_url: + description: 'description: access url of object storage bucket' + example: https://qxxxxxo.tos-cn-beijing.volces.com + type: string + x-go-name: ObjectBucketUrl + object_secret: + description: 'description: secret of object storage' + type: string + x-go-name: ObjectSecret + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_type: + description: 'description: storage type' + enum: + - nfs + type: string + x-go-name: StorageType + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BackupStorageDetails: + 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 + nfs_host: + description: 'description: host of nfs, storage_type 为 nfs 时, 此参数必传' + example: 192.168.222.2 + type: string + x-go-name: NfsHost + nfs_shared_dir: + description: 'description: shared dir of nfs, storage_type 为 nfs 时, 此参数必传' + example: /nfs_root/ + type: string + x-go-name: NfsSharedDir + object_access_key: + description: 'description: access key of object storage' + type: string + x-go-name: ObjectAccessKey + object_bucket_url: + description: 'description: access url of object storage bucket' + example: https://qxxxxxo.tos-cn-beijing.volces.com + type: string + x-go-name: ObjectBucketUrl + object_secret: + description: 'description: secret of object storage' + type: string + x-go-name: ObjectSecret + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + 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' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BackupStorageUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + nfs_host: + description: 'description: host of nfs, storage_type 为 nfs 时, 此参数必传' + example: 192.168.222.2 + type: string + x-go-name: NfsHost + nfs_shared_dir: + description: 'description: shared dir of nfs, storage_type 为 nfs 时, 此参数必传' + example: /nfs_root/ + type: string + x-go-name: NfsSharedDir + object_access_key: + description: 'description: access key of object storage' + type: string + x-go-name: ObjectAccessKey + object_bucket_url: + description: 'description: access url of object storage bucket' + example: https://qxxxxxo.tos-cn-beijing.volces.com + type: string + x-go-name: ObjectBucketUrl + object_secret: + description: 'description: secret of object storage' + type: string + x-go-name: ObjectSecret + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BaremetalDiskConfig: + properties: + adapter: + format: int64 + type: integer + x-go-name: Adapter + cachedbadbbu: + type: boolean + x-go-name: Cachedbadbbu + conf: + description: raid config + type: string + x-go-name: Conf + count: + format: int64 + type: integer + x-go-name: Count + direct: + type: boolean + x-go-name: Direct + driver: + type: string + x-go-name: Driver + ra: + type: boolean + x-go-name: RA + range: + items: + format: int64 + type: integer + type: array + x-go-name: Range + size: + items: + format: int64 + type: integer + type: array + x-go-name: Size + splits: + type: string + x-go-name: Splits + strip: + format: int64 + type: integer + x-go-name: Strip + type: + description: |- + Index int `json:"index"` + disk type + type: string + x-go-name: Type + wt: + type: boolean + x-go-name: WT + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BaremetalagentCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + access_ip: + type: string + x-go-name: AccessIp + agent_type: + type: string + x-go-name: AgentType + 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 + manager_uri: + type: string + x-go-name: ManagerUri + 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 + version: + type: string + x-go-name: Version + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BaremetalagentDetails: + properties: + access_ip: + type: string + x-go-name: AccessIp + agent_type: + type: string + x-go-name: AgentType + 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 + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + 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 + disable_image_cache: + type: boolean + x-go-name: DisableImageCache + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager_uri: + type: string + x-go-name: ManagerUri + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + status: + type: string + x-go-name: Status + storagecache_id: + type: string + x-go-name: StoragecacheId + 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 + version: + type: string + x-go-name: Version + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BaremetalagentUpdateInput: + properties: + access_ip: + type: string + x-go-name: AccessIp + agent_type: + type: string + x-go-name: AgentType + description: + description: 资源描述 + type: string + x-go-name: Description + manager_uri: + type: string + x-go-name: ManagerUri + name: + description: 资源名称 + type: string + x-go-name: Name + version: + type: string + x-go-name: Version + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketAclInput: + properties: + Acl: + $ref: '#/definitions/TBucketACLType' + Key: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketCORSRule: + properties: + AllowedHeaders: + items: + type: string + type: array + AllowedMethods: + items: + type: string + type: array + AllowedOrigins: + description: 允许的源站，可以是* + items: + type: string + type: array + ExposeHeaders: + items: + type: string + type: array Id: - type: string + description: 规则区别标识 + type: string + MaxAgeSeconds: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketCORSRuleDeleteInput: + properties: + Id: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketCORSRules: + properties: + data: + items: + $ref: '#/definitions/BucketCORSRule' + type: array + x-go-name: Data + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + 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 + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_class: + type: string + x-go-name: StorageClass + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketDetails: + properties: + access_urls: + description: 访问URL列表 + items: + $ref: '#/definitions/SBucketAccessUrl' + type: array + x-go-name: AccessUrls + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + acl: + type: string + x-go-name: Acl + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + location: + type: string + x-go-name: Location + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + object_cnt: + format: int64 + type: integer + x-go-name: ObjectCnt + object_cnt_limit: + format: int64 + type: integer + x-go-name: ObjectCntLimit + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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 + size_bytes: + format: int64 + type: integer + x-go-name: SizeBytes + size_bytes_limit: + format: int64 + type: integer + x-go-name: SizeBytesLimit + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_class: + type: string + x-go-name: StorageClass + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + BucketGetAclOutput: + properties: + acl: + description: ACL + type: string + x-go-name: Acl + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketGetObjectsOutput: + properties: + data: + description: 对象列表 + items: + $ref: '#/definitions/SCloudObject' + type: array + x-go-name: Data + marker_field: + description: 排序字段，总是key + example: key + type: string + x-go-name: MarkerField + marker_order: + description: 排序顺序，总是降序 + example: DESC + type: string + x-go-name: MarkerOrder + next_marker: + description: 下一页请求的paging_marker标识 + type: string + x-go-name: NextMarker + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketMetadataInput: + properties: + Key: + items: + type: string + type: array + Metadata: + $ref: '#/definitions/Header' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPerformDeleteInput: + properties: + keys: + description: 待删除对象KEY + items: + type: string + type: array + x-go-name: Keys + required: + - keys + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPerformMakedirInput: + properties: + key: + description: 目录对象KEY + type: string + x-go-name: Key + required: + - key + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPerformTempUrlInput: + properties: + expire_seconds: + description: 过期时间，单位秒 + format: int64 + type: integer + x-go-name: ExpireSeconds + key: + description: 对象KEY + type: string + x-go-name: Key + method: + description: 访问对象方法 + type: string + x-go-name: Method + required: + - key + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPerformTempUrlOutput: + properties: + url: + description: 生成的临时URL + type: string + x-go-name: Url + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPolicy: + properties: + Data: + items: + $ref: '#/definitions/BucketPolicyStatement' + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPolicyDeleteInput: + properties: + Id: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPolicyStatement: + properties: + Action: + description: 授权的行为 + items: + type: string + type: array + CannedAction: + description: Read|ReadWrite|FullControl + type: string + Condition: + additionalProperties: + additionalProperties: {} + type: object + description: 触发授权的条件 + type: object + Effect: + description: Allow|Deny + type: string + Id: + description: 根据index 生成 + type: string + Principal: + additionalProperties: + items: + type: string + type: array + description: 授权的目标主体 + type: object + PrincipalId: + description: 解析字段，主账号id:子账号id + items: + type: string + type: array + PrincipalNames: + additionalProperties: + type: string + description: map[主账号id:子账号id]子账号name + type: object + Resource: + description: 被授权的资源地址 + items: + type: string + type: array + ResourcePath: + description: 资源路径 + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPolicyStatementInput: + properties: + CannedAction: + description: Read|ReadWrite|FullControl + type: string + Effect: + description: Allow|Deny + type: string + IpEquals: + description: ip 条件 + items: + type: string + type: array + IpNotEquals: + items: + type: string + type: array + PrincipalId: + description: 主账号id:子账号id + items: + type: string + type: array + ResourcePath: + description: 被授权的资源地址,/* + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketRefererConf: + properties: + AllowEmptyRefer: + description: 是否允许空referer 访问 + type: boolean + DomainList: + description: 域名列表 + items: + type: string + type: array + RefererType: + description: |- + Referer Type + enmu: Black-List, White-List + type: string + enabled: + description: 是否开启 + type: boolean + x-go-name: Enabled + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketWebsiteConf: + properties: + ErrorDocument: + description: 错误时返回的文档 + type: string Index: - format: int64 - type: integer - Name: - type: string - Port: - format: int64 - type: integer - Weight: - format: int64 - type: integer - ZoneId: - type: string - type: object - type: array - x-go-name: Backends - 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 - loadbalancer: - description: 'swagger: ignore' - type: string - x-go-name: Loadbalancer - loadbalancer_id: - description: 负载均衡ID - type: string - x-go-name: LoadbalancerId - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - type: - type: string - x-go-name: Type - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerBackendGroupDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - lb_listener_count: - format: int64 - type: integer - x-go-name: LbListenerCount - loadbalancer: - description: 负载均衡名称 - type: string - x-go-name: Loadbalancer - loadbalancer_id: - description: 负载均衡ID - type: string - x-go-name: LoadbalancerId - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant_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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerBackendUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - port: - format: int64 - type: integer - x-go-name: Port - progress: - format: float - type: number - x-go-name: Progress - send_proxy: - type: string - x-go-name: SendPorxy - ssl: - type: string - x-go-name: Ssl - weight: - format: int64 - type: integer - x-go-name: Weight - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerCertificateCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - certificate: - type: string - x-go-name: Certificate - common_name: - description: 'swagger: ignore' - type: string - x-go-name: CommonName - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - fingerprint: - description: 'swagger: ignore' - type: string - x-go-name: Fingerprint - 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: 'description: indicate the resource is a system resource, which - is not visible to user' - 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 - not_after: - description: 'swagger: ignore' - format: date-time - type: string - x-go-name: NotAfter - not_before: - description: 'swagger: ignore' - format: date-time - type: string - x-go-name: NotBefore - private_key: - type: string - x-go-name: PrivateKey - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_key_algorithm: - description: 'swagger: ignore' - type: string - x-go-name: PublicKeyAlgorithm - public_key_bit_len: - description: 'swagger: ignore' - format: int64 - type: integer - x-go-name: PublicKeyBitLen - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - signature_algorithm: - description: 'swagger: ignore' - type: string - x-go-name: SignatureAlgorithm - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - subject_alternative_names: - description: 'swagger: ignore' - type: string - x-go-name: SubjectAlternativeNames - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerCertificateDetails: - 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 - 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 - domain_id: - description: 域Id - type: string - x-go-name: DomainId - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - fingerprint: - type: string - x-go-name: Fingerprint - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_complete: - description: 证书内容是否完整 - type: boolean - x-go-name: IsComplete - 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 - lb_listener_count: - format: int64 - type: integer - x-go-name: LbListenerCount - 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 - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - private_key: - type: string - x-go-name: PrivateKey - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - public_key_algorithm: - description: derived attributes - type: string - x-go-name: PublicKeyAlgorithm - public_key_bit_len: - format: int64 - type: integer - x-go-name: PublicKeyBitLen - 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 - signature_algorithm: - type: string - x-go-name: SignatureAlgorithm - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - subject_alternative_names: - type: string - x-go-name: SubjectAlternativeNames - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - LoadbalancerCertificateUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerClusterDetails: - 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 - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - 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 - 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 - params: - $ref: '#/definitions/SLoadbalancerClusterParams' - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - 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 - wire: - description: 二层网络(WIRE)的名称 - type: string - x-go-name: Wire - wire_id: - description: 二层网络ID - type: string - x-go-name: WireId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerCreateEipInput: - properties: - auto_dellocate: - description: auto_dellocate - type: boolean - x-go-name: AutoDellocate - bandwidth: - description: Bandwidth - format: int64 - type: integer - x-go-name: Bandwidth - bgp_type: - description: bgp_type - type: string - x-go-name: BgpType - charge_type: - description: 计费方式，traffic or bandwidth - type: string - x-go-name: ChargeType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - Networks: - description: |- - 多子网 - swagger: ignore - items: - type: string - type: array - address: - description: IP地址 - type: string - x-go-name: Address - address_type: - description: 地址类型 - type: string - x-go-name: AddressType - charge_type: - description: 计费类型 - type: string - x-go-name: ChargeType - cloudprovider_id: - description: 列出关联指定云订阅(ID或Name)的资源 - type: string - x-go-name: CloudproviderId - cloudregion_id: - description: 区域名称或ID - type: string - x-go-name: CloudregionId - cluster_id: - description: 负载均衡集群Id - type: string - x-go-name: ClusterId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - duration: - description: 包年包月时长 - type: string - x-go-name: Duration - egress_mbps: - description: 出口带宽 - format: int64 - type: integer - x-go-name: EgressMbps - eip: - description: 'swagger: ignore' - type: string - x-go-name: Eip - eip_auto_dellocate: - description: 是否跟随主机删除而自动释放 - type: boolean - x-go-name: EipAutoDellocate - eip_bgp_type: - description: 弹性公网IP线路类型 - type: string - x-go-name: EipBgpType - eip_bw: - description: |- - 弹性公网IP带宽 - 指定此参数后会创建新的弹性公网IP并绑定到新建的负载均衡 - format: int64 - type: integer - x-go-name: EipBw - eip_charge_type: - description: 弹性公网IP计费类型 - type: string - x-go-name: EipChargeType - eip_id: - description: EIP Id - type: string - x-go-name: EipId - external_access_mode: - description: Vpc外网访问模式 - type: string - x-go-name: ExternalAccessMode - 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - lb_info: - description: LB的其他配置信息 - type: object - x-go-name: LBInfo - loadbalancer_spec: - description: 套餐名称 - type: string - x-go-name: LoadbalancerSpec - 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 - network_id: - description: IP子网（ID或Name） - type: string - x-go-name: NetworkId - network_type: - description: 网络类型 - type: string - x-go-name: NetworkType - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - vpc_id: - description: 关联VPC(ID或Name) - type: string - x-go-name: VpcId - zone_1: - description: 从可用区1 - type: string - x-go-name: Zone1 - zone_id: - description: 可用区ID或名称 - example: zone1 - type: string - x-go-name: ZoneId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - address: - description: IP地址 - type: string - x-go-name: Address - address_type: - description: 地址类型 - type: string - x-go-name: AddressType - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - backend_group: - description: 后端服务器组名称 - type: string - x-go-name: BackendGroup - backend_group_id: - description: 默认后端服务器组Id - type: string - x-go-name: BackendGroupId - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - charge_type: - description: 计费类型 - type: string - x-go-name: ChargeType - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - cluster: - description: 负载均衡集群名称 - type: string - x-go-name: Cluster - cluster_id: - description: 归属LB集群 - type: string - x-go-name: ClusterId - 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 - disable_delete: - description: 是否开启删除保护 - example: true - type: boolean - x-go-name: DisableDelete - domain_id: - description: 域Id - type: string - x-go-name: DomainId - egress_mbps: - format: int64 - type: integer - x-go-name: EgressMbps - eip: - description: 公网IP地址 - type: string - x-go-name: Eip - eip_id: - type: string - x-go-name: EipId - eip_mode: - description: '公网IP地址类型: 弹性、非弹性' - example: public_ip - type: string - x-go-name: EipMode - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - lb_info: - description: LB的其他配置信息 - type: object - x-go-name: LBInfo - loadbalancer_spec: - description: 套餐名称 - type: string - x-go-name: LoadbalancerSpec - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - network: - description: IP子网名称 - type: string - x-go-name: Network - network_id: - type: string - x-go-name: NetworkId - network_type: - description: 网络类型 - type: string - x-go-name: NetworkType - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - wire: - description: 二层网络(WIRE)的名称 - type: string - x-go-name: Wire - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_1: - description: 备可用区 - type: string - x-go-name: Zone1 - zone_1_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: Zone1ExtId - zone_1_name: - description: 可用区名称 - example: 北京2区 - type: string - x-go-name: Zone1Name - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerDissociateEipInput: - properties: - auto_delete: - description: 是否自动释放 - type: boolean - x-go-name: AudoDelete - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerListenerCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - acl: - description: 'swagger: ignore' - type: string - x-go-name: Acl - acl_id: - type: string - x-go-name: AclId - acl_status: - type: string - x-go-name: AclStatus - acl_type: - type: string - x-go-name: AclType - backend_connect_timeout: - default: 5 - description: range 1-180 - format: int64 - type: integer - x-go-name: BackendConnectTimeout - backend_group: - description: 'swagger: ignore' - type: string - x-go-name: BackendGroup - backend_group_id: - type: string - x-go-name: BackendGroupId - backend_idle_timeout: - default: 90 - description: range 1-600 - format: int64 - type: integer - x-go-name: BackendIdleTimeout - certificate: - description: 'swagger: ignore' - type: string - x-go-name: Certificate - certificate_id: - type: string - x-go-name: CertificateId - client_idle_timeout: - default: 90 - description: range 1-600 - format: int64 - type: integer - x-go-name: ClientIdleTimeout - client_request_timeout: - default: 10 - description: range 1-600 - format: int64 - type: integer - x-go-name: ClientReqeustTimeout - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - egress_mbps: - format: int64 - type: integer - x-go-name: EgressMbps - enable_http2: - default: true - type: boolean - x-go-name: EnableHttp2 - 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 - gzip: - type: boolean - x-go-name: Gzip - health_check: - default: "on" - type: string - x-go-name: HealthCheck - health_check_fail: - default: 2 - description: 2-10 - format: int64 - type: integer - x-go-name: HealthCheckFail - health_check_http_code: - default: http_2xx,http_3xx - type: string - x-go-name: HealthCheckHttpCode - health_check_interval: - default: 30 - description: 5-300 - format: int64 - type: integer - x-go-name: HealthCheckInterval - health_check_path: - type: string - x-go-name: HealthCheckPath - health_check_rise: - default: 5 - description: 2-10 - format: int64 - type: integer - x-go-name: HealthCheckRise - health_check_timeout: - default: 5 - description: 2-120 - format: int64 - type: integer - x-go-name: HealthCheckTimeout - health_check_type: - enum: - - tcp - - ' udp' - - ' http' - type: string - x-go-name: HealthCheckType - http_request_rate: - format: int64 - type: integer - x-go-name: HttpRequestRate - http_request_rate_src: - format: int64 - type: integer - x-go-name: HttpRequestRatePerSrc - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - listener_port: - format: int64 - type: integer - x-go-name: ListenerPort - listener_type: - type: string - x-go-name: ListenerType - loadbalancer: - description: 'swagger: ignore' - type: string - x-go-name: Loadbalancer - loadbalancer_id: - description: 负载均衡ID - type: string - x-go-name: LoadbalancerId - 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 - redirect: - default: "off" - type: string - x-go-name: Redirect - redirect_code: - format: int64 - type: integer - x-go-name: RedirectCode - redirect_host: - type: string - x-go-name: RedirectHost - redirect_path: - type: string - x-go-name: RedirectPath - redirect_scheme: - type: string - x-go-name: RedirectScheme - scheduler: - type: string - x-go-name: Scheduler - send_proxy: - type: string - x-go-name: SendProxy - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - sticky_session: - type: string - x-go-name: StickySession - sticky_session_cookie: - type: string - x-go-name: StickySessionCookie - sticky_session_cookie_timeout: - format: int64 - type: integer - x-go-name: StickySessionCookieTimeout - sticky_session_type: - type: string - x-go-name: StickySessionType - string: - type: string - x-go-name: HealthCheckDomain - tls_cipher_policy: - type: string - x-go-name: TLSCipherPolicy - x_forwarded_for: - default: true - type: boolean - x-go-name: XForwardedFor - required: - - name - - listener_type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerListenerDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - acl: - description: 负载均衡ACL名称 - type: string - x-go-name: Acl - acl_id: - description: 本地Acl ID - type: string - x-go-name: AclId - acl_status: - type: string - x-go-name: AclStatus - acl_type: - type: string - x-go-name: AclType - backend_connect_timeout: - description: 连接空闲超时时间 - format: int64 - type: integer - x-go-name: BackendConnectTimeout - backend_group: - type: string - x-go-name: BackendGroup - backend_group_id: - type: string - x-go-name: BackendGroupId - backend_idle_timeout: - description: 后端连接超时时间 - format: int64 - type: integer - x-go-name: BackendIdleTimeout - backend_server_port: - format: int64 - type: integer - x-go-name: BackendServerPort - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - certificate: - description: 负载均衡证书名称 - type: string - x-go-name: Certificate - certificate_id: - description: 本地负载均衡证书ID - type: string - x-go-name: CertificateId - certificate_name: - type: string - x-go-name: CertificateName - client_idle_timeout: - description: 连接请求超时时间 - format: int64 - type: integer - x-go-name: ClientIdleTimeout - client_request_timeout: - format: int64 - type: integer - x-go-name: ClientRequestTimeout - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - 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 - egress_mbps: - format: int64 - type: integer - x-go-name: EgressMbps - enable_http2: - type: boolean - x-go-name: EnableHttp2 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - gzip: - description: 获取客户端真实IP - type: boolean - x-go-name: Gzip - health_check: - type: string - x-go-name: HealthCheck - health_check_domain: - type: string - x-go-name: HealthCheckDomain - health_check_exp: - description: UDP监听健康检查的请求串 - type: string - x-go-name: HealthCheckExp - health_check_fall: - description: 健康检查健康阈值 3秒 - format: int64 - type: integer - x-go-name: HealthCheckFall - health_check_http_code: - description: 健康检查路径 / - type: string - x-go-name: HealthCheckHttpCode - health_check_interval: - description: 健康检查超时时间 10秒 - format: int64 - type: integer - x-go-name: HealthCheckInterval - health_check_req: - type: string - x-go-name: HealthCheckReq - health_check_rise: - format: int64 - type: integer - x-go-name: HealthCheckRise - health_check_timeout: - description: 健康检查不健康阈值 15秒 - format: int64 - type: integer - x-go-name: HealthCheckTimeout - health_check_type: - description: 健康检查开启状态 on|off - type: string - x-go-name: HealthCheckType - health_check_uri: - description: 健康检查域名 yunion.cn - type: string - x-go-name: HealthCheckURI - http_request_rate: - format: int64 - type: integer - x-go-name: HTTPRequestRate - http_request_rate_per_src: - description: 限定监听接收请示速率 - format: int64 - type: integer - x-go-name: HTTPRequestRatePerSrc - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - listener_port: - format: int64 - type: integer - x-go-name: ListenerPort - listener_type: - type: string - x-go-name: ListenerType - loadbalancer: - description: 负载均衡名称 - type: string - x-go-name: Loadbalancer - loadbalancer_id: - description: 负载均衡ID - type: string - x-go-name: LoadbalancerId - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - redirect: - type: string - x-go-name: Redirect - redirect_code: - description: 跳转类型 - format: int64 - type: integer - x-go-name: RedirectCode - redirect_host: - description: 跳转uri scheme - type: string - x-go-name: RedirectHost - redirect_path: - description: 跳转时变更Host - type: string - x-go-name: RedirectPath - redirect_scheme: - description: 跳转HTTP code - type: string - x-go-name: RedirectScheme - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - scheduler: - type: string - x-go-name: Scheduler - send_proxy: - type: string - x-go-name: SendProxy - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - sticky_session: - type: string - x-go-name: StickySession - sticky_session_cookie: - description: Cookie处理方式 insert(植入cookie)|server(重写cookie) - type: string - x-go-name: StickySessionCookie - sticky_session_cookie_timeout: - description: Cookie名称 - format: int64 - type: integer - x-go-name: StickySessionCookieTimeout - sticky_session_type: - description: 会话保持开启状态 on|off - type: string - x-go-name: StickySessionType - tenant_id: - type: string - x-go-name: ProjectId - tls_cipher_policy: - type: string - x-go-name: TLSCipherPolicy - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - xforwarded_for: - type: boolean - x-go-name: XForwardedFor - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerListenerRuleCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - Redirect: - type: string - RedirectCode: - format: int64 - type: integer - RedirectHost: - type: string - RedirectPath: - type: string - RedirectScheme: - type: string - backend_group: - type: string - x-go-name: BackendGroup - backend_group_id: - type: string - x-go-name: BackendGroupId - conditon: - type: string - x-go-name: Condition - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - domain: - type: string - x-go-name: Domain - 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 - http_request_rate: - format: int64 - type: integer - x-go-name: HttpRequstRate - http_request_rate_per_sec: - format: int64 - type: integer - x-go-name: HttpRequstRatePerSec - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - listener: - description: 'swagger: ignore' - type: string - x-go-name: Listener - listener_id: - type: string - x-go-name: ListenerId - 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 - path: - type: string - x-go-name: Path - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerListenerRuleDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - backend_group: - type: string - x-go-name: BackendGroup - backend_group_id: - type: string - x-go-name: BackendGroupId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - condition: - type: string - x-go-name: Condition - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - health_check: - type: string - x-go-name: HealthCheck - health_check_domain: - type: string - x-go-name: HealthCheckDomain - health_check_exp: - description: UDP监听健康检查的请求串 - type: string - x-go-name: HealthCheckExp - health_check_fall: - description: 健康检查健康阈值 3秒 - format: int64 - type: integer - x-go-name: HealthCheckFall - health_check_http_code: - description: 健康检查路径 / - type: string - x-go-name: HealthCheckHttpCode - health_check_interval: - description: 健康检查超时时间 10秒 - format: int64 - type: integer - x-go-name: HealthCheckInterval - health_check_req: - type: string - x-go-name: HealthCheckReq - health_check_rise: - format: int64 - type: integer - x-go-name: HealthCheckRise - health_check_timeout: - description: 健康检查不健康阈值 15秒 - format: int64 - type: integer - x-go-name: HealthCheckTimeout - health_check_type: - description: 健康检查开启状态 on|off - type: string - x-go-name: HealthCheckType - health_check_uri: - description: 健康检查域名 yunion.cn - type: string - x-go-name: HealthCheckURI - http_request_rate: - format: int64 - type: integer - x-go-name: HTTPRequestRate - http_request_rate_per_src: - description: 限定监听接收请示速率 - format: int64 - type: integer - x-go-name: HTTPRequestRatePerSrc - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_default: - description: 默认转发策略，目前只有aws用到其它云都是false - type: boolean - x-go-name: IsDefault - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - listener: - description: 负载均衡监听器名称 - type: string - x-go-name: Listener - listener_id: - description: 负载均衡监听器ID - type: string - x-go-name: ListenerId - loadbalancer: - description: 负载均衡名称 - type: string - x-go-name: Loadbalancer - loadbalancer_id: - description: 负载均衡ID - type: string - x-go-name: LoadbalancerId - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - path: - type: string - x-go-name: Path - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - redirect: - type: string - x-go-name: Redirect - redirect_code: - description: 跳转类型 - format: int64 - type: integer - x-go-name: RedirectCode - redirect_host: - description: 跳转uri scheme - type: string - x-go-name: RedirectHost - redirect_path: - description: 跳转时变更Host - type: string - x-go-name: RedirectPath - redirect_scheme: - description: 跳转HTTP code - type: string - x-go-name: RedirectScheme - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant_id: - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerListenerRuleUpdateInput: - properties: - Redirect: - type: string - RedirectCode: - format: int64 - type: integer - RedirectHost: - type: string - RedirectPath: - type: string - RedirectScheme: - type: string - backend_group: - type: string - x-go-name: BackendGroup - backend_group_id: - type: string - x-go-name: BackendGroupId - conditon: - type: string - x-go-name: Condition - description: - description: 资源描述 - type: string - x-go-name: Description - domain: - type: string - x-go-name: Domain - http_request_rate: - format: int64 - type: integer - x-go-name: HttpRequstRate - http_request_rate_per_sec: - format: int64 - type: integer - x-go-name: HttpRequstRatePerSec - listener: - description: 'swagger: ignore' - type: string - x-go-name: Listener - listener_id: - type: string - x-go-name: ListenerId - name: - description: 资源名称 - type: string - x-go-name: Name - path: - type: string - x-go-name: Path - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerListenerUpdateInput: - properties: - acl: - description: 'swagger: ignore' - type: string - x-go-name: Acl - acl_id: - type: string - x-go-name: AclId - acl_status: - type: string - x-go-name: AclStatus - acl_type: - type: string - x-go-name: AclType - backend_connect_timeout: - default: 5 - description: range 1-180 - format: int64 - type: integer - x-go-name: BackendConnectTimeout - backend_idle_timeout: - default: 90 - description: range 1-600 - format: int64 - type: integer - x-go-name: BackendIdleTimeout - certificate: - description: 'swagger: ignore' - type: string - x-go-name: Certificate - certificate_id: - type: string - x-go-name: CertificateId - client_idle_timeout: - default: 90 - description: range 1-600 - format: int64 - type: integer - x-go-name: ClientIdleTimeout - client_request_timeout: - default: 10 - description: range 1-600 - format: int64 - type: integer - x-go-name: ClientReqeustTimeout - description: - description: 资源描述 - type: string - x-go-name: Description - enable_http2: - default: true - type: boolean - x-go-name: EnableHttp2 - gzip: - type: boolean - x-go-name: Gzip - health_check: - default: "on" - type: string - x-go-name: HealthCheck - health_check_fail: - default: 2 - description: 2-10 - format: int64 - type: integer - x-go-name: HealthCheckFail - health_check_http_code: - default: http_2xx,http_3xx - type: string - x-go-name: HealthCheckHttpCode - health_check_interval: - default: 30 - description: 5-300 - format: int64 - type: integer - x-go-name: HealthCheckInterval - health_check_path: - type: string - x-go-name: HealthCheckPath - health_check_rise: - default: 5 - description: 2-10 - format: int64 - type: integer - x-go-name: HealthCheckRise - health_check_timeout: - default: 5 - description: 2-120 - format: int64 - type: integer - x-go-name: HealthCheckTimeout - health_check_type: - enum: - - tcp - - ' udp' - - ' http' - type: string - x-go-name: HealthCheckType - http_request_rate: - format: int64 - type: integer - x-go-name: HttpRequestRate - http_request_rate_src: - format: int64 - type: integer - x-go-name: HttpRequestRatePerSrc - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - redirect: - default: "off" - type: string - x-go-name: Redirect - redirect_code: - format: int64 - type: integer - x-go-name: RedirectCode - redirect_host: - type: string - x-go-name: RedirectHost - redirect_path: - type: string - x-go-name: RedirectPath - redirect_scheme: - type: string - x-go-name: RedirectScheme - scheduler: - type: string - x-go-name: Scheduler - send_proxy: - type: string - x-go-name: SendProxy - sticky_session: - type: string - x-go-name: StickySession - sticky_session_cookie: - type: string - x-go-name: StickySessionCookie - sticky_session_cookie_timeout: - format: int64 - type: integer - x-go-name: StickySessionCookieTimeout - sticky_session_type: - type: string - x-go-name: StickySessionType - string: - type: string - x-go-name: HealthCheckDomain - tls_cipher_policy: - type: string - x-go-name: TLSCipherPolicy - x_forwarded_for: - default: true - type: boolean - x-go-name: XForwardedFor - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - LoadbalancerRemoteUpdateInput: - properties: - replace_tags: - description: 是否覆盖替换所有标签 - type: boolean - x-go-name: ReplaceTags - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - MappingRules: - items: - $ref: '#/definitions/ProjectMappingRuleInfo' - type: array - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - MiscResourceCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - cloudprovider_id: - description: 列出关联指定云订阅(ID或Name)的资源 - type: string - x-go-name: CloudproviderId - cloudregion_id: - description: 区域名称或ID - type: string - x-go-name: CloudregionId - 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - MiscResourceDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ModelartsPoolChangeConfigInput: - properties: - NodeCount: - format: int64 - type: integer - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ModelartsPoolCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - cidr: - type: string - x-go-name: Cidr - cloudprovider_id: - description: 列出关联指定云订阅(ID或Name)的资源 - type: string - x-go-name: CloudproviderId - cloudregion_id: - description: 区域名称或ID - type: string - x-go-name: CloudregionId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disable_delete: - default: true - description: 删除保护,创建的资源默认不允许删除 - type: boolean - x-go-name: DisableDelete - 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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 - node_count: - format: int64 - type: integer - x-go-name: NodeCount - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ModelartsPoolDetails: - description: 资源返回详情 - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - 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 - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - ModelartsPoolSkuDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ModelartsPoolSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - MongoDBCreateInput: - 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 - disable_delete: - default: true - description: 删除保护,创建的资源默认不允许删除 - type: boolean - x-go-name: DisableDelete - 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - MongoDBDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - network: - description: IP子网名称 - example: test-network - type: string - x-go-name: Network - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - MongoDBRemoteUpdateInput: - properties: - replace_tags: - description: 是否覆盖替换所有标签 - type: boolean - x-go-name: ReplaceTags - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - MountTargetCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - access_group_id: - description: 权限组Id - type: string - x-go-name: AccessGroupId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - file_system_id: - description: 文件系统Id - type: string - x-go-name: FileSystemId - 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 - network_id: - description: Ip子网名称或Id, network_type == vpc时有效 - type: string - x-go-name: NetworkId - network_type: - default: vpc - description: |- - 网络类型 - enmu: vpc, classic - type: string - x-go-name: NetworkType - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - - file_system_id - - network_id - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - MountTargetDetails: - properties: - FileSystem: - type: string - access_group: - description: 权限组名称 - type: string - x-go-name: AccessGroup - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - network: - description: IP子网名称 - type: string - x-go-name: Network - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - update_fail_reason: - $ref: '#/definitions/Error' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - wire: - description: 二层网络(WIRE)的名称 - type: string - x-go-name: Wire - wire_id: - description: 二层网络ID - type: string - x-go-name: WireId - zone: - description: 可用区 - type: string - x-go-name: Zone - zone_id: - description: 可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - MountTargetSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NasSkuDetails: - properties: - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NatDEntryDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - natgateway: - description: NAT网关名称 - type: string - x-go-name: Natgateway - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - 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' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NatEntryDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - natgateway: - description: NAT网关名称 - type: string - x-go-name: Natgateway - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - 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' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NatGatewaySyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NatSEntryDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - natgateway: - description: NAT网关名称 - type: string - x-go-name: Natgateway - network: - $ref: '#/definitions/SimpleNetwork' - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - 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' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NatSkuDetails: - properties: - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NatgatewayCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - auto_renew: - default: false - description: 是否自动续费(仅包年包月时生效) - type: boolean - x-go-name: AutoRenew - billing_type: - description: 计费方式 - enum: - - postpaid - - ' prepaid' - type: string - x-go-name: BillingType - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - duration: - description: 包年包月时间周期 - type: string - x-go-name: Duration - eip: - description: 绑定已有弹性公网IP，要求EIP必须和Vpc在同一区域 - type: string - x-go-name: Eip - eip_auto_dellocate: - type: boolean - x-go-name: EipAutoDellocate - eip_bgp_type: - type: string - x-go-name: EipBgpType - eip_bw: - description: 绑定新建弹性公网IP - format: int64 - type: integer - x-go-name: EipBw - eip_charge_type: - default: traffic - description: 弹性公网IP计费类型 - enum: - - bandwidth - - ' traffic' - type: string - x-go-name: EipChargeType - expired_at: - description: 到期释放时间，仅后付费支持 - format: date-time - type: string - x-go-name: ExpiredAt - 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 - network_id: - type: string - x-go-name: NetworkId - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NatgatewayDeleteInput: - properties: - force: - type: boolean - x-go-name: Force - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NatgatewayDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - bandwidth_mb: - format: int64 - type: integer - x-go-name: BandwidthMb - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - 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 - disable_delete: - description: 是否开启删除保护 - example: true - type: boolean - x-go-name: DisableDelete - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - ip_addr: - type: string - x-go-name: IpAddr - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - nat_spec: - type: string - x-go-name: NatSpec - network: - type: string - x-go-name: Network - network_id: - type: string - x-go-name: NetworkId - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetTapFlowCreateInput: - 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 - direction: - type: string - x-go-name: Direction - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - guest_id: - type: string - x-go-name: GuestId - host_id: - type: string - x-go-name: HostId - ip_addr: - type: string - x-go-name: IpAddr - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - mac_addr: - type: string - x-go-name: MacAddr - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - tap_id: - type: string - x-go-name: TapId - type: - type: string - x-go-name: Type - vlan_id: - format: int64 - type: integer - x-go-name: VlanId - wire_id: - type: string - x-go-name: WireId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetTapFlowDetails: - 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 - net: - type: string - x-go-name: Net - source: - type: string - x-go-name: Source - source_ips: - type: string - x-go-name: SourceIps - tap: - description: 关联的tap服务名称 - type: string - x-go-name: Tap - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetTapServiceCreateInput: - 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 - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - mac_addr: - description: 监听网卡的Mac地址 - type: string - x-go-name: MacAddr - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - target_id: - description: 资源ID，如果Type=host，该值为宿主机的ID，如果Type=guest，该值为虚拟机的ID - type: string - x-go-name: TargetId - type: - description: TAP服务类型，监听宿主机的网卡还是虚拟机的网卡, 可能值为 host|guest - type: string - x-go-name: Type - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetTapServiceDetails: - 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' - flow_count: - description: tap flow数量 - format: int64 - type: integer - x-go-name: FlowCount - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - target: - description: 流量镜像目标名称 - type: string - x-go-name: Target - target_ips: - description: 流量镜像目标IP地址 - type: string - x-go-name: TargetIps - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkAddressCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - GuestId: - type: string - GuestnetworkIndex: - format: int8 - type: integer - IPAddr: - type: string - NetworkId: - type: string - ParentId: - format: int64 - type: integer - ParentType: - type: string - Type: - type: string - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkAddressDetails: - properties: - Guestnetwork: - $ref: '#/definitions/GuestnetworkDetails' - IpAddr: - type: string - NetworkId: - type: string - ParentId: - type: string - ParentType: - type: string - SubCtrVid: - format: int64 - type: integer - Type: - type: string - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - network: - description: IP子网名称 - type: string - x-go-name: Network - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - update_fail_reason: - $ref: '#/definitions/Error' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - wire: - description: 二层网络(WIRE)的名称 - type: string - x-go-name: Wire - wire_id: - description: 二层网络ID - type: string - x-go-name: WireId - zone: - description: 可用区 - type: string - x-go-name: Zone - zone_id: - description: 可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkConfig: - properties: - address: - description: 子网内的IPv4地址, 若不指定会安装子网的地址分配策略分配一个IP地址 - type: string - x-go-name: Address - bw_limit: - format: int64 - type: integer - x-go-name: BwLimit - driver: - description: |- - 驱动方式 - 若指定镜像的网络驱动方式，此参数会被覆盖 - type: string - x-go-name: Driver - exit: - description: 内网地址 - type: boolean - x-go-name: Exit - ifname: - type: string - x-go-name: Ifname - index: - description: 网卡序号, 从0开始 - format: int64 - type: integer - x-go-name: Index - mac: - description: |- - 网卡MAC地址 - requried: false - type: string - x-go-name: Mac - net_type: - type: string - x-go-name: NetType - network: - description: 子网名称或ID - type: string - x-go-name: Network - num_queues: - format: int64 - type: integer - x-go-name: NumQueues - private: - type: boolean - x-go-name: Private - require_designated_ip: - type: boolean - x-go-name: RequireDesignatedIP - require_teaming: - type: boolean - x-go-name: RequireTeaming - reserved: - type: boolean - x-go-name: Reserved - schedtags: - items: - $ref: '#/definitions/SchedtagConfig' - type: array - x-go-name: Schedtags - sriov_device: - $ref: '#/definitions/IsolatedDeviceConfig' - standby_addr_count: - format: int64 - type: integer - x-go-name: StandbyAddrCount - standby_port_count: - format: int64 - type: integer - x-go-name: StandbyPortCount - try_teaming: - type: boolean - x-go-name: TryTeaming - vip: - type: boolean - x-go-name: Vip - required: - - index - - network - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - assign_public_ip: - description: 是否申请ip时自动挂载公网ip，仅对aws生效 - type: boolean - x-go-name: AssignPublicIp - bgp_type: - description: 线路类型 - type: string - x-go-name: BgpType - 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 - guest_dhcp: - description: 'description: guest dhcp' - example: 192.168.222.1,192.168.222.4 - type: string - x-go-name: GuestDHCP - guest_dns: - description: 'description: guest dns' - example: 114.114.114.114,8.8.8.8 - type: string - x-go-name: GuestDns - guest_gateway: - description: 'description: guest gateway' - example: 192.168.222.1 - type: string - x-go-name: GuestGateway - guest_ip_end: - description: 'description: ip range of guest ip end, if set guest_ip_prefix, - this parameter will be useless' - example: 10.168.222.100 - type: string - x-go-name: GuestIpEnd - guest_ip_mask: - description: 'description: ip range of guest ip mask, if set guest_ip_prefix, - this parameter will be useless' - example: 24 - format: int64 - maximum: 30 - minimum: 12 - type: integer - x-go-name: GuestIpMask - guest_ip_prefix: - description: 'description: ip range of guest, if not set, you shoud set guest_ip_start,guest_ip_end - and guest_ip_mask params' - example: 10.168.222.1/24 - type: string - x-go-name: GuestIpPrefix - guest_ip_start: - description: 'description: ip range of guest ip start, if set guest_ip_prefix, - this parameter will be useless' - example: 10.168.222.1 - type: string - x-go-name: GuestIpStart - guest_ntp: - description: 'description: guest ntp' - example: cn.pool.ntp.org,0.cn.pool.ntp.org - type: string - x-go-name: GuestNtp - ifname_hint: - type: string - x-go-name: IfnameHint - is_auto_alloc: - description: 是否加入自动分配地址池 - type: boolean - x-go-name: IsAutoAlloc - 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: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - server_type: - default: guest - description: 'description: server type' - enum: - - guest - - baremetal - - pxe - - ipmi - type: string - x-go-name: ServerType - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - vlan: - description: deprecated - format: int64 - type: integer - x-go-name: Vlan - vlan_id: - description: VlanId - format: int64 - type: integer - x-go-name: VlanId - vpc: - description: 'description: vpc id or name' - type: string - x-go-name: Vpc - wire: - description: 'description: wire id or name' - type: string - x-go-name: Wire - zone: - description: 'description: zone id or name' - type: string - x-go-name: Zone - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - alloc_policy: - description: 分配策略 - type: string - x-go-name: AllocPolicy - alloc_timout_seconds: - format: int64 - type: integer - x-go-name: AllocTimoutSeconds - bgp_type: - description: 线路类型 - type: string - x-go-name: BgpType - bm_reused_vnics: - format: int64 - type: integer - x-go-name: BmReusedVnics - bm_vnics: - description: 裸金属网卡数量 - format: int64 - type: integer - x-go-name: BmVnics - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - 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 - eip_vnics: - description: 浮动Ip网卡数量 - format: int64 - type: integer - x-go-name: EipVnics - environment: - description: Environment - type: string - x-go-name: Environment - exit: - description: 是否是内网 - type: boolean - x-go-name: Exit - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - group_vnics: - format: int64 - type: integer - x-go-name: GroupVnics - guest_dhcp: - description: allow multiple dhcp, seperated by "," - type: string - x-go-name: GuestDhcp - guest_dns: - description: DNS, allow multiple dns, seperated by "," - type: string - x-go-name: GuestDns - guest_dns6: - type: string - x-go-name: GuestDns6 - guest_domain: - type: string - x-go-name: GuestDomain - guest_domain6: - type: string - x-go-name: GuestDomain6 - guest_gateway: - description: 网关地址 - type: string - x-go-name: GuestGateway - guest_gateway6: - type: string - x-go-name: GuestGateway6 - guest_ip_end: - description: 结束IP地址 - type: string - x-go-name: GuestIpEnd - guest_ip_mask: - description: 掩码 - format: uint8 - type: integer - x-go-name: GuestIpMask - guest_ip_start: - description: 起始IP地址 - type: string - x-go-name: GuestIpStart - guest_ip6_end: - type: string - x-go-name: GuestIp6End - guest_ip6_mask: - format: uint8 - type: integer - x-go-name: GuestIp6Mask - guest_ip6_start: - type: string - x-go-name: GuestIp6Start - guest_ntp: - description: allow mutiple ntp, seperated by "," - type: string - x-go-name: GuestNtp - id: - description: 资源UUID - type: string - x-go-name: Id - ifname_hint: - type: string - x-go-name: IfnameHint - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_auto_alloc: - description: |- - 该网段是否用于自动分配IP地址，如果为false，则用户需要明确选择该网段，才会使用该网段分配IP， - 如果为true，则用户不指定网段时，则自动从该值为true的网络中选择一个分配地址 - type: boolean - x-go-name: IsAutoAlloc - 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 - lb_vnics: - description: 负载均衡网卡数量 - format: int64 - type: integer - x-go-name: LbVnics - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - nat_vnics: - description: NAT网关网卡数量 - format: int64 - type: integer - x-go-name: NatVnics - networkinterface_vnics: - description: 弹性网卡数量 - format: int64 - type: integer - x-go-name: NetworkinterfaceVnics - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - ports: - description: 端口数量 - format: int64 - type: integer - x-go-name: Ports - ports_used: - description: 已使用端口数量 - format: int64 - type: integer - x-go-name: PortsUsed - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - rds_vnics: - description: RDS网卡数量 - format: int64 - type: integer - x-go-name: RdsVnics - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - reserve_vnics: - description: 预留IP数量 - format: int64 - type: integer - x-go-name: ReserveVnics - routes: - description: 路由信息 - items: - items: - type: string - type: array - type: array - x-go-name: Routes - schedtags: - items: - $ref: '#/definitions/SchedtagShortDescDetails' - type: array - x-go-name: Schedtags - server_type: - description: 服务器类型 - example: server - type: string - x-go-name: ServerType - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - total: - format: int64 - type: integer - x-go-name: Total - 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 - vlan_id: - format: int64 - type: integer - x-go-name: VlanId - vnics: - description: 虚拟机网卡数量 - format: int64 - type: integer - x-go-name: Vnics - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - wire: - description: 二层网络(WIRE)的名称 - type: string - x-go-name: Wire - wire_id: - description: 二层网络ID - type: string - x-go-name: WireId - zone: - description: 可用区 - type: string - x-go-name: Zone - zone_id: - description: 可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkInterfaceDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - associate_id: - description: 绑定资源Id - type: string - x-go-name: AssociateId - associate_type: - description: 绑定资源类型 - type: string - x-go-name: AssociateType - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - mac: - description: MAC地址 - type: string - x-go-name: Mac - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - networks: - description: 弹性网卡网络信息 - items: - $ref: '#/definitions/NetworkInterfaceNetworkInfo' - type: array - x-go-name: Networks - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkInterfaceNetworkInfo: - properties: - ip_addr: - description: IP地址 - type: string - x-go-name: IpAddr - network: - description: IP子网名称 - type: string - x-go-name: Network - network_id: - description: Ip子网Id - type: string - x-go-name: NetworkId - networkinterface_id: - description: 弹性网卡id - type: string - x-go-name: NetworkinterfaceId - primary: - description: 是否是主ip地址 - type: boolean - x-go-name: Primary - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkIpMacBatchCreateInput: - properties: - ip_mac: - additionalProperties: - type: string - type: object - x-go-name: IpMac - network_id: - type: string - x-go-name: NetworkId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkIpMacCreateInput: - 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 - ip_addr: - type: string - x-go-name: IpAddr - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - mac_addr: - type: string - x-go-name: MacAddr - network_id: - type: string - x-go-name: NetworkId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkIpMacDetails: - 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' - ip_addr: - type: string - x-go-name: IpAddr - mac_addr: - type: string - x-go-name: MacAddr - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - network_id: - type: string - x-go-name: NetworkId - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkIpMacUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - ip_addr: - type: string - x-go-name: IpAddr - mac_addr: - type: string - x-go-name: MacAddr - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkMergeInput: - properties: - target: - description: 'description: network id or name to be merged' - example: test-network - type: string - x-go-name: Target - required: - - target - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkPurgeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkReleaseReservedIpInput: - properties: - ip: - description: 'description: IP to be released' - example: 10.168.222.121 - type: string - x-go-name: Ip - required: - - ip - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkReserveIpInput: - properties: - duration: - description: 'description: The reserved cycle' - type: string - x-go-name: Duration - ips: - description: 'description: reserved ip list' - example: '[10.168.222.131, 10.168.222.134]' - items: - type: string - type: array - x-go-name: Ips - notes: - description: 'description: the comment' - example: reserve ip for test - type: string - x-go-name: Notes - status: - type: string - x-go-name: Status - required: - - ips - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkSetBgpTypeInput: - properties: - bgp_type: - description: 'description: new BgpType name' - example: ChinaTelecom, BGP, etc. - type: string - x-go-name: BgpType - required: - - bgp_type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkSplitInput: - properties: - name: - description: 'description: another network name after split' - type: string - x-go-name: Name - split_ip: - description: 'description: The middle - separated IP must belong to the network' - example: 10.168.222.181 - type: string - x-go-name: SplitIp - required: - - split_ip - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkSwitchWireInput: - properties: - wire_id: - description: 'description: new wire Id or name' - example: bcast0 - type: string - x-go-name: WireId - required: - - wire_id - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkSyncInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkTopologyOutput: - properties: - address: - items: - $ref: '#/definitions/SNetworkUsedAddress' - type: array - x-go-name: Address - guest_ip_end: - type: string - x-go-name: GuestIpEnd - guest_ip_mask: - format: int8 - type: integer - x-go-name: GuestIpMask - guest_ip_start: - type: string - x-go-name: GuestIpStart - name: - type: string - x-go-name: Name - server_type: - type: string - x-go-name: ServerType - status: - type: string - x-go-name: Status - vlan_id: - format: int64 - type: integer - x-go-name: VlanId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkTryCreateNetworkInput: - properties: - ip: - type: string - x-go-name: Ip - is_on_premise: - type: boolean - x-go-name: IsOnPremise - mask: - format: int64 - type: integer - x-go-name: Mask - server_type: - type: string - x-go-name: ServerType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - NetworkUpdateInput: - properties: - alloc_policy: - description: 分配策略 - type: string - x-go-name: AllocPolicy - description: - description: 资源描述 - type: string - x-go-name: Description - guest_dhcp: - description: allow multiple dhcp, seperated by "," - type: string - x-go-name: GuestDhcp - guest_dns: - description: DNS - type: string - x-go-name: GuestDns - guest_domain: - type: string - x-go-name: GuestDomain - guest_gateway: - description: 网关地址 - type: string - x-go-name: GuestGateway - guest_ip_end: - description: 接收IP地址 - type: string - x-go-name: GuestIpEnd - guest_ip_mask: - description: 掩码 - format: int8 - type: integer - x-go-name: GuestIpMask - guest_ip_start: - description: 起始IP地址 - type: string - x-go-name: GuestIpStart - guest_ntp: - description: NTP - type: string - x-go-name: GuestNtp - is_auto_alloc: - description: 是否加入自动分配地址池 - type: boolean - x-go-name: IsAutoAlloc - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - vlan_id: - format: int64 - type: integer - x-go-name: VlanId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - PerformChangeDomainOwnerInput: - properties: - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformChangeProjectOwnerInput: - properties: - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformDisableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformEnableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformFreezeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPrivateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPublicDomainInput: - properties: - scope: - description: 共享项目资源的共享范围，可能的值为：project, domain和system - pattern: project|domain|system - type: string - x-go-name: Scope - shared_domain_ids: - description: 如果共享范围为域，则在此列表中指定共享的目标域 - items: - type: string - type: array - x-go-name: SharedDomainIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPublicProjectInput: - 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 - shared_project_ids: - description: 如果共享范围为项目，则在此列表中指定共享的目标项目 - items: - type: string - type: array - x-go-name: SharedProjectIds - 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 - PerformUnfreezeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PolicyAssignmentCreateInput: - 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 - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - name: - description: 资源名称 - type: string - x-go-name: Name - policydefinition_id: - description: 策略Id - type: string - x-go-name: PolicydefinitionId - 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/compute - PolicyAssignmentDetails: - properties: - Policydefinition: - type: string - 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_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - policydefinition_id: - description: 策略Id - type: string - x-go-name: PolicydefinitionId - 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 - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - PolicyDefinitionCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - category: - description: 类别 - type: string - x-go-name: Category - condition: - description: 条件 - type: string - x-go-name: Condition - 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 - description: - description: 资源描述信息 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - 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 - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - name: - description: 资源名称 - example: test-network - type: string - uniqueItems: true - x-go-name: Name - parameters: - description: 参数 - type: object - x-go-name: Parameters - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - PolicyDefinitionDetails: - 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 - category: - description: 类别 - type: string - x-go-name: Category - condition: - description: 条件 - type: string - x-go-name: Condition - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - parameters: - description: 参数 - type: object - x-go-name: Parameters - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - PostpaidExpireInput: - properties: - duration: - type: string - x-go-name: Duration - expire_time: - format: date-time - type: string - x-go-name: ExpireTime - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ProjectMappingCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - Rules: - $ref: '#/definitions/MappingRules' - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ProjectMappingDetails: - properties: - Rules: - items: - $ref: '#/definitions/ProjectMappingRuleInfoDetails' - type: array - accounts: - description: 所绑定的云账号列表 - items: - $ref: '#/definitions/SProjectMappingAccount' - type: array - x-go-name: Accounts - 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' - managers: - description: 所绑定的云订阅列表 - items: - $ref: '#/definitions/SProjectMappingAccount' - type: array - x-go-name: Managers - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - 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' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ProjectMappingRuleInfo: - properties: - auto_create_project: - description: 是否自动根据标签值创建项目, 仅标签列表中有且仅有一个没有value的key时支持 - type: boolean - x-go-name: AutoCreateProject - condition: - default: and - description: |- - 条件表达式 - enmu: and, or - type: string - x-go-name: Condition - project_id: - description: 符合条件时，资源放置的项目id, 此参数和auto_create_project互斥 - type: string - x-go-name: ProjectId - tags: - $ref: '#/definitions/TTagSet' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ProjectMappingRuleInfoDetails: - properties: - Domain: - type: string - Project: - type: string - Tenant: - type: string - TenantId: - type: string - auto_create_project: - description: 是否自动根据标签值创建项目, 仅标签列表中有且仅有一个没有value的key时支持 - type: boolean - x-go-name: AutoCreateProject - condition: - default: and - description: |- - 条件表达式 - enmu: and, or - type: string - x-go-name: Condition - project_id: - description: 符合条件时，资源放置的项目id, 此参数和auto_create_project互斥 - type: string - x-go-name: ProjectId - tags: - $ref: '#/definitions/TTagSet' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ProjectMappingUpdateInput: - properties: - Rules: - $ref: '#/definitions/MappingRules' - 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/compute - ProjectStatistic: - properties: - Count: - format: int64 - type: integer - Id: - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ProviderProject: - properties: - tenant: - description: 子订阅项目名称 - example: system - type: string - x-go-name: Tenant - tenant_id: - description: |- - 子订阅项目Id - 9a48383a-467a-4542-8b50-4e15b0a8715f - type: string - x-go-name: TenantId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - PurgeSplitTableInput: - properties: - tables: - items: - type: string - type: array - x-go-name: Tables - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - RenewInput: - properties: - duration: - type: string - x-go-name: Duration - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ReservedipDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - expired: - description: 是否过期 - type: boolean - x-go-name: Expired - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - id: - description: 自增Id - format: int64 - type: integer - x-go-name: Id - ip_addr: - description: IP地址 - type: string - x-go-name: IpAddr - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - network: - description: IP子网名称 - type: string - x-go-name: Network - network_id: - type: string - x-go-name: NetworkId - notes: - description: 预留原因或描述 - type: string - x-go-name: Notes - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - status: - description: 状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - wire: - description: 二层网络(WIRE)的名称 - type: string - x-go-name: Wire - wire_id: - description: 二层网络ID - type: string - x-go-name: WireId - zone: - description: 可用区 - type: string - x-go-name: Zone - zone_id: - description: 可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ResourceBaseCreateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ResourceBaseDetails: - 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 - ResourceBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - RouteTableCreateInput: - 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 - external_access_mode: - description: Vpc外网访问模式 - type: string - x-go-name: ExternalAccessMode - 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 - routes: - $ref: '#/definitions/SRoutes' - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - type: - type: string - x-go-name: Type - vpc_id: - description: 关联VPC(ID或Name) - type: string - x-go-name: VpcId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - RouteTableDetails: - properties: - AccociationCount: - format: int64 - type: integer - RouteSetCount: - format: int64 - type: integer - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - routes: - $ref: '#/definitions/SRoutes' - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - RouteTableRouteSetCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - RouteTableId: - type: string - cidr: - type: string - x-go-name: Cidr - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - ext_next_hop_id: - type: string - x-go-name: ExtNextHopId - 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 - next_hop_id: - type: string - x-go-name: NextHopId - next_hop_type: - type: string - x-go-name: NextHopType - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - RouteTableRouteSetUpdateInput: - properties: - cidr: - type: string - x-go-name: Cidr - description: - description: 资源描述 - type: string - x-go-name: Description - ext_next_hop_id: - type: string - x-go-name: ExtNextHopId - name: - description: 资源名称 - type: string - x-go-name: Name - next_hop_id: - type: string - x-go-name: NextHopId - next_hop_type: - type: string - x-go-name: NextHopType - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - RouteTableUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - routes: - $ref: '#/definitions/SRoutes' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SAccountPermission: - properties: - Permissions: - items: - type: string - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SAccountPermissions: - additionalProperties: - $ref: '#/definitions/SAccountPermission' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SAclEntries: - items: - $ref: '#/definitions/SAclEntry' - type: array - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SAclEntry: - properties: - Cidr: - type: string - Comment: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SBucketAccessUrl: - properties: - Description: - type: string - Primary: - type: boolean - Url: - type: string - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SCdnOrigin: - description: +onecloud:model-api-gen - properties: - Enabled: - type: string - Origin: - description: 源站地址 - type: string - Path: - type: string - Port: - format: int64 - type: integer - Priority: - format: int64 - type: integer - Protocol: - description: |- - 回源协议 - enmu: http, follow, https - type: string - ServerName: - description: 回主源站时 Host 头部 - type: string - Type: - description: |- - 源站类型 - domain: 域名类型, cos：对象存储源站, ip：IP 列表作为源站 - enmu: domain, cos, ip - type: string - required: - - Type - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SCdnOrigins: - description: +onecloud:model-api-gen - items: - $ref: '#/definitions/SCdnOrigin' - type: array - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SCloudObject: - properties: - Acl: - type: string - ETag: - type: string - Key: - type: string - LastModified: - format: date-time - type: string - Meta: - $ref: '#/definitions/Header' - SizeBytes: - format: int64 - type: integer - StorageClass: - type: string - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SCloudResource: - properties: - CanDissociate: - description: 是否可以解除关联 - type: boolean - Id: - description: 资源Id - type: string - Name: - description: 资源名称 - type: string - Port: - description: 资源映射端口 - format: int64 - type: integer - Type: - description: 资源类型 - type: string - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SCloudResources: - properties: - Data: - items: - $ref: '#/definitions/SCloudResource' - type: array - Total: - format: int64 - type: integer - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SCloudaccountCredential: - properties: - As: - description: 弹性伸缩服务 - type: string - Bms: - description: 裸金属服务器 - type: string - Bss: - description: 合作伙伴运营能力 - type: string - Cce: - description: 云容器服务 - type: string - Cci: - description: 云容器实例 CCI - type: string - Ces: - description: 监控服务 CloudEye - type: string - Csbs: - description: 云服务器备份服务 - type: string - Cts: - description: 云审计服务 - type: string - Dcs: - description: 分布式缓存服务 - type: string - DefaultRegion: - description: 默认区域Id, Apara及HCSO需要此参数 - example: cn-north-2 - type: string - DefaultSubnetDns: - description: 默认DNS - example: 10.125.0.26,10.125.0.27 - type: string - Ecs: - description: 弹性云服务 - type: string - Elb: - description: 弹性负载均衡 ELB - type: string - EndpointDomain: - description: 华为私有云Endpoint域名 - example: hcso.com.cn - type: string - Eps: - description: 企业项目 - type: string - Evs: - description: 云硬盘 EVS - type: string - Iam: - description: 统一身份认证服务 - type: string - Ims: - description: 镜像服务 - type: string - Modelarts: - description: Modelarts - type: string - Nat: - description: Nat网关 NAT - type: string - Obs: - description: 对象存储服务 OBS - type: string - Rds: - description: 关系型数据库 RDS - type: string - SfsTurbo: - description: 文件系统 - type: string - Vbs: - description: 云硬盘备份 VBS - type: string - Vpc: - description: 虚拟私有云 VPC - type: string - access_key_id: - description: 秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) - type: string - x-go-name: AccessKeyId - access_key_secret: - description: 秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) - type: string - x-go-name: AccessKeySecret - app_id: - description: app id (Qcloud) - type: string - x-go-name: AppId - auto_url: - description: 认证地址 (openstack,zstack) - type: string - x-go-name: AuthUrl - client_id: - description: 客户端ID (Azure) - type: string - x-go-name: ClientId - client_secret: - description: 客户端秘钥 (Azure) - type: string - x-go-name: ClientSecret - crm_biz_id: - description: customInfo type=1 - type: string - x-go-name: CrmBizId - directory_id: - description: 目录ID (Azure) - type: string - x-go-name: DirectoryId - domain_name: - default: Default - description: 账号所在的域 (openstack) - type: string - x-go-name: DomainName - endpoint: - description: 端点 (s3) 或 Apsara(飞天) - type: string - x-go-name: Endpoint - environment: - description: 环境 (Azure, Aws, huawei, ctyun, aliyun) - type: string - x-go-name: Environment - gcp_client_email: - description: Google服务账号email (gcp) - type: string - x-go-name: GCPClientEmail - gcp_private_key: - description: Google服务账号秘钥 (gcp) - type: string - x-go-name: GCPPrivateKey - gcp_private_key_id: - description: Google服务账号秘钥id (gcp) - type: string - x-go-name: GCPPrivateKeyId - gcp_project_id: - description: Google服务账号project id (gcp) - type: string - x-go-name: GCPProjectId - host: - description: 主机IP (esxi) - type: string - x-go-name: Host - organization_id: - description: 飞天允许的最高组织id, 默认为1 - format: int64 - type: integer - x-go-name: OrganizationId - password: - description: 密码 (openstack, zstack, esxi) - type: string - x-go-name: Password - port: - description: 主机端口 (esxi) - format: int64 - type: integer - x-go-name: Port - project_name: - description: 账号所在的项目 (openstack) - type: string - x-go-name: ProjectName - secret_id: - description: 秘钥ID (Qcloud) - type: string - x-go-name: SecretId - secret_key: - description: 秘钥key (Qcloud) - type: string - x-go-name: SecretKey - username: - description: 用户名 (openstack, zstack, esxi) - type: string - x-go-name: Username - required: - - EndpointDomain - - DefaultRegion - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SDBInstanceAccountPrivilege: - properties: - database: - description: 数据库名称或Id - type: string - x-go-name: Database - privilege: - description: |- - 权限类型 - - - - 平台 |Rds引擎 | 支持类型 | - ---- |------- | -------- | - Aliyun |MySQL, MariaBD | rw, r, ddl, dml | - Aliyun |SQLServer | rw, r, owner | - Huawei |MySQL, MariaDB | rw, r | - 同一平台不同的rds类型支持的权限不尽相同 - type: string - x-go-name: Privilege - required: - - database - - privilege - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SDBInstanceChangeConfigInput: - properties: - DiskSizeGB: - format: int64 - type: integer - InstanceType: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SDBInstanceDatabasePrivilege: - properties: - account: - description: 数据库账号名称或Id - type: string - x-go-name: Account - privilege: - description: |- - 权限 - - - - 平台 |Rds引擎 | 支持类型 | - ---- |------- | -------- | - Aliyun |MySQL, MariaBD | rw, r, ddl, dml | - Aliyun |SQLServer | rw, r, owner | - Huawei |MySQL, MariaDB | rw, r | - 同一平台不同的rds类型支持的权限不尽相同 - type: string - x-go-name: Privilege - required: - - account - - privilege - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SDBInstanceRecoveryConfigInput: - properties: - databases: - additionalProperties: - type: string - description: 数据库信息, 例如 {"src":"dest"} 是将备份中的src数据库恢复到目标实例的dest数据库中, 阿里云此参数为必传 - example: - sdb1: ddb1 - type: object - x-go-name: Databases - dbinstancebackup_id: - description: |- - 备份Id - - - 平台 | 支持引擎 | 说明 | - ----- | ------ | --- | - 华为云 |MySQL, SQL Server | 仅SQL Server支持恢复到当前实例 | - 阿里云 |MySQL, SQL Server | MySQL要求必须开启单库单表恢复功能 并且只能是MySQL 8.0 高可用版（本地SSD盘）MySQL 5.7 高可用版（本地SSD盘）或MySQL 5.6 高可用版, MySQL仅支持恢复到当前实例| - Google |MySQL, PostgreSQL, SQL Server | PostgreSQL备份恢复时，要求实例不能有副本 | - type: string - x-go-name: DBInstancebackupId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SDomainQuotaDetail: - description: 域配额详情 - properties: - cloudaccount: - format: int64 - type: integer - x-go-name: Cloudaccount - 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 - dns_zone: - format: int64 - type: integer - x-go-name: DnsZone - domain: - description: 配额适用的项目的域名称 - type: string - x-go-name: Domain - domain_id: - description: 配额适用的域ID - type: string - x-go-name: DomainId - globalvpc: - format: int64 - type: integer - x-go-name: Globalvpc - 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/compute/models - SElasticipCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - bandwidth: - format: int64 - type: integer - x-go-name: BandwidthMb - bgp_type: - description: 'description: BgpType for the new eip' - type: string - x-go-name: BgpType - charge_type: - default: traffic - description: |- - 计费类型: 流量或带宽 - - - - 平台 | 支持类型 | - --- | -------- | - Aliyun | traffic, bandwidth | - 腾讯云 | traffic | - Azure | traffic | - Google | traffic, bandwidth | - Ucloud | traffic | - Aws | traffic | - 华为云 | traffic, bandwidth | - 天翼云 | traffic, bandwidth | - KVM | 不支持创建 | - VMware | 不支持创建 | - ZStack | traffic | - OpenStack | traffic | - enum: - - traffic - - ' bandwidth' - type: string - x-go-name: ChargeType - cloudregion_id: - description: |- - 区域名称或Id, 建议使用Id - 在指定区域内创建弹性公网ip - type: string - x-go-name: CloudregionId - 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 - ip_addr: - description: 指定新建EIP的地址 - type: string - x-go-name: IpAddr - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - manager_id: - description: |- - 子订阅Id, 建议使用Id - 使用指定子订阅创建弹性公网ip - 弹性公网ip和虚拟机在同一区域同一子订阅底下，才可以进行绑定操作 - type: string - x-go-name: ManagerId - mode: - type: string - x-go-name: Mode - 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 - network_id: - description: |- - 子网Id - 私有云创建此参数必传,例如Openstack, ZStack - type: string - x-go-name: NetworkId - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SEnrollmentAccount: - properties: - id: - description: Enrollment Account Id - type: string - x-go-name: Id - name: - description: Enrollment Account name - type: string - x-go-name: Name - type: - description: Enrollment Account 类型 - type: string - x-go-name: Type - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SExcludeRule: - properties: - Name: - type: string - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SExcludeRules: - items: - $ref: '#/definitions/SExcludeRule' - type: array - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SGPerformDetachScalingGroupInput: - properties: - auto: - description: 'description: 自动行为' - example: true - type: boolean - x-go-name: Auto - delete_server: - description: 'description: 是否删除机器' - example: false - type: boolean - x-go-name: DeleteServer - scaling_group: - description: 'description: 伸缩组 Id or Name' - example: sg-1234 - type: string - x-go-name: ScalingGroup - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SGroup: - 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 - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - force_dispersion: - type: boolean - x-go-name: ForceDispersion - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - granularity: - description: the upper limit number of guests with this group in a host - format: int64 - type: integer - x-go-name: Granularity - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - name: - description: 资源名称 - type: string - x-go-name: Name - parent_id: - type: string - x-go-name: ParentId - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - sched_strategy: - description: 调度策略 - type: string - x-go-name: SchedStrategy - service_type: - description: 服务类型 - type: string - x-go-name: ServiceType - status: - description: 资源状态 - type: string - x-go-name: Status - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - zone_id: - type: string - x-go-name: ZoneId - title: SGroup is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SGroup. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SGuest: - properties: - admin_secgrp_id: - description: 管理员可见安全组Id - type: string - x-go-name: AdminSecgrpId - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - backup_guest_status: - type: string - x-go-name: BackupGuestStatus - backup_host_id: - description: 备份机所在宿主机Id - type: string - x-go-name: BackupHostId - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - bios: - type: string - x-go-name: Bios - boot_order: - description: 启动顺序 - type: string - x-go-name: BootOrder - 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 - description: - description: 资源描述信息 - type: string - x-go-name: Description - disable_delete: - description: 是否开启删除保护 - example: true - type: boolean - x-go-name: DisableDelete - domain_id: - description: 域Id - type: string - x-go-name: DomainId - encrypt_key_id: - description: 加密密钥ID - type: string - x-go-name: EncryptKeyId - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - flavor_id: - type: string - x-go-name: FlavorId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - host_id: - type: string - x-go-name: HostId - hostname: - type: string - x-go-name: Hostname - hypervisor: - description: 虚拟化技术 - example: kvm - type: string - x-go-name: Hypervisor - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - instance_type: - description: 套餐名称 - type: string - x-go-name: InstanceType - internet_max_bandwidth_out: - description: 最大内网带宽 - format: int64 - type: integer - x-go-name: InternetMaxBandwidthOut - is_daemon: - type: boolean - x-go-name: IsDaemon - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - keypair_id: - description: 秘钥对Id - type: string - x-go-name: KeypairId - machine: - type: string - x-go-name: Machine - name: - description: 资源名称 - type: string - x-go-name: Name - os_arch: - description: 操作系统 CPU 架构 - example: x86 arm - type: string - x-go-name: OsArch - os_type: - description: 操作系统类型 - type: string - x-go-name: OsType - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - power_states: - description: power_states limit in [on, off, unknown] - type: string - x-go-name: PowerStates - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - progress_mbps: - description: 迁移或克隆的速度 - format: double - type: number - x-go-name: ProgressMbps - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - qga_status: - type: string - x-go-name: QgaStatus - record_checksum: - type: string - x-go-name: RecordChecksum - secgrp_id: - description: 安全组Id - example: default - type: string - x-go-name: SecgrpId - shutdown_behavior: - description: 关机操作类型 - example: stop - type: string - x-go-name: ShutdownBehavior - shutdown_mode: - description: 关机收费模式 - example: keep_charging, stop_charging - type: string - x-go-name: ShutdownMode - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - src_ip_check: - type: boolean - x-go-name: SrcIpCheck - src_mac_check: - type: boolean - x-go-name: SrcMacCheck - sshable_last_state: - type: boolean - x-go-name: SshableLastState - status: - description: 资源状态 - type: string - x-go-name: Status - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - throughput: - description: 磁盘吞吐量 - format: int64 - type: integer - x-go-name: Throughput - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vcpu_count: - description: CPU大小 - format: int64 - type: integer - x-go-name: VcpuCount - vdi: - type: string - x-go-name: Vdi - vga: - type: string - x-go-name: Vga - vmem_size: - description: 内存大小, 单位Mb - format: int64 - type: integer - x-go-name: VmemSize - title: SGuest is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SGuest. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SHostPingInput: - properties: - memory_used_mb: - format: int64 - type: integer - x-go-name: MemoryUsedMb - root_partition_used_capacity_mb: - format: int64 - type: integer - x-go-name: RootPartitionUsedCapacityMb - storage_stats: - items: - $ref: '#/definitions/SHostStorageStat' - type: array - x-go-name: StorageStats - with_data: - type: boolean - x-go-name: WithData - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SHostStorageStat: - properties: - actual_capacity_used_mb: - format: int64 - type: integer - x-go-name: ActualCapacityUsedMb - capacity_mb: - format: int64 - type: integer - x-go-name: CapacityMb - storage_id: - type: string - x-go-name: StorageId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SHostTapConfig: - properties: - mirrors: - items: - $ref: '#/definitions/SMirrorConfig' - type: array - x-go-name: Mirrors - taps: - items: - $ref: '#/definitions/STapServiceConfig' - type: array - x-go-name: Taps - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SInfrasQuotaDetail: - description: 基础设施配额详情 - properties: - account: - description: 配额适用的云账号名称 - type: string - x-go-name: Account - account_id: - description: 配额适用的云账号ID - type: string - x-go-name: AccountId - brand: - description: 配额适用的品牌名称，参考List接口的品牌列表 - type: string - x-go-name: Brand - cloud_env: - description: 配额适用的云环境，参考List接口的云环境列表 - type: string - x-go-name: CloudEnv - 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 - host: - format: int64 - type: integer - x-go-name: Host - manager: - description: 配额适用的云订阅名称 - type: string - x-go-name: Manager - manager_id: - description: 配额适用的云订阅ID - type: string - x-go-name: ManagerId - provider: - description: 配额适用的平台名称，参考List接口的平台列表 - type: string - x-go-name: Provider - region: - description: 配额适用的区域名称 - type: string - x-go-name: Region - region_id: - description: 配额适用的区域ID - type: string - x-go-name: RegionId - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vpc: - format: int64 - type: integer - x-go-name: Vpc - type: object - x-go-package: yunion.io/x/onecloud/pkg/compute/models - SInstanceTypes: - items: - type: string - type: array - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SIsolatedDevice: - properties: - addr: - description: '# pci address of `Bus:Device.Function` format, or usb bus address - of `bus.addr`' - type: string - x-go-name: Addr - 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 - description: - description: 资源描述信息 - type: string - x-go-name: Description - dev_type: - description: |- - # PCI / GPU-HPC / GPU-VGA / USB / NIC - 设备类型 - type: string - x-go-name: DevType - disk_index: - description: guest disk index - format: uint8 - type: integer - x-go-name: DiskIndex - guest_id: - description: 云主机Id - type: string - x-go-name: GuestId - host_id: - type: string - x-go-name: HostId - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - model: - description: '# Specific device name read from lspci command, e.g. `Tesla - K40m` ...' - type: string - x-go-name: Model - name: - description: 资源名称 - type: string - x-go-name: Name - network_index: - description: guest network index - format: uint8 - type: integer - x-go-name: NetworkIndex - nvme_size_mb: - description: NVME disk size - format: int64 - type: integer - x-go-name: NvmeSizeMB - ovs_offload_interface: - description: Offload interface name - type: string - x-go-name: OvsOffloadInterface - reserved_cpu: - description: reserved cpu count for isolated device - format: int64 - type: integer - x-go-name: ReservedCpu - reserved_memory: - description: reserved memory size for isolated device - format: int64 - type: integer - x-go-name: ReservedMemory - reserved_storage: - description: reserved storage size for isolated device - format: int64 - type: integer - x-go-name: ReservedStorage - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vendor_device_id: - type: string - x-go-name: VendorDeviceId - wire_id: - description: Nic wire id - type: string - x-go-name: WireId - title: SIsolatedDevice is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SIsolatedDevice. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SKafkaTopic: - properties: - Description: - type: string - Id: - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SKubeNetworkIds: - items: - type: string - type: array - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SKubeconfig: - properties: - config: - type: string - x-go-name: Config - expiration: - format: date-time - type: string - x-go-name: Expiration - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SLoadbalancerAgentDeployment: - properties: - ansible_playbook: - type: string - x-go-name: AnsiblePlaybook - ansible_playbook_undeployment: - type: string - x-go-name: AnsiblePlaybookUndeployment - host: - type: string - x-go-name: Host - title: SLoadbalancerAgentDeployment is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentDeployment. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SLoadbalancerAgentParams: - properties: - haproxy_conf_tmpl: - type: string - x-go-name: HaproxyConfTmpl - keepalived_conf_tmpl: - type: string - x-go-name: KeepalivedConfTmpl - telegraf_conf_tmpl: - type: string - x-go-name: TelegrafConfTmpl - title: SLoadbalancerAgentParams is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentParams. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SLoadbalancerClusterParams: - properties: - advert_int: - format: int64 - type: integer - x-go-name: AdvertInt - garp_master_refresh: - format: int64 - type: integer - x-go-name: GarpMasterRefresh - pass: - type: string - x-go-name: Pass - preempt: - type: boolean - x-go-name: Preempt - virtual_router_id: - format: int64 - type: integer - x-go-name: VirtualRouterId - title: SLoadbalancerClusterParams is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerClusterParams. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SMirrorConfig: - properties: - bridge: - type: string - x-go-name: Bridge - direction: - type: string - x-go-name: Direction - flow_id: - format: uint16 - type: integer - x-go-name: FlowId - host_ip: - type: string - x-go-name: HostIp - port: - type: string - x-go-name: Port - tap_host_ip: - type: string - x-go-name: TapHostIp - vlan_id: - format: int64 - type: integer - x-go-name: VlanId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SMongoDBBackup: - properties: - BackupMethod: - $ref: '#/definitions/TMongoDBBackupMethod' - BackupSizeKb: - format: int64 - type: integer - BackupType: - $ref: '#/definitions/TMongoDBBackupType' - Description: - type: string - EndTime: - format: date-time - type: string - Name: - type: string - StartTime: - format: date-time - type: string - Status: - $ref: '#/definitions/TMongoDBBackupStatus' - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SMongoDBBackups: - properties: - Data: - items: - $ref: '#/definitions/SMongoDBBackup' - type: array - Total: - format: int64 - type: integer - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SNatDCreateInput: - properties: - ExternalIp: - type: string - ExternalPort: - format: int64 - type: integer - InternalIp: - type: string - InternalPort: - format: int64 - type: integer - IpProtocol: - type: string - Name: - type: string - NatgatewayId: - type: string - eip: - type: string - x-go-name: Eip - external_ip_id: - type: string - x-go-name: ExternalIpId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SNatSCreateInput: - properties: - Ip: - description: 'swagger: ignore' - type: string - Name: - type: string - NatgatewayId: - type: string - NetworkId: - type: string - SourceCidr: - type: string - eip: - type: string - x-go-name: Eip - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SNetworkUsedAddress: - properties: - AssociateId: - type: string - AssociateType: - type: string - CreatedAt: - format: date-time - type: string - IpAddr: - type: string - MacAddr: - type: string - Owner: - type: string - OwnerId: - type: string - OwnerStatus: - type: string - OwnerType: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SProjectMappingAccount: - 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/compute - SProjectQuotaDetail: - 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 - project: - description: 配额适用的项目名称 - type: string - x-go-name: Project - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - secgroup: - format: int64 - type: integer - x-go-name: Secgroup - 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/compute/models - SProxySetting: - 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 - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - http_proxy: - type: string - x-go-name: HTTPProxy - https_proxy: - type: string - x-go-name: HTTPSProxy - 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 - name: - description: 资源名称 - type: string - x-go-name: Name - no_proxy: - type: string - x-go-name: NoProxy - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - title: SProxySetting is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudcommon/db/proxy.SProxySetting. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/cloudcommon/proxy - SQuotaDetail: - description: 主机配额详情 - properties: - Hypervisor: - description: 主机配额适用的主机类型，参考主机List的Hypervisor列表 - type: string - account: - description: 配额适用的云账号名称 - type: string - x-go-name: Account - account_id: - description: 配额适用的云账号ID - type: string - x-go-name: AccountId - brand: - description: 配额适用的品牌名称，参考List接口的品牌列表 - type: string - x-go-name: Brand - cloud_env: - description: 配额适用的云环境，参考List接口的云环境列表 - type: string - x-go-name: CloudEnv - count: - description: 主机数量配额 - format: int64 - type: integer - x-go-name: Count - cpu: - description: 主机CPU核数量配额 - format: int64 - type: integer - x-go-name: Cpu - 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: - description: 主机组配额 - format: int64 - type: integer - x-go-name: Group - isolated_device: - description: 直通设备(GPU)配额 - format: int64 - type: integer - x-go-name: IsolatedDevice - manager: - description: 配额适用的云订阅名称 - type: string - x-go-name: Manager - manager_id: - description: 配额适用的云订阅ID - type: string - x-go-name: ManagerId - memory: - description: 主机内存容量配额 - format: int64 - type: integer - x-go-name: Memory - project: - description: 配额适用的项目名称 - type: string - x-go-name: Project - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - provider: - description: 配额适用的平台名称，参考List接口的平台列表 - type: string - x-go-name: Provider - region: - description: 配额适用的区域名称 - type: string - x-go-name: Region - region_id: - description: 配额适用的区域ID - type: string - x-go-name: RegionId - storage: - description: 主机存储容量配额 - format: int64 - type: integer - x-go-name: Storage - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - zone: - description: 配额适用的可用区名称 - type: string - x-go-name: Zone - zone_id: - description: 配额适用的可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/compute/models - SRegionQuotaDetail: - description: 区域配额详情 - properties: - account: - description: 配额适用的云账号名称 - type: string - x-go-name: Account - account_id: - description: 配额适用的云账号ID - type: string - x-go-name: AccountId - brand: - description: 配额适用的品牌名称，参考List接口的品牌列表 - type: string - x-go-name: Brand - bucket: - format: int64 - type: integer - x-go-name: Bucket - cache: - format: int64 - type: integer - x-go-name: Cache - cloud_env: - description: 配额适用的云环境，参考List接口的云环境列表 - type: string - x-go-name: CloudEnv - 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 - eip: - format: int64 - type: integer - x-go-name: Eip - eport: - format: int64 - type: integer - x-go-name: Eport - instance_snapshot: - format: int64 - type: integer - x-go-name: InstanceSnapshot - loadbalancer: - format: int64 - type: integer - x-go-name: Loadbalancer - manager: - description: 配额适用的云订阅名称 - type: string - x-go-name: Manager - manager_id: - description: 配额适用的云订阅ID - type: string - x-go-name: ManagerId - mongodb: - format: int64 - type: integer - x-go-name: Mongodb - object_cnt: - format: int64 - type: integer - x-go-name: ObjectCnt - object_gb: - format: int64 - type: integer - x-go-name: ObjectGB - port: - format: int64 - type: integer - x-go-name: Port - project: - description: 配额适用的项目名称 - type: string - x-go-name: Project - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - provider: - description: 配额适用的平台名称，参考List接口的平台列表 - type: string - x-go-name: Provider - rds: - format: int64 - type: integer - x-go-name: Rds - region: - description: 配额适用的区域名称 - type: string - x-go-name: Region - region_id: - description: 配额适用的区域ID - type: string - x-go-name: RegionId - snapshot: - format: int64 - type: integer - x-go-name: Snapshot - 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/compute/models - SRoute: - properties: - cidr: - type: string - x-go-name: Cidr - next_hop_id: - type: string - x-go-name: NextHopId - next_hop_type: - type: string - x-go-name: NextHopType - type: - type: string - x-go-name: Type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SRoutes: - items: - $ref: '#/definitions/SRoute' - type: array - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SSecgroupCreateInput: - 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 - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - rules: - description: 规则列表 - items: - $ref: '#/definitions/SSecgroupRuleCreateInput' - type: array - x-go-name: Rules - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SSecgroupRuleCreateInput: - properties: - action: - description: |- - 行为 - deny: 拒绝 - allow: 允许 - enum: - - deny - - ' allow' - type: string - x-go-name: Action - cidr: - description: ip或cidr地址, 若指定peer_secgroup_id此参数不生效 - example: 192.168.222.121 - type: string - x-go-name: CIDR - description: - description: |- - 规则描述信息 - requried: false - example: test to create rule - type: string - x-go-name: Description - direction: - description: 方向 - enum: - - in - - ' out' - type: string - x-go-name: Direction - ports: - description: |- - 端口列表, 参数为空代表任意端口 - 此参数仅对protocol是tcp, udp时生效 - 支持格式: - 格式类型 | 举例 | - -------- | ---- | - 单端口 | 22 | - 端口范围 | 100-200 | - 不连续端口| 80,443 | - requried: false - type: string - x-go-name: Ports - priority: - description: 优先级, 数字越大优先级越高 - format: int64 - maximum: 100 - minimum: 1 - type: integer - x-go-name: Priority - protocol: - description: 协议 - enum: - - any - - ' tcp' - - ' udp' - - ' icmp' - type: string - x-go-name: Protocol - secgroup_id: - description: 安全组ID - type: string - x-go-name: SecgroupId - required: - - priority - - protocol - - direction - - action - - secgroup_id - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SSecgroupRuleUpdateInput: - properties: - action: - description: |- - 行为 - deny: 拒绝 - allow: 允许 - enum: - - deny - - ' allow' - type: string - x-go-name: Action - cidr: - description: ip或cidr地址, 若指定peer_secgroup_id此参数不生效 - example: 192.168.222.121 - type: string - x-go-name: CIDR - description: - description: |- - 规则描述信息 - requried: false - example: test to create rule - type: string - x-go-name: Description - direction: - description: 方向 - enum: - - in - - ' out' - type: string - x-go-name: Direction - ports: - description: |- - 端口列表, 参数为空代表任意端口 - 此参数仅对protocol是tcp, udp时生效 - 支持格式: - 格式类型 | 举例 | - -------- | ---- | - 单端口 | 22 | - 端口范围 | 100-200 | - 不连续端口| 80,443 | - requried: false - type: string - x-go-name: Ports - priority: - description: 优先级, 数字越大优先级越高 - format: int64 - maximum: 100 - minimum: 1 - type: integer - x-go-name: Priority - protocol: - description: 协议 - enum: - - any - - ' tcp' - - ' udp' - - ' icmp' - type: string - x-go-name: Protocol - required: - - priority - - protocol - - direction - - action - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SSimpleBackup: - properties: - backup_storage_id: - description: 备份存储Id - type: string - x-go-name: BackupStorageId - created_at: - description: 创建时间 - format: date-time - type: string - x-go-name: CreatedAt - disk_size_mb: - description: 磁盘大小 - format: int64 - type: integer - x-go-name: DiskSizeMb - disk_type: - description: 磁盘类型 - type: string - x-go-name: DiskType - encrypt_key_id: - description: 密钥 - type: string - x-go-name: EncryptKeyId - id: - description: 备份Id - type: string - x-go-name: Id - name: - description: 备份名称 - type: string - x-go-name: Name - size_mb: - description: 备份大小 - format: int64 - type: integer - x-go-name: SizeMb - status: - description: 快照状态 - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SSubAccount: - properties: - Account: - description: 输入必填，若为空，需要指定子账号名称 - type: string - DefaultProjectId: - type: string - Desc: - description: 描述信息 - type: string - HealthStatus: - type: string - Name: - description: 若Account不为空，可不传 - type: string - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - 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 - STapServiceConfig: - properties: - Mirrors: - items: - $ref: '#/definitions/SMirrorConfig' - type: array - ifname: - type: string - x-go-name: Ifname - mac_addr: - type: string - x-go-name: MacAddr - tap_host_ip: - type: string - x-go-name: TapHostIp - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SWafRule: - properties: - action: - $ref: '#/definitions/DefaultAction' - 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 - description: - description: 资源描述信息 - type: string - x-go-name: Description - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - name: - description: 资源名称 - type: string - x-go-name: Name - priority: - description: 规则优先级 - format: int64 - type: integer - x-go-name: Priority - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - statement_conditon: - description: 条件 - type: string - x-go-name: StatementConditon - status: - description: 资源状态 - type: string - x-go-name: Status - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - waf_instance_id: - description: 所属waf实例id - type: string - x-go-name: WafInstanceId - waf_rule_group_id: - description: 规则组的id - type: string - x-go-name: WafRuleGroupId - title: SWafRule is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SWafRule. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SWafStatement: - description: +onecloud:model-api-gen - properties: - ExcludeRules: - $ref: '#/definitions/SExcludeRules' - ForwardedIPHeader: - type: string - IPSetId: - type: string - ManagedRuleGroupName: - description: 管理规则组名称 - type: string - MatchField: - $ref: '#/definitions/TWafMatchField' - MatchFieldKey: - description: 匹配字段的key - type: string - MatchFieldValues: - $ref: '#/definitions/TWafMatchFieldValues' - Negation: - description: 是否取反操作, 仅对Azure生效 - type: boolean - Operator: - $ref: '#/definitions/TWafOperator' - RegexSetId: - description: 正则表达式Id, 目前只读 - type: string - RuleGroupId: - description: 自定义规则组Id, 目前只读 - type: string - SearchString: - description: 搜索字段, 仅Aws有用 - type: string - Transformations: - $ref: '#/definitions/TextTransformations' - Type: - $ref: '#/definitions/TWafStatementType' - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SZoneQuotaDetail: - description: 可用区配额详情 - properties: - account: - description: 配额适用的云账号名称 - type: string - x-go-name: Account - account_id: - description: 配额适用的云账号ID - type: string - x-go-name: AccountId - brand: - description: 配额适用的品牌名称，参考List接口的品牌列表 - type: string - x-go-name: Brand - cloud_env: - description: 配额适用的云环境，参考List接口的云环境列表 - type: string - x-go-name: CloudEnv - 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 - manager: - description: 配额适用的云订阅名称 - type: string - x-go-name: Manager - manager_id: - description: 配额适用的云订阅ID - type: string - x-go-name: ManagerId - project: - description: 配额适用的项目名称 - type: string - x-go-name: Project - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - provider: - description: 配额适用的平台名称，参考List接口的平台列表 - type: string - x-go-name: Provider - region: - description: 配额适用的区域名称 - type: string - x-go-name: Region - region_id: - description: 配额适用的区域ID - type: string - x-go-name: RegionId - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - zone: - description: 配额适用的可用区名称 - type: string - x-go-name: Zone - zone_id: - description: 配额适用的可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/compute/models - ScalingActivityDetails: - properties: - action_desc: - description: 行为描述 - type: string - x-go-name: ActionDesc - 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 - end_time: - format: date-time - type: string - x-go-name: EndTime - id: - description: 资源UUID - type: string - x-go-name: Id - instance_number: - format: int64 - type: integer - x-go-name: InstanceNumber - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - reason: - type: string - x-go-name: Reason - scaling_group: - description: 'description: 伸缩组名称' - example: sg-nihao - type: string - x-go-name: ScalingGroup - scaling_group_id: - description: ScalingGroupId - example: sg-1234 - type: string - x-go-name: ScalingGroupId - start_time: - format: date-time - type: string - x-go-name: StartTime - status: - description: 资源状态 - type: string - x-go-name: Status - trigger_desc: - description: 起因描述 - type: string - x-go-name: TriggerDesc - 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/compute - ScalingAlarmCreateInput: - properties: - cumulate: - description: 'description: 累计次数(报警次数达到此累计次数就会触发伸缩活动)' - example: 1 - format: int64 - type: integer - x-go-name: Cumulate - cycle: - description: 'description: 监控周期，单位s' - example: 300 - format: int64 - type: integer - x-go-name: Cycle - indicator: - description: 'description: 监控指标' - enum: - - cpu - - disk_read - - disk_write - - flow_into - - flow_out - example: cpu - type: string - x-go-name: Indicator - operator: - description: 'descripion: 监控指标的比较符' - enum: - - ge - - le - example: ge - type: string - x-go-name: Operator - value: - description: 'description: 监控指标的取值' - example: 3 - format: double - type: number - x-go-name: Value - wrapper: - description: 'description: 监控指标的取值方式(比如最大值，最小值，平均值)' - enum: - - max - - min - - average - example: max - type: string - x-go-name: Wrapper - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ScalingAlarmDetails: - properties: - cumulate: - description: 'description: 累计次数，只有到达累计次数的报警才会触发伸缩活动' - format: int64 - type: integer - x-go-name: Cumulate - cycle: - description: 'description: 监控周期' - format: int64 - type: integer - x-go-name: Cycle - indicator: - description: 'description: 指标' - type: string - x-go-name: Indicator - operator: - description: 'description: 指标和阈值之间的比较关系，>=/<=' - type: string - x-go-name: Operator - value: - description: 'description: 阈值' - format: double - type: number - x-go-name: Value - wrapper: - description: 'description: 指标的取值方式，最大值/最小值/平均值' - type: string - x-go-name: Wrapper - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ScalingGroupCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - backend_group_id: - description: 'swagger: ignore' - type: string - x-go-name: BackendGroupId - cloudregion: - description: 'description: cloud region id or name' - example: cr-test-one - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 'swagger: ignore' - type: string - x-go-name: CloudregionId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - desire_instance_number: - description: 'description: 期望实例数' - example: 1 - format: int64 - type: integer - x-go-name: DesireInstanceNumber - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - enabled: - description: 该资源是否被管理员*人为*启用或者禁用 - type: boolean - x-go-name: Enabled - expansion_principle: - description: 'description: 扩容策略' - enum: - - balanced - example: balanced - type: string - x-go-name: ExpansionPrinciple - external_access_mode: - description: Vpc外网访问模式 - type: string - x-go-name: ExternalAccessMode - 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 - guest_template: - description: 'description: 主机模板 id or name' - example: gt-test-one - type: string - x-go-name: GuestTemplate - guest_template_id: - description: 'swagger: ignore' - type: string - x-go-name: GuestTemplateId - health_check_cycle: - description: 'description: 健康检查周期' - example: 300 - format: int64 - type: integer - x-go-name: HealthCheckCycle - health_check_gov: - description: 'description: 健康检查缓冲时间' - example: 180 - format: int64 - type: integer - x-go-name: HealthCheckGov - health_check_mode: - description: 'description: 检查健康模式' - enum: - - normal - - loadbalancer - example: normal - type: string - x-go-name: HealthCheckMode - hypervisor: - description: 'description: hypervisor' - example: kvm - type: string - x-go-name: Hypervisor - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - lb_backend_group: - description: 'description: 负载均衡后端服务器组' - example: lbg-nihao - type: string - x-go-name: LbBackendGroup - loadbalancer_backend_port: - description: 'description: 负载均衡后端服务器统一端口' - example: 8080 - format: int64 - type: integer - x-go-name: LoadbalancerBackendPort - loadbalancer_backend_weight: - description: 'description: 负载均衡后端服务器的weight' - example: 10 - format: int64 - type: integer - x-go-name: LoadbalancerBackendWeight - max_instance_number: - description: 'description: 最大实例数' - example: 10 - format: int64 - type: integer - x-go-name: MaxInstanceNumber - min_instance_number: - description: 'description: 最小实例数' - example: 0 - format: int64 - type: integer - x-go-name: MinInstanceNumber - 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 - networks: - description: 'description: 多个网络(ID或者Name),' - example: n-test-one - items: - type: string - type: array - x-go-name: Networks - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - shrink_principle: - description: 'description: 缩容策略' - enum: - - earliest - - latest - - config_earliest - - config_latest - example: latest - type: string - x-go-name: ShrinkPrinciple - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - vpc_id: - description: 关联VPC(ID或Name) - type: string - x-go-name: VpcId - required: - - name - - cloudregion - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ScalingGroupDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - backend_group: - description: 负载均衡后端组名称 - type: string - x-go-name: BackendGroup - backend_group_id: - description: 负载均衡后端组ID - type: string - x-go-name: BackendGroupId - brand: - description: 'description: 平台' - example: OneCloud - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - desire_instance_number: - description: |- - DesireInstanceNumber represent the number of instances that should exist in the scaling group. - Scaling controller will monitor and ensure this in real time. - Scaling activities triggered by various policies will also modify this value. - This value should between MinInstanceNumber and MaxInstanceNumber - format: int64 - type: integer - x-go-name: DesireInstanceNumber - domain_id: - description: 域Id - type: string - x-go-name: DomainId - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - environment: - description: Environment - type: string - x-go-name: Environment - expansion_principle: - description: ExpansionPrinciple represent the principle when creating new - instance to join in. - type: string - x-go-name: ExpansionPrinciple - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - group: - description: 实例组名称 - type: string - x-go-name: Group - group_id: - description: 实例组ID - type: string - x-go-name: GroupId - guest_template: - description: 主机模板名称 - type: string - x-go-name: GuestTemplate - guest_template_id: - description: 主机模板ID - type: string - x-go-name: GuestTemplateId - health_check_cycle: - format: int64 - type: integer - x-go-name: HealthCheckCycle - health_check_gov: - format: int64 - type: integer - x-go-name: HealthCheckGov - health_check_mode: - type: string - x-go-name: HealthCheckMode - hypervisor: - type: string - x-go-name: Hypervisor - id: - description: 资源UUID - type: string - x-go-name: Id - instance_number: - description: 'description: 实例数' - example: 0 - format: int64 - type: integer - x-go-name: InstanceNumber - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - loadbalancer: - description: 负载均衡名称 - type: string - x-go-name: Loadbalancer - loadbalancer_backend_port: - format: int64 - type: integer - x-go-name: LoadbalancerBackendPort - loadbalancer_backend_weight: - format: int64 - type: integer - x-go-name: LoadbalancerBackendWeight - loadbalancer_id: - description: 负载均衡ID - type: string - x-go-name: LoadbalancerId - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - max_instance_number: - format: int64 - type: integer - x-go-name: MaxInstanceNumber - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - min_instance_number: - format: int64 - type: integer - x-go-name: MinInstanceNumber - name: - description: 资源名称 - type: string - x-go-name: Name - networks: - description: 'description: 网络信息' - items: - $ref: '#/definitions/ScalingGroupNetwork' - type: array - x-go-name: Networks - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - scaling_policy_number: - description: 'description: 伸缩策略的数量' - example: 3 - format: int64 - type: integer - x-go-name: ScalingPolicyNumber - shrink_principle: - description: ShrinkPrinciple represent the principle when removing instance - from scaling group. - type: string - x-go-name: ShrinkPrinciple - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - description: VPC ID - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ScalingGroupNetwork: - properties: - guest_ip_end: - type: string - x-go-name: GuestIpEnd - guest_ip_start: - type: string - x-go-name: GuestIpStart - 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/compute - ScalingPolicyCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - action: - description: 'desciption: 伸缩策略的行为(增加还是删除或者调整为)' - enum: - - add - - remove - - set - example: add - type: string - x-go-name: Action - alarm: - $ref: '#/definitions/ScalingAlarmCreateInput' - cooling_time: - description: 'desciption: Scaling activity triggered by alarms will be rejected - during this period about CoolingTime' - example: 300 - format: int64 - type: integer - x-go-name: CoolingTime - cycle_timer: - $ref: '#/definitions/CycleTimerCreateInput' - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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 - number: - description: 'desciption: 实例的数量' - example: 2 - format: int64 - type: integer - x-go-name: Number - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - scaling_group: - description: 'description: scaling_group ID or Name' - example: sg-test-one - type: string - x-go-name: ScalingGroup - scaling_group_id: - description: 'swagger: ignore' - type: string - x-go-name: ScalingGroupId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - timer: - $ref: '#/definitions/TimerCreateInput' - trigger_type: - description: 'description: trigger type' - enum: - - timing - - cycle - - alarm - type: string - x-go-name: TriggerType - unit: - description: 'desciption: 实例数量的单位' - enum: - - s - - '%' - example: s - type: string - x-go-name: Unit - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ScalingPolicyDetails: - properties: - action: - description: Action of scaling activity - type: string - x-go-name: Action - alarm: - $ref: '#/definitions/ScalingAlarmDetails' - 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 - cooling_time: - description: Scaling activity triggered by alarms will be rejected during - this period about CoolingTime - format: int64 - type: integer - x-go-name: CoolingTime - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - cycle_timer: - $ref: '#/definitions/CycleTimerDetails' - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - 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 - number: - format: int64 - type: integer - x-go-name: Number - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - scaling_group: - description: 'description: 伸缩组名称' - example: sg-nihao - type: string - x-go-name: ScalingGroup - scaling_group_id: - description: ScalingGroupId - example: sg-1234 - type: string - x-go-name: ScalingGroupId - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - timer: - $ref: '#/definitions/TimerDetails' - trigger_id: - type: string - x-go-name: TriggerId - trigger_type: - type: string - x-go-name: TriggerType - unit: - description: Unit of Number - type: string - x-go-name: Unit - 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/compute - SchedpolicyDetails: - 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 - condition: - type: string - x-go-name: Condition - 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 - 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 - resource_type: - description: 调度标签管理的资源类型 - type: string - x-go-name: ResourceType - schedtag: - description: 调度标签名称 - type: string - x-go-name: Schedtag - schedtag_id: - description: 归属调度标签ID - type: string - x-go-name: SchedtagId - strategy: - type: string - x-go-name: Strategy - 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/compute - SchedtagConfig: - properties: - id: - type: string - x-go-name: Id - resource_type: - type: string - x-go-name: ResourceType - strategy: - type: string - x-go-name: Strategy - weight: - format: int64 - type: integer - x-go-name: Weight - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SchedtagCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - default_strategy: - description: 动态标签策略 - enum: - - exclude - - ' prefer' - - ' avoid' - type: string - x-go-name: DefaultStrategy - 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 - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - resource_type: - default: hosts - description: 资源类型 - enum: - - servers - - ' hosts' - - ' .....' - type: string - x-go-name: ResourceType - scope: - type: string - x-go-name: Scope - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SchedtagDetails: - 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 - default_strategy: - type: string - x-go-name: DefaultStrategy - 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 - dynamic_schedtag_count: - format: int64 - type: integer - x-go-name: DynamicSchedtagCount - host_count: - format: int64 - type: integer - x-go-name: HostCount - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - join_model_keyword: - type: string - x-go-name: JoinModelKeyword - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - other_count: - format: int64 - type: integer - x-go-name: OtherCount - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - resource_count: - format: int64 - type: integer - x-go-name: ResourceCount - resource_type: - description: Column(VARCHAR(16, charset='ascii'), nullable=True, default='') - type: string - x-go-name: ResourceType - schedpolicy_count: - format: int64 - type: integer - x-go-name: SchedpolicyCount - scope: - type: string - x-go-name: Scope - server_count: - format: int64 - type: integer - x-go-name: ServerCount - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - SchedtagSetResourceInput: - properties: - resource_ids: - items: - type: string - type: array - x-go-name: ResourceIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SchedtagShortDescDetails: - properties: - default: - type: string - x-go-name: Default - id: - type: string - x-go-name: Id - name: - type: string - x-go-name: Name - res_name: - type: string - x-go-name: ResName - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SecgroupDetails: - properties: - admin_guest_cnt: - description: admin_secgrp_id为此安全组的云主机数量, , 不包含回收站云主机 - format: int64 - type: integer - x-go-name: AdminGuestCnt - cache_cnt: - description: 安全组缓存数量 - format: int64 - type: integer - x-go-name: CacheCnt - 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 - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - guest_cnt: - description: 关联云主机数量, 不包含回收站云主机 - format: int64 - type: integer - x-go-name: GuestCnt - id: - description: 资源UUID - type: string - x-go-name: Id - in_rules: - description: 入方向规则信息 - items: - $ref: '#/definitions/SecgroupRuleDetails' - type: array - x-go-name: InRules - is_dirty: - type: boolean - x-go-name: IsDirty - 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 - out_rules: - description: 出方向规则信息 - items: - $ref: '#/definitions/SecgroupRuleDetails' - type: array - x-go-name: OutRules - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - rules: - description: 规则信息 - items: - $ref: '#/definitions/SecgroupRuleDetails' - type: array - x-go-name: Rules - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - status: - description: 资源状态 - type: string - x-go-name: Status - system_guest_cnt: - description: 关联此安全组的云主机is_system为true数量, , 不包含回收站云主机 - format: int64 - type: integer - x-go-name: SystemGuestCnt - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - total_cnt: - description: 所有关联的资源数量 - format: int64 - type: integer - x-go-name: TotalCnt - 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/compute - SecgroupImportRulesInput: - properties: - rules: - items: - $ref: '#/definitions/SSecgroupRuleCreateInput' - type: array - x-go-name: Rules - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SecgroupMergeInput: - properties: - secgroup_ids: - description: 安全组id列表 - items: - type: string - type: array - x-go-name: SecgroupIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SecgroupRuleDetails: - properties: - action: - type: string - x-go-name: Action - 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 - cidr: - type: string - x-go-name: CIDR - 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 - direction: - type: string - x-go-name: Direction - id: - type: string - x-go-name: Id - ports: - type: string - x-go-name: Ports - priority: - format: int64 - type: integer - x-go-name: Priority - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - protocol: - type: string - x-go-name: Protocol - secgroup: - description: 安全组名称 - type: string - x-go-name: Secgroup - secgroup_id: - description: 本地安全组ID - type: string - x-go-name: SecgroupId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - type: string - x-go-name: ProjectId - 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/compute - SecurityGroupCacheDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - external_project_id: - type: string - x-go-name: ExternalProjectId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - reference_count: - description: 被其他安全组引用的次数 - format: int64 - type: integer - x-go-name: ReferenceCount - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - secgroup_id: - description: 本地安全组ID - type: string - x-go-name: SecgroupId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - type: string - x-go-name: ProjectId - 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 - vpc: - description: 虚拟私有网络名称 - type: string - x-go-name: Vpc - vpc_id: - description: 虚拟私有网络外部Id - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SecurityGroupCacheInput: - properties: - vpc_id: - type: string - x-go-name: VpcId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SecurityGroupCloneInput: - properties: - Description: - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SecurityGroupReference: - properties: - Id: - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - ServerAssociateEipInput: - properties: - eip_id: - description: 弹性公网IP的ID - type: string - x-go-name: EipId - ip_addr: - description: 弹性IP映射的内网IP地址，可选 - type: string - x-go-name: IpAddr - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerAttachDiskInput: - properties: - boot_index: - format: int8 - type: integer - x-go-name: BootIndex - disk_id: - type: string - x-go-name: DiskId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerCPUSetInput: - properties: - cpus: - description: Specifies the CPUs that tasks in this cgroup are permitted to - access. - items: - format: int64 - type: integer - type: array - x-go-name: CPUS - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerCPUSetRemoveInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerCPUSetRemoveResp: - properties: - done: - type: boolean - x-go-name: Done - error: - type: string - x-go-name: Error - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerChangeConfigInput: - properties: - auto_start: - description: 调整完配置后是否自动启动 - type: boolean - x-go-name: AutoStart - disks: - items: - $ref: '#/definitions/DiskConfig' - type: array - x-go-name: Disks - flavor: - description: 'swagger: ignore' - type: string - x-go-name: Flavor - instance_type: - description: |- - 关机且停机不收费情况下不允许调整配置 - 实例类型, 优先级高于vcpu_count和vmem_size - type: string - x-go-name: InstanceType - sku: - description: 'swagger: ignore' - type: string - x-go-name: Sku - vcpu_count: - description: cpu大小 - format: int64 - type: integer - x-go-name: VcpuCount - vmem_size: - description: 内存大小, 1024M, 1G - type: string - x-go-name: VmemSize - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerChangeDiskStorageInput: - properties: - disk_id: - type: string - x-go-name: DiskId - keep_origin_disk: - type: boolean - x-go-name: KeepOriginDisk - target_storage_id: - type: string - x-go-name: TargetStorageId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerChangeStorageInput: - properties: - keep_origin_disk: - type: boolean - x-go-name: KeepOriginDisk - target_storage_id: - type: string - x-go-name: TargetStorageId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerCreateEipInput: - properties: - auto_dellocate: - description: auto_dellocate - type: boolean - x-go-name: AutoDellocate - bandwidth: - description: Bandwidth - format: int64 - type: integer - x-go-name: Bandwidth - bgp_type: - description: bgp_type - type: string - x-go-name: BgpType - charge_type: - description: 计费方式，traffic or bandwidth - type: string - x-go-name: ChargeType - ip_addr: - description: 弹性IP映射的内网IP地址，可选 - type: string - x-go-name: IpAddr - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - __parent_task_id: - description: Used to store BaremetalConvertHypervisorTaskId - type: string - x-go-name: ParentTaskId - auto_renew: - default: false - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - auto_start: - default: false - description: |- - 创建后自动启动 - 部分云创建后会自动启动例如: 腾讯云, AWS, OpenStack, ZStack, Ucloud, Huawei, Azure, 天翼云 - type: boolean - x-go-name: AutoStart - backup: - default: false - description: 虚拟机高可用(创建备机) - type: boolean - x-go-name: Backup - baremetal_disk_configs: - description: 裸金属磁盘配置列表 - items: - $ref: '#/definitions/BaremetalDiskConfig' - type: array - x-go-name: BaremetalDiskConfigs - bios: - description: |- - BIOS类型, 若镜像是Windows，并且支持UEFI,则自动会设置为UEFI - emulate: BIOS, UEFI - type: string - x-go-name: Bios - boot_order: - default: cdn - description: |- - 启动顺序 - c: cdrome - d: disk - n: network - example: cnd - type: string - x-go-name: BootOrder - cdrom: - description: 使用ISO光盘启动, 仅KVM平台支持 - type: string - x-go-name: Cdrom - cdrom_boot_index: - format: int8 - type: integer - x-go-name: CdromBootIndex - deploy_configs: - items: - $ref: '#/definitions/DeployConfig' - type: array - x-go-name: DeployConfigs - deploy_telegraf: - type: boolean - x-go-name: DeployTelegraf - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disable_delete: - default: true - description: 删除保护,创建的资源默认不允许删除 - type: boolean - x-go-name: DisableDelete - disks: - description: |- - 磁盘列表,第一块磁盘为系统盘,需要指定image_id - 若指定主机快照，此参数可以为空 - items: - $ref: '#/definitions/DiskConfig' - type: array - x-go-name: Disks - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - duration: - description: |- - 包年包月时长 - - - 平台 |是否支持 | - ---- |------- | - KVM |否 | - ESxi |否 | - OpenStack |否 | - ZStack |否 | - Google |否 | - Azure |否 | - AWS |否 | - 腾讯云 |是 | - Aliyun |是 | - Ucloud |是 | - Huawei |是 | - 天翼云 |是 | - type: string - x-go-name: Duration - eip: - description: |- - 弹性公网IP名称或ID - 绑定已有弹性公网IP, 此参数会限制虚拟机再谈下公网IP所在的区域创建 - type: string - x-go-name: Eip - eip_auto_dellocate: - description: 是否跟随主机删除而自动释放 - type: boolean - x-go-name: EipAutoDellocate - eip_bgp_type: - description: 弹性公网IP线路类型 - type: string - x-go-name: EipBgpType - eip_bw: - description: |- - 弹性公网IP带宽 - 指定此参数后会创建新的弹性公网IP并绑定到新建的虚拟机 - 此参数优先级低于public_ip - format: int64 - type: integer - x-go-name: EipBw - eip_charge_type: - description: 弹性公网IP计费类型 - type: string - x-go-name: EipChargeType - enable_cloud_init: - default: false - description: 启用cloud-init,需要镜像装有cloud-init服务 - type: boolean - x-go-name: EnableCloudInit - enable_memclean: - type: boolean - x-go-name: EnableMemclean - encrypt_key_alg: - description: 新建密钥算法 - type: string - x-go-name: EncryptKeyAlg - encrypt_key_id: - description: 加密密钥的ID - type: string - x-go-name: EncryptKeyId - encrypt_key_new: - description: 是否新建密钥 - type: boolean - x-go-name: EncryptKeyNew - encrypt_key_user_id: - description: 加密密钥的用户ID - type: string - x-go-name: EncryptKeyUserId - fake_create: - description: |- - swagger: ignore - 创建测试数据，不实际创建资源 - type: boolean - x-go-name: FakeCreate - 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 - groups: - description: 主机组列表, 参数可以是主机组名称或ID,建议使用ID - items: - type: string - type: array - x-go-name: InstanceGroupIds - guest_image_id: - description: 指定用于新建主机的主机镜像ID - type: string - x-go-name: GuestImageID - hostname: - description: |- - 主机名 - 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 - 字符长度2-60个字符 - Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 - 若输入为空，则会根据资源名称自动生成主机名 - 输入不为空则会自动剔除不符合规则的字符, 并进行校验 - 若长度大于允许的最大长度，会自动截取 - type: string - x-go-name: Hostname - hypervisor: - default: kvm - description: |- - 虚拟化技术或平台 - - - - hypervisor | 技术或平台 | - ------- | ---------- | - kvm | 本地私有云 | - esxi | VMWare | - baremetal | 裸金属 | - aliyun | 阿里云 | - aws | 亚马逊 | - qcloud | 腾讯云 | - azure | 微软云 | - huawei | 华为云 | - openstack | OpenStack | - ucloud | Ucloud | - zstack | ZStack | - google | 谷歌云 | - ctyun | 天翼云 | - type: string - x-go-name: Hypervisor - instance_backup_id: - description: |- - 使用主机备份创建虚拟机, 主机快照不会重置密码及秘钥信息 - 使用主机备份创建的虚拟机将沿用之前的密码秘钥及安全组信息 - type: string - x-go-name: InstanceBackupId - instance_snapshot_id: - description: |- - 使用主机快照创建虚拟机, 主机快照不会重置密码及秘钥信息 - 使用主机快照创建的虚拟机将沿用之前的密码秘钥及安全组信息 - type: string - x-go-name: InstanceSnapshotId - instance_type: - description: |- - 套餐名称, 此参数优先级高于vcpu_count和vmem_size - 套餐可以通过 serverskus 列表获取 - esxi, openstack, zstack等私有云都统一使用provider为OneCloud的套餐 - 公有云使用各自的套餐 - type: string - x-go-name: InstanceType - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - isolated_devices: - description: 透传设备列表 - items: - $ref: '#/definitions/IsolatedDeviceConfig' - type: array - x-go-name: IsolatedDevices - keypair_id: - description: 秘钥对Id - type: string - x-go-name: KeypairId - login_account: - description: 登录账户 - type: string - x-go-name: LoginAccount - machine: - description: |- - Machine类型 - emulate: pc, q35 - type: string - x-go-name: Machine - 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 - nets: - description: 指定主机网络 - items: - $ref: '#/definitions/NetworkConfig' - type: array - x-go-name: Networks - password: - description: |- - 密码 - 要求: 密码长度 >= 20, 至少包含一个数字一个小写字母一个大小字母及特殊字符~`!@#$%^&*()-_=+[]{}|:';\",./<>?中的一个 - requried: false - type: string - x-go-name: Password - prefer_backup_host: - description: 主机高可用时，将备机调度到指定宿主机, 此参数仅对KVM生效 - type: string - x-go-name: PreferBackupHost - prefer_host_id: - description: 调度使用指定宿主机 - type: string - x-go-name: PreferHost - prefer_manager_id: - description: 调度使用指定的云账号 - type: string - x-go-name: PreferManager - prefer_region_id: - description: 调度到指定区域,优先级低于prefer_zone_id - type: string - x-go-name: PreferRegion - prefer_wire_id: - description: 调度使用指定二层网络, 优先级低于prefer_host_id - type: string - x-go-name: PreferWire - prefer_zone_id: - description: 调度到指定可用区,优先级低于prefer_host_id - type: string - x-go-name: PreferZone - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_ip_bw: - description: |- - 公网IP带宽(单位MB) - 若指定此参数则忽略eip相关参数 - 私有云不支持此参数 - - - 平台 |支持范围 | - ---- |------- | - 腾讯云 |按量计费1-100, 包年包月1-200 | - format: int64 - type: integer - x-go-name: PublicIpBw - public_ip_charge_type: - description: |- - 公网IP计费类型 - 默认按流量计费 - - - 类别 |说明 | - ---- |------- | - traffic |按流量计费| - bandwidth |按带宽计费| - type: string - x-go-name: PublicIpChargeType - reset_password: - description: |- - 随机密码, 若指定password参数,此参数不生效 - 若值为false并且password为空,则表示保留镜像密码 - type: boolean - x-go-name: ResetPassword - schedtags: - description: 调度标签 - items: - $ref: '#/definitions/SchedtagConfig' - type: array - x-go-name: Schedtags - secgroups: - description: 安全组Id列表 - items: - type: string - type: array - x-go-name: Secgroups - secgrp_id: - description: 安全组Id, 此参数会和secgroups参数合并 - type: string - x-go-name: SecgroupId - shutdown_behavior: - default: stop - description: |- - 关机后执行的操作 - terminate: 关机后自动删除 - emum: stop, terminate - type: string - x-go-name: ShutdownBehavior - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - suggestion: - description: DEPRECATE - type: boolean - x-go-name: Suggestion - user_data: - description: |- - 用户自定义启动脚本 - 部分平台只支持 #cloud-config yaml 格式(由于部分平台密码依赖cloud-init注入密码信息,所以不支持特殊类型的user data) - 支持特殊user data平台: Aliyun, Qcloud, Azure, Apsara, Ucloud - type: string - x-go-name: UserData - vcpu_count: - default: 1 - description: 虚拟机Cpu大小,若未指定instance_type,此参数为必传项 - format: int64 - type: integer - x-go-name: VcpuCount - vdi: - default: vnc - description: 远程连接协议 - enum: - - vnc - - ' spice' - type: string - x-go-name: Vdi - vga: - default: std - enum: - - cirros - - ' vmware' - - ' qxl' - - ' std' - type: string - x-go-name: Vga - vmem_size: - description: 虚拟机内存大小,单位Mb,若未指定instance_type,此参数为必传项 - format: int64 - type: integer - x-go-name: VmemSize - required: - - name - - disks - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerDelExtraOptionInput: - properties: - key: - type: string - x-go-name: Key - value: - type: string - x-go-name: Value - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerDeployInput: - properties: - __delete_keypair__: - description: 解绑当前虚拟机秘钥, 并清理公钥信息 - type: boolean - x-go-name: DeleteKeypair - auto_start: - description: |- - 部署完成后是否自动启动 - 若虚拟机重置密码后需要重启生效，并且当前虚拟机状态为running, 此参数默认为true - 若虚拟机状态为ready, 指定此参数后，部署完成后，虚拟机会自动启动 - type: boolean - x-go-name: AutoStart - delete_public_key: - description: |- - 清理指定公钥 - 若指定的秘钥Id和虚拟机的秘钥Id不相同, 则清理旧的公钥 - type: string - x-go-name: DeletePublicKey - deploy_configs: - description: 'swagger: ignore' - items: - $ref: '#/definitions/DeployConfig' - type: array - x-go-name: DeployConfigs - deploy_telegraf: - description: 'swagger: ignore' - type: boolean - x-go-name: DeployTelegraf - keypair: - description: 'swagger: ignore' - type: string - x-go-name: Keypair - keypair_id: - description: 秘钥Id - type: string - x-go-name: KeypairId - password: - description: 重置指定密码 - type: string - x-go-name: Password - reset_password: - description: 生成随机密码, 优先级低于password - type: boolean - x-go-name: ResetPassword - restart: - description: 'swagger: ignore' - type: boolean - x-go-name: Restart - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerDetachDiskInput: - properties: - disk_id: - description: 磁盘Id，若磁盘未挂载在虚拟机上，不返回错误 - type: string - x-go-name: DiskId - keep_disk: - default: false - description: 是否保留磁盘 - type: boolean - x-go-name: KeepDisk - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerDetachnetworkInput: - properties: - ip_addr: - description: 通过IP解绑网卡, 优先级高于mac - type: string - x-go-name: IpAddr - mac: - description: 通过Mac解绑网卡, 优先级低于ip_addr - type: string - x-go-name: Mac - net_id: - description: 通过IP子网地址, 优先级最高 - type: string - x-go-name: NetId - reserve: - description: 是否保留IP地址(ip地址会进入到预留ip) - type: boolean - x-go-name: Reserve - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - admin_secgrp_id: - description: 管理员可见安全组Id - type: string - x-go-name: AdminSecgrpId - admin_security_rules: - description: 系统管理员可见的安全组规则 - type: string - x-go-name: AdminSecurityRules - attach_time: - description: list - format: date-time - type: string - x-go-name: AttachTime - auto_delete_at: - description: 自动释放时间 - format: date-time - type: string - x-go-name: AutoDeleteAt - auto_renew: - description: 是否自动续费 - type: boolean - x-go-name: AutoRenew - backup_guest_status: - type: string - x-go-name: BackupGuestStatus - backup_guest_sync_status: - description: 主备机同步状态 - type: string - x-go-name: BackupGuestSyncStatus - backup_host_id: - description: 备份机所在宿主机Id - type: string - x-go-name: BackupHostId - backup_host_name: - description: 备份主机所在宿主机名称 - type: string - x-go-name: BackupHostName - backup_host_status: - description: 备份主机所在宿主机状态 - type: string - x-go-name: BackupHostStatus - billing_cycle: - description: 计费周期 - type: string - x-go-name: BillingCycle - billing_type: - description: 计费类型, 按量、包年包月 - example: postpaid - type: string - x-go-name: BillingType - bios: - type: string - x-go-name: Bios - boot_order: - description: 启动顺序 - type: string - x-go-name: BootOrder - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_recycle: - description: 是否可以回收 - type: boolean - x-go-name: CanRecycle - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cdrom: - description: Cdrom信息 - items: - $ref: '#/definitions/Cdrom' - type: array - x-go-name: Cdrom - cdrom_support: - description: 是否支持ISO启动 - type: boolean - x-go-name: CdromSupport - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - 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 - disable_delete: - description: 是否开启删除保护 - example: true - type: boolean - x-go-name: DisableDelete - disk: - description: 磁盘大小 - example: 30720 - format: int64 - type: integer - x-go-name: DiskSizeMb - disk_count: - description: 磁盘数量 - format: int64 - type: integer - x-go-name: DiskCount - disks: - description: 磁盘概要 - type: string - x-go-name: Disks - disks_info: - description: 磁盘详情 - items: - $ref: '#/definitions/GuestDiskInfo' - type: array - x-go-name: DisksInfo - domain_id: - description: 域Id - type: string - x-go-name: DomainId - eip: - description: 浮动IP - type: string - x-go-name: Eip - eip_mode: - description: 浮动IP类型 - type: string - x-go-name: EipMode - encrypt_alg: - description: 加密算法，aes-256 or sm4 - type: string - x-go-name: EncryptAlg - encrypt_key: - description: 秘钥名称 - type: string - x-go-name: EncryptKey - encrypt_key_id: - description: 加密密钥ID - type: string - x-go-name: EncryptKeyId - encrypt_key_user: - description: 密钥用户 - type: string - x-go-name: EncryptKeyUser - encrypt_key_user_domain: - description: 密钥用户域 - type: string - x-go-name: EncryptKeyUserDomain - encrypt_key_user_domain_id: - description: 密钥用户域ID - type: string - x-go-name: EncryptKeyUserDomainId - encrypt_key_user_id: - description: 密钥用户ID - type: string - x-go-name: EncryptKeyUserId - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - description: 过期时间 - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - flavor_id: - type: string - x-go-name: FlavorId - floppy: - description: Floppy信息 - items: - $ref: '#/definitions/Floppy' - type: array - x-go-name: Floppy - floppy_support: - description: 是否支持Floppy启动 - type: boolean - x-go-name: FloppySupport - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - host: - description: 宿主机名称 - type: string - x-go-name: Host - host_enabled: - description: 宿主是否启用 - type: boolean - x-go-name: HostEnabled - host_id: - type: string - x-go-name: HostId - host_service_status: - description: 宿主机服务状态` - type: string - x-go-name: HostServiceStatus - host_sn: - description: 宿主机序列号 - type: string - x-go-name: HostSN - host_status: - description: 宿主机状态 - type: string - x-go-name: HostStatus - host_type: - description: 宿主机类型 - type: string - x-go-name: HostType - hostname: - type: string - x-go-name: Hostname - hypervisor: - description: 虚拟化技术 - example: kvm - type: string - x-go-name: Hypervisor - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - instance_type: - description: 套餐名称 - type: string - x-go-name: InstanceType - internet_max_bandwidth_out: - description: 最大内网带宽 - format: int64 - type: integer - x-go-name: InternetMaxBandwidthOut - ips: - description: IP地址列表字符串 - example: 10.165.2.1,172.16.8.1 - type: string - x-go-name: IPs - is_daemon: - type: boolean - x-go-name: IsDaemon - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_gpu: - description: 是否支持GPU - type: boolean - x-go-name: IsGpu - is_prepaid_recycle: - description: common - type: boolean - x-go-name: IsPrepaidRecycle - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - isolated_devices: - description: 直通设备（GPU）列表 - items: - $ref: '#/definitions/SIsolatedDevice' - type: array - x-go-name: IsolatedDevices - keypair: - description: 密钥对 - type: string - x-go-name: Keypair - keypair_id: - description: 秘钥对Id - type: string - x-go-name: KeypairId - machine: - type: string - x-go-name: Machine - macs: - description: mac地址信息 - type: string - x-go-name: Macs - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - monitor_url: - description: 监控上报URL - type: string - x-go-name: MonitorUrl - name: - description: 资源名称 - type: string - x-go-name: Name - networks: - description: |- - details - 网络概要 - type: string - x-go-name: Networks - nics: - description: 网卡信息 - items: - $ref: '#/definitions/GuestnetworkShortDesc' - type: array - x-go-name: Nics - os_arch: - description: 操作系统 CPU 架构 - example: x86 arm - type: string - x-go-name: OsArch - os_name: - description: 操作系统名称 - type: string - x-go-name: OsName - os_type: - description: 操作系统类型 - type: string - x-go-name: OsType - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - power_states: - description: power_states limit in [on, off, unknown] - type: string - x-go-name: PowerStates - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - progress_mbps: - description: 迁移或克隆的速度 - format: double - type: number - x-go-name: ProgressMbps - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - qga_status: - type: string - x-go-name: QgaStatus - record_checksum: - type: string - x-go-name: RecordChecksum - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - scaling_group_id: - description: 伸缩组id - type: string - x-go-name: ScalingGroupId - scaling_status: - description: 主机在伸缩组中的状态 - type: string - x-go-name: ScalingStatus - secgroup: - description: 关联主安全组 - type: string - x-go-name: Secgroup - secgroups: - description: 关联安全组列表 - items: - $ref: '#/definitions/StandaloneShortDesc' - type: array - x-go-name: Secgroups - secgrp_id: - description: 安全组Id - example: default - type: string - x-go-name: SecgrpId - security_rules: - description: 安全组规则 - type: string - x-go-name: SecurityRules - shutdown_behavior: - description: 关机操作类型 - example: stop - type: string - x-go-name: ShutdownBehavior - shutdown_mode: - description: 关机收费模式 - example: keep_charging, stop_charging - type: string - x-go-name: ShutdownMode - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - src_ip_check: - type: boolean - x-go-name: SrcIpCheck - src_mac_check: - type: boolean - x-go-name: SrcMacCheck - sshable_last_state: - type: boolean - x-go-name: SshableLastState - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - throughput: - description: 磁盘吞吐量 - format: int64 - type: integer - x-go-name: Throughput - 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 - vcpu_count: - description: CPU大小 - format: int64 - type: integer - x-go-name: VcpuCount - vdi: - type: string - x-go-name: Vdi - vga: - type: string - x-go-name: Vga - vip: - description: VIP - type: string - x-go-name: Vip - vip_eip: - description: VIP's eip - type: string - x-go-name: VipEip - virtual_ips: - description: 虚拟机Ip列表 - type: string - x-go-name: VirtualIps - vmem_size: - description: 内存大小, 单位Mb - format: int64 - type: integer - x-go-name: VmemSize - vpc: - description: 归属VPC - type: string - x-go-name: Vpc - vpc_external_access_mode: - description: Vpc外网访问模式 - type: string - x-go-name: VpcExternalAccessMode - vpc_id: - description: 归属VPC ID - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - description: 归属可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerDissociateEipInput: - properties: - auto_delete: - description: 是否自动释放 - type: boolean - x-go-name: AudoDelete - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerEjectVfdInput: - properties: - floppy_ordinal: - format: int64 - type: integer - x-go-name: FloppyOrdinal - image_id: - type: string - x-go-name: ImageId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerGetCPUSetCoresResp: - properties: - host_cores: - items: - format: int64 - type: integer - type: array - x-go-name: HostCores - host_used_cores: - items: - format: int64 - type: integer - type: array - x-go-name: HostUsedCores - pinned_cores: - items: - format: int64 - type: integer - type: array - x-go-name: PinnedCores - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerInsertVfdInput: - properties: - floppy_ordinal: - format: int64 - type: integer - x-go-name: FloppyOrdinal - image_id: - type: string - x-go-name: ImageId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerInstanceSnapshot: - properties: - generate_name: - type: string - x-go-name: GenerateName - name: - type: string - x-go-name: Name - with_memory: - type: boolean - x-go-name: WithMemory - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerMigrateForecastInput: - properties: - convert_to_kvm: - type: boolean - x-go-name: ConvertToKvm - is_rescue_mode: - type: boolean - x-go-name: IsRescueMode - live_migrate: - type: boolean - x-go-name: LiveMigrate - prefer_host: - description: Deprecated - type: string - x-go-name: PreferHost - prefer_host_id: - type: string - x-go-name: PreferHostId - skip_cpu_check: - type: boolean - x-go-name: SkipCpuCheck - skip_kernel_check: - type: boolean - x-go-name: SkipKernelCheck - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerMigrateNetworkInput: - properties: - dest: - description: Destination network Id - type: string - x-go-name: Dest - src: - description: Source network Id - type: string - x-go-name: Src - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerMonitorInput: - properties: - COMMAND: - type: string - QMP: - type: boolean - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerQemuInfo: - properties: - cmdline: - type: string - x-go-name: Cmdline - version: - type: string - x-go-name: Version - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerQgaCommandInput: - properties: - Command: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerQgaSetPasswordInput: - properties: - Password: - type: string - Username: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerRebuildRootInput: - properties: - all_disks: - type: boolean - x-go-name: AllDisks - auto_start: - type: boolean - x-go-name: AutoStart - image: - description: 'swagger: ignore' - type: string - x-go-name: Image - image_id: - description: |- - 关机且停机不收费情况下不允许重装系统 - 镜像 id - type: string - x-go-name: ImageId - keypair: - description: 'swagger: ignore' - type: string - x-go-name: Keypair - keypair_id: - description: 秘钥Id - type: string - x-go-name: KeypairId - password: - type: string - x-go-name: Password - reset_password: - type: boolean - x-go-name: ResetPassword - user_data: - type: string - x-go-name: UserData - required: - - image_id - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerRemoteUpdateInput: - properties: - replace_tags: - description: 是否覆盖替换所有标签 - type: boolean - x-go-name: ReplaceTags - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerResetInput: - properties: - auto_start: - description: 自动启动 - type: boolean - x-go-name: AutoStart - instance_snapshot: - type: string - x-go-name: InstanceSnapshot - with_memory: - description: 恢复内存 - type: boolean - x-go-name: WithMemory - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerResizeDiskInput: - properties: - disk: - description: 'swagger: ignore' - type: string - x-go-name: Disk - disk_id: - description: 磁盘Id - type: string - x-go-name: DiskId - size: - description: 'default unit: Mb' - example: 1024; 40G; 1024M - type: string - x-go-name: Size - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerResumeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSaveGuestImageInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - auto_start: - description: 保存镜像后是否自动启动 - type: boolean - x-go-name: AutoStart - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disk_format: - description: 镜像格式 - type: string - x-go-name: DiskFormat - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - encrypt_key_alg: - description: 新建密钥算法 - type: string - x-go-name: EncryptKeyAlg - encrypt_key_id: - description: 加密密钥的ID - type: string - x-go-name: EncryptKeyId - encrypt_key_new: - description: 是否新建密钥 - type: boolean - x-go-name: EncryptKeyNew - encrypt_key_user_id: - description: 加密密钥的用户ID - type: string - x-go-name: EncryptKeyUserId - 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: 'description: indicate the resource is a system resource, which - is not visible to user' - 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 - notes: - description: 备注 - type: string - x-go-name: Notes - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - protected: - description: 是否有删除保护 - type: boolean - x-go-name: Protected - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSaveImageInput: - properties: - AutoStart: - default: false - description: |- - 保存镜像后是否自动启动,若实例状态为运行中,则会先关闭实例 - 公有云若支持开机保存镜像，此参数则不生效 - type: boolean - Format: - description: 镜像格式 - type: string - GenerateName: - type: string - ImageId: - description: 'swagger: ignore' - type: string - IsPublic: - type: boolean - Name: - description: 镜像名称 - type: string - Notes: - type: string - OsArch: - description: 'swagger: ignore' - type: string - OsType: - description: 'swagger: ignore' - type: string - Restart: - description: 'swagger: ignore' - type: boolean - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSetBootIndexInput: - properties: - cdroms: - additionalProperties: - format: int8 - type: integer - description: key ordinal, value boot_index - type: object - x-go-name: Cdroms - disks: - additionalProperties: - format: int8 - type: integer - description: key index, value boot_index - type: object - x-go-name: Disks - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSetExtraOptionInput: - properties: - key: - type: string - x-go-name: Key - value: - type: string - x-go-name: Value - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSetLiveMigrateParamsInput: - properties: - DowntimeLimitMS: - format: int64 - type: integer - MaxBandwidthMB: - format: int64 - type: integer - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSetPasswordInput: - properties: - AutoStart: - type: boolean - Password: - type: string - ResetPassword: - description: deploy params - type: boolean - Username: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSkuCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - cloudregion_id: - default: default - description: 区域名称或Id,建议使用Id - type: string - x-go-name: CloudregionId - cpu_core_count: - description: Cpu核数 - format: int64 - maximum: 256 - minimum: 1 - type: integer - x-go-name: CpuCoreCount - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - instance_type_category: - default: general_purpose - description: |- - 套餐类型 - - - - instance_type_category | 说明 | - ----- | --- | - general_purpose |通用型 | - burstable |突发性能型 | - compute_optimized |计算优化型 | - memory_optimized |内存优化型 | - storage_optimized |存储IO优化型 | - hardware_accelerated |硬件加速型 | - high_storage |高存储型 | - high_memory |高内存型 | - type: string - x-go-name: InstanceTypeCategory - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - memory_size_mb: - description: 内存大小 - format: int64 - maximum: 524288 - minimum: 512 - type: integer - x-go-name: MemorySizeMB - 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 - postpaid_status: - default: available - description: 后付费状态 - type: string - x-go-name: PostpaidStatus - prepaid_status: - default: available - description: 预付费状态 - type: string - x-go-name: PrepaidStatus - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - zone_id: - description: 可用区名称或Id, 建议使用Id - type: string - x-go-name: ZoneId - required: - - name - - cpu_core_count - - memory_size_mb - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSkuDetails: - properties: - attached_disk_count: - format: int64 - type: integer - x-go-name: AttachedDiskCount - attached_disk_size_gb: - format: int64 - type: integer - x-go-name: AttachedDiskSizeGB - attached_disk_type: - type: string - x-go-name: AttachedDiskType - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - cpu_arch: - type: string - x-go-name: CpuArch - cpu_core_count: - description: CPU 架构 x86|xarm - format: int64 - type: integer - x-go-name: CpuCoreCount - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - data_disk_max_count: - format: int64 - type: integer - x-go-name: DataDiskMaxCount - data_disk_types: - type: string - x-go-name: DataDiskTypes - 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: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - gpu_attachable: - type: boolean - x-go-name: GpuAttachable - gpu_count: - format: int64 - type: integer - x-go-name: GpuCount - gpu_max_count: - format: int64 - type: integer - x-go-name: GpuMaxCount - gpu_spec: - type: string - x-go-name: GpuSpec - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - instance_type_category: - description: x2 - type: string - x-go-name: InstanceTypeCategory - instance_type_family: - description: SkuId string `width:"64" charset:"ascii" nullable:"false" - list:"user" create:"admin_required"` // x2.large - type: string - x-go-name: InstanceTypeFamily - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - local_category: - description: 通用型 - type: string - x-go-name: LocalCategory - memory_size_mb: - format: int64 - type: integer - x-go-name: MemorySizeMB - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - nic_max_count: - format: int64 - type: integer - x-go-name: NicMaxCount - nic_type: - type: string - x-go-name: NicType - os_name: - type: string - x-go-name: OsName - postpaid_status: - description: 预付费资源状态 available|soldout - type: string - x-go-name: PostpaidStatus - prepaid_status: - type: string - x-go-name: PrepaidStatus - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - sys_disk_max_size_gb: - description: not required。 windows比较新的版本都是50G左右。 - format: int64 - type: integer - x-go-name: SysDiskMaxSizeGB - sys_disk_min_size_gb: - format: int64 - type: integer - x-go-name: SysDiskMinSizeGB - sys_disk_resizable: - type: boolean - x-go-name: SysDiskResizable - sys_disk_type: - type: string - x-go-name: SysDiskType - total_guest_count: - description: 绑定云主机数量 - format: int64 - type: integer - x-go-name: TotalGuestCount - 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 - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSkuUpdateInput: - properties: - attached_disk_count: - format: int64 - type: integer - x-go-name: AttachedDiskCount - attached_disk_size_gb: - format: int64 - type: integer - x-go-name: AttachedDiskSizeGB - attached_disk_type: - type: string - x-go-name: AttachedDiskType - data_disk_max_count: - format: int64 - type: integer - x-go-name: DataDiskMaxCount - data_disk_types: - type: string - x-go-name: DataDiskTypes - description: - description: 资源描述 - type: string - x-go-name: Description - gpu_attachable: - type: boolean - x-go-name: GpuAttachable - gpu_count: - format: int64 - type: integer - x-go-name: GpuCount - gpu_max_count: - format: int64 - type: integer - x-go-name: GpuMaxCount - gpu_spec: - type: string - x-go-name: GpuSpec - instance_type_category: - type: string - x-go-name: InstanceTypeCategory - instance_type_family: - type: string - x-go-name: InstanceTypeFamily - local_category: - type: string - x-go-name: LocalCategory - name: - description: 资源名称 - type: string - x-go-name: Name - nic_max_count: - format: int64 - type: integer - x-go-name: NicMaxCount - nic_type: - type: string - x-go-name: NicType - os_name: - type: string - x-go-name: OsName - postpaid_status: - default: available - description: 后付费状态 - type: string - x-go-name: PostpaidStatus - prepaid_status: - default: available - description: 预付费状态 - type: string - x-go-name: PrepaidStatus - progress: - format: float - type: number - x-go-name: Progress - sys_disk_max_size_gb: - format: int64 - type: integer - x-go-name: SysDiskMaxSizeGB - sys_disk_min_size_gb: - format: int64 - type: integer - x-go-name: SysDiskMinSizeGB - sys_disk_resizable: - type: boolean - x-go-name: SysDiskResizable - sys_disk_type: - type: string - x-go-name: SysDiskType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerSnapshotAndCloneInput: - properties: - auto_delete_instance_snapshot: - description: |- - Whether delete instance snapshot automatically - 是否自动删除主机快照 - type: boolean - x-go-name: AutoDeleteInstanceSnapshot - auto_start: - description: |- - Whether auto start the cloned server - 是否自动启动 - type: boolean - x-go-name: AutoStart - count: - description: |- - number of cloned servers - 数量 - format: int64 - type: integer - x-go-name: Count - generate_name: - type: string - x-go-name: GenerateName - instance_snapshot_id: - description: ignore - type: string - x-go-name: InstanceSnapshotId - name: - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerStopInput: - properties: - is_force: - description: 是否强制关机 - type: boolean - x-go-name: IsForce - stop_charging: - description: |- - 是否关机停止计费, 若平台不支持停止计费，此参数无作用 - 目前仅阿里云，腾讯云此参数生效 - type: boolean - x-go-name: StopCharging - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerUpdateInput: - properties: - bios: - type: string - x-go-name: Bios - boot_order: - description: 启动顺序 - type: string - x-go-name: BootOrder - description: - description: 资源描述 - type: string - x-go-name: Description - disable_delete: - description: 删除保护开关 - type: boolean - x-go-name: DisableDelete - hostname: - description: |- - 主机名 - 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 - 字符长度2-60个字符 - Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 - 若输入为空，则会根据资源名称自动生成主机名 - 输入不为空则会自动剔除不符合规则的字符, 并进行校验 - 若长度大于允许的最大长度，会自动截取 - type: string - x-go-name: Hostname - machine: - type: string - x-go-name: Machine - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - progress_mbps: - description: 'swagger: ignore' - format: float - type: number - x-go-name: ProgressMbps - shutdown_behavior: - description: 关机执行操作 - type: string - x-go-name: ShutdownBehavior - src_ip_check: - type: boolean - x-go-name: SrcIpCheck - src_mac_check: - type: boolean - x-go-name: SrcMacCheck - ssh_port: - format: int64 - type: integer - x-go-name: SshPort - vdi: - type: string - x-go-name: Vdi - vga: - type: string - x-go-name: Vga - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerUserDataInput: - properties: - user_data: - type: string - x-go-name: UserData - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServerVncOutput: - description: +onecloud:model-api-gen - properties: - api_server: - description: cloudpods - type: string - x-go-name: ApiServer - connect_params: - type: string - x-go-name: ConnectParams - host: - description: kvm host ip - type: string - x-go-name: Host - host_id: - description: baremetal - type: string - x-go-name: HostId - hypervisor: - type: string - x-go-name: Hypervisor - id: - type: string - x-go-name: Id - instance_id: - type: string - x-go-name: InstanceId - instance_name: - type: string - x-go-name: InstanceName - os_name: - type: string - x-go-name: OsName - password: - type: string - x-go-name: Password - port: - format: int64 - type: integer - x-go-name: Port - protocol: - type: string - x-go-name: Protocol - session: - type: string - x-go-name: Session - url: - type: string - x-go-name: Url - vnc_password: - type: string - x-go-name: VncPassword - zone: - type: string - x-go-name: Zone - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - ServiceCatalogCreateInput: - 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 - guest_template: - description: 'description: the id or name of guest template' - example: good - type: string - x-go-name: GuestTemplate - icon_url: - description: 'description: service catalog icon url' - example: https://yunion.io/files/hello.png - type: string - x-go-name: IconUrl - 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: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - - guest_template - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServiceCatalogDeploy: - properties: - count: - description: 'description: the count of the new vm' - example: 1 - format: int64 - type: integer - x-go-name: Count - generate_name: - description: 'description: generate name automatically if name is repeated, - and only one of name and this shoudle be given' - example: hello - type: string - x-go-name: GenerateName - name: - description: 'description: name of the new vm' - example: hello - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ServiceCatalogDetails: - 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 - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - guest_template_id: - type: string - x-go-name: GuestTemplateID - icon_url: - type: string - x-go-name: IconUrl - 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 - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - ServiceCatalogUpdateInput: - properties: - guest_template: - description: 'description: the id or name of guest template' - example: good - type: string - x-go-name: GuestTemplate - icon_url: - description: 'description: service catalog icon url' - example: https://yunion.io/files/hello.png - type: string - x-go-name: IconUrl - name: - description: 'description: resource name' - example: test-network - type: string - uniqueItems: true - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SetDomainQuotaInput: - description: 设置域配额输入参数 - properties: - action: - description: |- - 设置配额操作 - - action | 说明 | - ---------|-------------------------------------------| - add | 增量增加配额 | - sub | 增量减少配额 | - reset | 重置所有配额为0 | - replace | 替换所有配额，对于不存在的配额项，设置为0 | - update | 更新存在的配额 | - delete | 删除配额 | - type: string - x-go-name: Action - cloudaccount: - format: int64 - type: integer - x-go-name: Cloudaccount - 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 - dns_zone: - format: int64 - type: integer - x-go-name: DnsZone - domain_id: - description: 配额适用的域ID - type: string - x-go-name: DomainId - globalvpc: - format: int64 - type: integer - x-go-name: Globalvpc - 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/compute/models - SetInfrasQuotaInput: - description: 设置基础设施配额输入参数 - properties: - account_id: - description: 配额适用的云账号ID - type: string - x-go-name: AccountId - action: - description: |- - 设置配额操作 - - action | 说明 | - ---------|-------------------------------------------| - add | 增量增加配额 | - sub | 增量减少配额 | - reset | 重置所有配额为0 | - replace | 替换所有配额，对于不存在的配额项，设置为0 | - update | 更新存在的配额 | - delete | 删除配额 | - type: string - x-go-name: Action - brand: - description: 配额适用的品牌名称，参考List接口的品牌列表 - type: string - x-go-name: Brand - cloud_env: - description: 配额适用的云环境，参考List接口的云环境列表 - type: string - x-go-name: CloudEnv - 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 - host: - format: int64 - type: integer - x-go-name: Host - manager_id: - description: 配额适用的云订阅ID - type: string - x-go-name: ManagerId - provider: - description: 配额适用的平台名称，参考List接口的平台列表 - type: string - x-go-name: Provider - region_id: - description: 配额适用的区域ID - type: string - x-go-name: RegionId - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vpc: - format: int64 - type: integer - x-go-name: Vpc - type: object - x-go-package: yunion.io/x/onecloud/pkg/compute/models - SetProjectQuotaInput: - 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 - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - secgroup: - format: int64 - type: integer - x-go-name: Secgroup - 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/compute/models - SetQuotaInput: - description: 设置主机配额输入参数 - properties: - Hypervisor: - description: 主机配额适用的主机类型，参考主机List的Hypervisor列表 - type: string - account_id: - description: 配额适用的云账号ID - type: string - x-go-name: AccountId - action: - description: |- - 设置配额操作 - - action | 说明 | - ---------|-------------------------------------------| - add | 增量增加配额 | - sub | 增量减少配额 | - reset | 重置所有配额为0 | - replace | 替换所有配额，对于不存在的配额项，设置为0 | - update | 更新存在的配额 | - delete | 删除配额 | - type: string - x-go-name: Action - brand: - description: 配额适用的品牌名称，参考List接口的品牌列表 - type: string - x-go-name: Brand - cloud_env: - description: 配额适用的云环境，参考List接口的云环境列表 - type: string - x-go-name: CloudEnv - count: - description: 主机数量配额 - format: int64 - type: integer - x-go-name: Count - cpu: - description: 主机CPU核数量配额 - format: int64 - type: integer - x-go-name: Cpu - 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: - description: 主机组配额 - format: int64 - type: integer - x-go-name: Group - isolated_device: - description: 直通设备(GPU)配额 - format: int64 - type: integer - x-go-name: IsolatedDevice - manager_id: - description: 配额适用的云订阅ID - type: string - x-go-name: ManagerId - memory: - description: 主机内存容量配额 - format: int64 - type: integer - x-go-name: Memory - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - provider: - description: 配额适用的平台名称，参考List接口的平台列表 - type: string - x-go-name: Provider - region_id: - description: 配额适用的区域ID - type: string - x-go-name: RegionId - storage: - description: 主机存储容量配额 - format: int64 - type: integer - x-go-name: Storage - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - zone_id: - description: 配额适用的可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/compute/models - SetRegionQuotaInput: - description: 设置区域配额输入参数 - properties: - account_id: - description: 配额适用的云账号ID - type: string - x-go-name: AccountId - action: - description: |- - 设置配额操作 - - action | 说明 | - ---------|-------------------------------------------| - add | 增量增加配额 | - sub | 增量减少配额 | - reset | 重置所有配额为0 | - replace | 替换所有配额，对于不存在的配额项，设置为0 | - update | 更新存在的配额 | - delete | 删除配额 | - type: string - x-go-name: Action - brand: - description: 配额适用的品牌名称，参考List接口的品牌列表 - type: string - x-go-name: Brand - bucket: - format: int64 - type: integer - x-go-name: Bucket - cache: - format: int64 - type: integer - x-go-name: Cache - cloud_env: - description: 配额适用的云环境，参考List接口的云环境列表 - type: string - x-go-name: CloudEnv - 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 - eip: - format: int64 - type: integer - x-go-name: Eip - eport: - format: int64 - type: integer - x-go-name: Eport - instance_snapshot: - format: int64 - type: integer - x-go-name: InstanceSnapshot - loadbalancer: - format: int64 - type: integer - x-go-name: Loadbalancer - manager_id: - description: 配额适用的云订阅ID - type: string - x-go-name: ManagerId - mongodb: - format: int64 - type: integer - x-go-name: Mongodb - object_cnt: - format: int64 - type: integer - x-go-name: ObjectCnt - object_gb: - format: int64 - type: integer - x-go-name: ObjectGB - port: - format: int64 - type: integer - x-go-name: Port - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - provider: - description: 配额适用的平台名称，参考List接口的平台列表 - type: string - x-go-name: Provider - rds: - format: int64 - type: integer - x-go-name: Rds - region_id: - description: 配额适用的区域ID - type: string - x-go-name: RegionId - snapshot: - format: int64 - type: integer - x-go-name: Snapshot - 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/compute/models - SetZoneQuotaInput: - description: 设置可用区配额输入参数 - properties: - account_id: - description: 配额适用的云账号ID - type: string - x-go-name: AccountId - action: - description: |- - 设置配额操作 - - action | 说明 | - ---------|-------------------------------------------| - add | 增量增加配额 | - sub | 增量减少配额 | - reset | 重置所有配额为0 | - replace | 替换所有配额，对于不存在的配额项，设置为0 | - update | 更新存在的配额 | - delete | 删除配额 | - type: string - x-go-name: Action - brand: - description: 配额适用的品牌名称，参考List接口的品牌列表 - type: string - x-go-name: Brand - cloud_env: - description: 配额适用的云环境，参考List接口的云环境列表 - type: string - x-go-name: CloudEnv - 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 - manager_id: - description: 配额适用的云订阅ID - type: string - x-go-name: ManagerId - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - provider: - description: 配额适用的平台名称，参考List接口的平台列表 - type: string - x-go-name: Provider - region_id: - description: 配额适用的区域ID - type: string - x-go-name: RegionId - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - zone_id: - description: 配额适用的可用区ID - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/compute/models - SharableVirtualResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - SharableVirtualResourceCreateInput: - 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 - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - 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 - SimpleGuest: - properties: - cache_mode: - description: 缓存模式 - type: string - x-go-name: CacheMode - driver: - description: 磁盘驱动 - type: string - x-go-name: Driver - id: - description: 主机ID - type: string - x-go-name: Id - index: - description: 磁盘序号 - format: int64 - type: integer - x-go-name: Index - name: - description: 主机名称 - type: string - x-go-name: Name - status: - description: 主机状态 - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SimpleHost: - properties: - Id: - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SimpleNetwork: - properties: - guest_ip_end: - type: string - x-go-name: GuestIpEnd - guest_ip_start: - type: string - x-go-name: GuestIpStart - guest_ip6_end: - type: string - x-go-name: GuestIp6End - guest_ip6_start: - type: string - x-go-name: GuestIp6Start - 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/compute - SimpleSnapshot: - properties: - cloudregion_id: - description: 区域Id - type: string - x-go-name: CloudregionId - created_at: - description: 创建时间 - format: date-time - type: string - x-go-name: CreatedAt - disk_type: - description: 磁盘类型 - type: string - x-go-name: DiskType - encrypt_key_id: - description: 密钥 - type: string - x-go-name: EncryptKeyId - id: - description: 快照Id - type: string - x-go-name: Id - name: - description: 快照名称 - type: string - x-go-name: Name - size: - description: 快照大小 - format: int64 - type: integer - x-go-name: Size - status: - description: 快照状态 - type: string - x-go-name: Status - storage_id: - description: 存储Id - type: string - x-go-name: StorageId - storage_type: - description: 存储类型 - type: string - x-go-name: StorageType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SimpleSnapshotPolicy: - properties: - id: - type: string - x-go-name: Id - name: - type: string - x-go-name: Name - repeat_weekdays: - items: - format: int64 - type: integer - type: array - x-go-name: RepeatWeekdays - time_points: - items: - format: int64 - type: integer - type: array - x-go-name: TimePoints - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SkuSyncInput: - properties: - cloudregion_ids: - description: 区域ID - items: - type: string - type: array - x-go-name: CloudregionIds - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SnapshotCreateInput: - 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 - disk_id: - description: |- - 磁盘Id - 目前仅VMware平台不支持创建快照,其余平台磁盘均支持创建快照 - type: string - x-go-name: DiskId - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - encrypt_key_alg: - description: 新建密钥算法 - type: string - x-go-name: EncryptKeyAlg - encrypt_key_id: - description: 加密密钥的ID - type: string - x-go-name: EncryptKeyId - encrypt_key_new: - description: 是否新建密钥 - type: boolean - x-go-name: EncryptKeyNew - encrypt_key_user_id: - description: 加密密钥的用户ID - type: string - x-go-name: EncryptKeyUserId - 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - - disk_id - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SnapshotDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - backing_disk_id: - type: string - x-go-name: BackingDiskId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - created_by: - type: string - x-go-name: CreatedBy - 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 - disk_id: - description: 磁盘Id - type: string - x-go-name: DiskId - disk_name: - description: 磁盘名称 - type: string - x-go-name: DiskName - disk_status: - description: 磁盘状态 - type: string - x-go-name: DiskStatus - disk_type: - type: string - x-go-name: DiskType - domain_id: - description: 域Id - type: string - x-go-name: DomainId - encrypt_alg: - description: 加密算法，aes-256 or sm4 - type: string - x-go-name: EncryptAlg - encrypt_key: - description: 秘钥名称 - type: string - x-go-name: EncryptKey - encrypt_key_id: - description: 加密密钥ID - type: string - x-go-name: EncryptKeyId - encrypt_key_user: - description: 密钥用户 - type: string - x-go-name: EncryptKeyUser - encrypt_key_user_domain: - description: 密钥用户域 - type: string - x-go-name: EncryptKeyUserDomain - encrypt_key_user_domain_id: - description: 密钥用户域ID - type: string - x-go-name: EncryptKeyUserDomainId - encrypt_key_user_id: - description: 密钥用户ID - type: string - x-go-name: EncryptKeyUserId - environment: - description: Environment - type: string - x-go-name: Environment - expired_at: - format: date-time - type: string - x-go-name: ExpiredAt - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - fake_deleted: - type: boolean - x-go-name: FakeDeleted - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - guest: - description: 云主机名称 - type: string - x-go-name: Guest - guest_id: - description: 云主机Id - type: string - x-go-name: GuestId - guest_status: - description: 云主机状态 - type: string - x-go-name: GuestStatus - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_sub_snapshot: - description: 是否是子快照 - type: boolean - x-go-name: IsSubSnapshot - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - location: - type: string - x-go-name: Location - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - os_arch: - description: 操作系统 CPU 架构 - example: x86 arm - type: string - x-go-name: OsArch - os_type: - description: 操作系统类型 - type: string - x-go-name: OsType - out_of_chain: - type: boolean - x-go-name: OutOfChain - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - ref_count: - description: create disk from snapshot, snapshot as disk backing file - format: int64 - type: integer - x-go-name: RefCount - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - size: - description: 快照大小,单位Mb - format: int64 - type: integer - x-go-name: Size - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - storage_id: - description: Only onecloud has StorageId - type: string - x-go-name: StorageId - storage_type: - description: 存储类型 - type: string - x-go-name: StorageType - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/compute - SnapshotPolicyCacheDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - snapshotpolicy: - description: 快照策略名称 - type: string - x-go-name: Snapshotpolicy - snapshotpolicy_id: - description: 本地快照策略ID - type: string - x-go-name: SnapshotpolicyId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SnapshotPolicyDetails: - properties: - binding_disk_count: - format: int64 - type: integer - x-go-name: BindingDiskCount - 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 - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - is_activated: - type: boolean - x-go-name: IsActivated - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - 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 - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - repeat_weekdays: - description: 1~7, 1 is Monday - format: uint8 - type: integer - x-go-name: RepeatWeekdays - repeat_weekdays_display: - items: - format: int64 - type: integer - type: array - x-go-name: RepeatWeekdaysDisplay - retention_days: - format: int64 - type: integer - x-go-name: RetentionDays - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - time_points: - description: 0~23 - format: uint32 - type: integer - x-go-name: TimePoints - time_points_display: - items: - format: int64 - type: integer - type: array - x-go-name: TimePointsDisplay - 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/compute - SnapshotPolicyDiskDetails: - 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' - disk: - $ref: '#/definitions/DiskDetails' - snapshotpolicy: - description: 快照策略名称 - type: string - x-go-name: Snapshotpolicy - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SnapshotSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - StandaloneAnonResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StandaloneAnonResourceDetails: - 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 - 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 - StandaloneShortDesc: - 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 - StatusInfrasResourceBaseCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusInfrasResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStandaloneResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStandaloneResourceCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op - type: object - x-go-name: Metadata - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStandaloneResourceDetails: - 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 - StorageCreateInput: - 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 - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - medium_type: - default: ssd - description: 存储介质类型 - enum: - - rotate - - ' ssd' - - ' hybird' - type: string - x-go-name: MediumType - 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 - nfs_host: - description: 网络文件系统主机, storage_type 为 nfs 时,此参数必传 - example: 192.168.222.2 - type: string - x-go-name: NfsHost - nfs_shared_dir: - description: 网络文件系统共享目录, storage_type 为 nfs 时, 此参数必传 - example: /nfs_root/ - type: string - x-go-name: NfsSharedDir - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - rbd_client_mount_timeout: - default: 120 - description: ceph CephFS挂载超时时间, 单位秒 - format: int64 - type: integer - x-go-name: RbdClientMountTimeout - rbd_key: - description: |- - ceph集群密码,若ceph集群开启cephx认证,此参数必传 - 可在ceph集群主机的/etc/ceph/ceph.client.admin.keyring文件中找到 - example: AQDigB9dtnDAKhAAxS6X4zi4BPR/lIle4nf4Dw== - type: string - x-go-name: RbdKey - rbd_mon_host: - description: |- - ceph认证主机, storage_type为 rbd 时,此参数为必传项 - 单个ip或以逗号分隔的多个ip具体可查询 /etc/ceph/ceph.conf 文件 - example: 192.168.222.3,192.168.222.4,192.168.222.99 - type: string - x-go-name: RbdMonHost - rbd_pool: - description: ceph使用的pool, storage_type为 rbd 时,此参数为必传项 - example: rbd - type: string - x-go-name: RbdPool - rbd_rados_mon_op_timeout: - default: 3 - description: ceph集群连接超时时间, 单位秒 - format: int64 - type: integer - x-go-name: RbdRadosMonOpTimeout - rbd_rados_osd_op_timeout: - default: 1200 - description: ceph osd 操作超时时间, 单位秒 - format: int64 - type: integer - x-go-name: RbdRadosOsdOpTimeout - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - storage_type: - description: |- - 存储类型 - - - - storage_type | 参数 |是否必传 | 默认值 | 说明 | - -------- | ------- | -------- | -------- | --------- | - rbd | rbd_mon_host | 是 | | ceph mon_host | - rbd | rbd_pool | 是 | | ceph pool | - rbd | rbd_key | 否 | |若cephx认证开启,此参数必传 | - rbd | rbd_rados_mon_op_timeout | 否 | 3 |单位: 秒 | - rbd | rbd_rados_osd_op_timeout | 否 | 1200 |单位: 秒 | - rbd | rbd_client_mount_timeout | 否 | 120 |单位: 秒 | - nfs | nfs_host | 是 | |网络文件系统主机 | - nfs | nfs_shared_dir | 是 | |网络文件系统共享目录 | - local: 本地存储 - rbd: ceph块存储, ceph存储创建时仅会检测是否重复创建，不会具体检测认证参数是否合法，只有挂载存储时 - 计算节点会验证参数，若挂载失败，宿主机和存储不会关联，可以通过查看存储日志查找挂载失败原因 - enum: - - local - - ' rbd' - - ' nfs' - - ' gpfs' - type: string - x-go-name: StorageType - zone_id: - description: 可用区ID或名称 - example: zone1 - type: string - x-go-name: ZoneId - required: - - name - - storage_type - - medium_type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - StorageDetails: - properties: - DiskCount: - format: int64 - type: integer - HostCount: - format: int64 - type: integer - SnapshotCount: - format: int64 - type: integer - Used: - format: int64 - type: integer - Wasted: - format: int64 - type: integer - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - actual_capacity_used: - description: |- - 实际容量大小，单位Mb - we always expect actual capacity great or equal than zero, otherwise something wrong - format: int64 - type: integer - x-go-name: ActualCapacityUsed - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - capacity: - description: 容量大小,单位Mb - format: int64 - type: integer - x-go-name: Capacity - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 可用区的区域ID - type: string - x-go-name: CloudregionId - cmtbound: - description: 超售比 - format: float - type: number - x-go-name: Cmtbound - commit_bound: - description: 超分比 - format: float - type: number - x-go-name: CommitBound - commit_rate: - description: 超分率 - format: double - type: number - x-go-name: CommitRate - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - free_capacity: - description: 可使用容量 - format: int64 - type: integer - x-go-name: FreeCapacity - hosts: - items: - $ref: '#/definitions/StorageHost' - type: array - x-go-name: Hosts - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - is_sys_disk_store: - description: |- - indicating whether system disk can be allocated in this storage - 是否可以用作系统盘存储 - example: true - type: boolean - x-go-name: IsSysDiskStore - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - medium_type: - description: 介质类型 - example: ssd - type: string - x-go-name: MediumType - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - real_time_used_capacity: - format: int64 - type: integer - x-go-name: ActualUsed - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - reserved: - description: 预留容量大小 - format: int64 - type: integer - x-go-name: Reserved - schedtags: - items: - $ref: '#/definitions/SchedtagShortDescDetails' - type: array - x-go-name: Schedtags - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - storage_conf: - description: 存储配置信息 - type: object - x-go-name: StorageConf - storage_type: - description: 存储类型 - example: local - type: string - x-go-name: StorageType - storagecache_id: - description: 存储缓存Id - type: string - x-go-name: StoragecacheId - 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 - used_capacity: - description: 已使用容量大小 - format: int64 - type: integer - x-go-name: UsedCapacity - virtual_capacity: - description: 虚拟容量大小 - format: int64 - type: integer - x-go-name: VCapacity - waste_capacity: - description: 浪费容量大小(异常磁盘大小总和) - format: int64 - type: integer - x-go-name: WasteCapacity - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - StorageForceDetachHostInput: - properties: - host_id: - description: Host id or name - type: string - x-go-name: HostId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StorageHost: - properties: - Id: - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - StorageShortDesc: - properties: - capacity_mb: - format: int64 - type: integer - x-go-name: CapacityMb - enabled: - type: boolean - x-go-name: Enabled - id: - type: string - x-go-name: Id - name: - type: string - x-go-name: Name - status: - type: string - x-go-name: Status - storage_type: - type: string - x-go-name: StorageType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - StorageUpdateInput: - properties: - UpdateStorageConf: - type: boolean - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - rbd_client_mount_timeout: - default: 120 - description: ceph CephFS挂载超时时间, 单位秒 - format: int64 - type: integer - x-go-name: RbdClientMountTimeout - rbd_key: - description: |- - ceph集群密码,若ceph集群开启cephx认证,此参数必传 - 可在ceph集群主机的/etc/ceph/ceph.client.admin.keyring文件中找到 - example: AQDigB9dtnDAKhAAxS6X4zi4BPR/lIle4nf4Dw== - type: string - x-go-name: RbdKey - rbd_rados_mon_op_timeout: - default: 3 - description: ceph集群连接超时时间, 单位秒 - format: int64 - type: integer - x-go-name: RbdRadosMonOpTimeout - rbd_rados_osd_op_timeout: - default: 1200 - description: ceph osd 操作超时时间, 单位秒 - format: int64 - type: integer - x-go-name: RbdRadosOsdOpTimeout - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - StoragecacheDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - count: - description: 缓存镜像个数 - format: int64 - type: integer - x-go-name: Count - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - host: - description: 通过一致性哈希获取的一个管理宿主机信息 - type: object - x-go-name: Host - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - path: - description: 镜像存储地址 - type: string - x-go-name: Path - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - size: - description: 缓存镜像总大小 - format: int64 - type: integer - x-go-name: Size - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - storages: - description: 存储列表 - items: - type: string - type: array - x-go-name: Storages - 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/compute - StoragecachedimageDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - cachedimage: - description: 缓存镜像名称 - type: string - x-go-name: Cachedimage - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - host: - description: 通过一致性哈希获取的一个宿主机详情 - type: object - x-go-name: Host - image: - description: 镜像名称 - type: string - x-go-name: Image - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - reference: - description: 引用次数 - format: int64 - type: integer - x-go-name: Reference - size: - description: 镜像大小 - format: int64 - type: integer - x-go-name: Size - storagecache: - description: 存储缓存名称 - type: string - x-go-name: Storagecache - storages: - description: 存储列表 - items: - type: string - type: array - x-go-name: Storages - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SubAccounts: - description: +onecloud:model-api-gen - properties: - Accounts: - description: 若输出则是全量子账号列表，若输入，代表允许同步的子账号 - items: - $ref: '#/definitions/SSubAccount' - type: array - Cloudregions: - description: 若输出是云账号查询到的区域列表，若输入，代表允许同步的区域 - items: - properties: - Id: - description: 输入必填 - type: string - Name: - type: string + description: 主页 + type: string + Protocol: + description: http或https + type: string + Rules: + items: + $ref: '#/definitions/BucketWebsiteRoutingRule' + type: array + Url: + description: 访问网站url + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketWebsiteRoutingRule: + properties: + ConditionErrorCode: + type: string + ConditionPrefix: + type: string + RedirectProtocol: + type: string + RedirectReplaceKey: + type: string + RedirectReplaceKeyPrefix: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAGuestNet: + properties: + ip_nets: + items: + $ref: '#/definitions/CAIPNet' + type: array + x-go-name: IPNets + name: + description: 'description: Host 的 Name' + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAHostNet: + properties: + ip: + description: 'description: IP' + type: string + x-go-name: IP + name: + description: 'description: Host 的 Name' + type: string + x-go-name: Name + suitable_network: + description: 'description: 合适的已有网络' + type: string + x-go-name: SuitableNetwork + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAIPNet: + properties: + ip: + description: 'description: IP' + type: string + x-go-name: IP + suitable_network: + description: 'description: 合适的已有网络' + type: string + x-go-name: SuitableNetwork + vlan_id: + format: int32 + type: integer + x-go-name: VlanID + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CANetConf: + properties: + description: + type: string + x-go-name: Description + guest_gateway: + type: string + x-go-name: GuestGateway + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + format: int8 + type: integer + x-go-name: GuestIpMask + guest_ip_start: + type: string + x-go-name: GuestIpStart + name: + type: string + x-go-name: Name + vlan_id: + format: int32 + type: integer + x-go-name: VlanID + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAPWire: + properties: + distributed: + type: boolean + x-go-name: Distributed + guest_networks: + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: GuestNetworks + host_networks: + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: HostNetworks + hosts: + items: + $ref: '#/definitions/SimpleHost' + type: array + x-go-name: Hosts + 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/compute + CAWireConf: + properties: + description: + description: 'description: wire description' + type: string + x-go-name: Description + name: + description: 'description: wire name' + type: string + x-go-name: Name + zone_ids: + description: Zoneids to be selected + items: + type: string + type: array + x-go-name: ZoneIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAWireNet: + properties: + host_suggested_networks: + description: 'description: 没有合适的已有网络，推荐的网络配置' + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: HostSuggestedNetworks + hosts: + items: + $ref: '#/definitions/CAHostNet' + type: array + x-go-name: Hosts + suggested_wire: + $ref: '#/definitions/CAWireConf' + suitable_wire: + type: string + x-go-name: SuitableWire + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CDNDomainCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Origins: + $ref: '#/definitions/SCdnOrigins' + area: + description: |- + 加速区域 + enmu: mainland, overseas, global + requrired: true + type: string + x-go-name: Area + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + 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 + service_type: + description: 服务类型 + type: string + x-go-name: ServiceType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - Origins + - service_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CDNDomainDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CacheImageInput: + properties: + checksum: + description: 'swagger: ignore' + type: string + x-go-name: Checksum + format: + type: string + x-go-name: Format + image: + type: string + x-go-name: Image + image_id: + type: string + x-go-name: ImageId + image_name: + description: 'swagger: ignore' + type: string + x-go-name: ImageName + is_force: + type: boolean + x-go-name: IsForce + os_arch: + description: 'swagger: ignore' + type: string + x-go-name: OsArch + os_distribution: + description: 'swagger: ignore' + type: string + x-go-name: OsDistribution + os_full_version: + description: 'swagger: ignore' + type: string + x-go-name: OsFullVersion + os_type: + description: 'swagger: ignore' + type: string + x-go-name: OsType + os_version: + description: 'swagger: ignore' + type: string + x-go-name: OsVersion + parent_task_id: + description: 'swagger: ignore' + type: string + x-go-name: ParentTaskId + server_id: + description: 'swagger: ignore' + type: string + x-go-name: ServerId + source_host_id: + description: 'swagger: ignore' + type: string + x-go-name: SourceHostId + src_url: + description: 'swagger: ignore' + type: string + x-go-name: SrcUrl + storagecache_id: + description: 'swagger: ignore' + type: string + x-go-name: StoragecacheId + zone: + description: 'swagger: ignore' + type: string + x-go-name: Zone + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CachedImageManagerCacheImageInput: + properties: + image_id: + type: string + x-go-name: ImageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CachedImageUncacheImageInput: + properties: + is_force: + default: false + description: 是否强制清除缓存 + type: boolean + x-go-name: IsForce + storagecache_id: + description: 存储缓存名Id + type: string + x-go-name: StoragecacheId + required: + - storagecache_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CachedimageDetails: + properties: + cached_count: + description: 此镜像被使用次数 + example: 0 + format: int64 + type: integer + x-go-name: CachedCount + 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 + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + hypervisor: + description: 虚拟化类型 + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + image_type: + description: '镜像类型, system: 公有云镜像, customized: 自定义镜像' + example: system + type: string + x-go-name: ImageType + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + info: + description: 镜像详情信息 + example: + deleted: false + disk_format: qcow2 + id: img-a6uucnfl + is_public: true + min_disk: 51200 + min_ram: 0 + name: FreeBSD 11.1 64bit + properties: + os_arch: x86_64 + os_distribution: FreeBSD + os_type: FreeBSD + os_version: "11" + protected: true + size: 53687091200 + status: active + type: object + x-go-name: Info + 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 + last_ref: + description: |- + 最近一次缓存引用时间 + 2020-01-17T05:20:54.000000Z + format: date-time + type: string + x-go-name: LastRef + last_sync: + description: 上此同步时间 + example: "2020-01-17T05:28:54.000000Z" + format: date-time + type: string + x-go-name: LastSync + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + os_distribution: + description: 操作系统发行版 + example: FreeBSD + type: string + x-go-name: OsDistribution + os_type: + description: 操作系统类型 + example: FreeBSD + type: string + x-go-name: OsType + os_version: + description: 操作系统版本 + example: "11" + type: string + x-go-name: OsVersion + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + ref_count: + description: 引用次数 + example: 0 + format: int64 + type: integer + x-go-name: RefCount + 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 + size: + description: '镜像大小单位: Byte' + example: 53687091200 + format: int64 + type: integer + x-go-name: Size + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 镜像状态, 和info里面的status一致 + example: active + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + uefi: + description: 是否支持UEFI + example: false + type: boolean + x-go-name: UEFI + 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/compute + CdnDomain: + properties: + Area: + description: 区域 mainland|overseas|global + type: string + Cname: + description: cdn Cname + type: string + Domain: + description: cdn加速域名 + type: string + Origin: + description: 源站 + type: string + OriginType: + description: 源站类型 domain|ip|bucket + type: string Status: - type: string - type: object - type: array - type: object - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - SubscriptonCreateInput: - properties: - enrollment_account_id: - description: EA 账号id, 可通过 cloud-account-enrollment-accounts接口获取里面的id字段 - type: string - x-go-name: EnrollmentAccountId - name: - description: 订阅名称 - type: string - x-go-name: Name - offer_type: - description: '可选值: MS-AZR-0017P(生产用途), MS-AZR-0148P(开发测试)' - type: string - x-go-name: OfferType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SyncImagesInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SyncRangeInput: - properties: - deep_sync: - type: boolean - x-go-name: DeepSync - force: - type: boolean - x-go-name: Force - full_sync: - type: boolean - x-go-name: FullSync - host: - items: - type: string - type: array - x-go-name: Host - region: - items: - type: string - type: array - x-go-name: Region - resources: - description: |- - 按资源类型同步，可输入多个 - enmu: project, compute, network, eip, loadbalancer, objectstore, rds, cache, event, cloudid, dnszone, public_ip, intervpcnetwork, saml_auth, quota, nat, nas, waf, mongodb, es, kafka, app, cdn, container, ipv6_gateway, tablestore, modelarts, vpcpeer, misc - items: - type: string - type: array - x-go-name: Resources - xor: - description: 极速模式(差量更新) - type: boolean - x-go-name: Xor - zone: - items: - type: string - type: array - x-go-name: Zone - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - SyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - TBucketACLType: - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TMongoDBBackupMethod: - description: 备份方法 - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TMongoDBBackupStatus: - description: 备份状态 - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TMongoDBBackupType: - description: 备份方式 - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - 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 - TWafAction: - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TWafMatchField: - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TWafMatchFieldValues: - items: - type: string - type: array - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TWafOperator: - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TWafStatementType: - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TWafTextTransformation: - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TWafType: - type: string - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TablestoreCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + description: 状态 rejected(域名未审核)|processing(部署中)|online|offline + type: string 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - TablestoreDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CdnDomains: + properties: + data: + items: + $ref: '#/definitions/CdnDomain' + type: array + x-go-name: Data type: object - x-go-name: Metadata - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - TablestoreUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - TextTransformations: - items: - $ref: '#/definitions/TWafTextTransformation' - type: array - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - TimerCreateInput: - properties: - ExecTime: - description: 'description: 执行时间' - format: date-time - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - TimerDetails: - properties: - exec_time: - description: 'description: 执行时间' - format: date-time - type: string - x-go-name: ExecTime - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - VSwitch: - properties: - distributed: - type: boolean - x-go-name: Distributed - guest_networks: - items: - $ref: '#/definitions/CANetConf' - type: array - x-go-name: GuestNetworks - host_networks: - items: - $ref: '#/definitions/CANetConf' - type: array - x-go-name: HostNetworks - hosts: - items: - $ref: '#/definitions/SimpleHost' - type: array - x-go-name: Hosts - 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/compute - VirtualJointResourceBaseDetails: - 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 - VirtualJointResourceBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - VirtualResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - VirtualResourceCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + Cdrom: + properties: + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + detail: + type: string + x-go-name: Detail + ordinal: + format: int64 + type: integer + x-go-name: Ordinal 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_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - VpcCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates type: object - x-go-name: Metadata - cidr_block: - description: CIDR_BLOCK - type: string - x-go-name: CidrBlock - cloudprovider_id: - description: 列出关联指定云订阅(ID或Name)的资源 - type: string - x-go-name: CloudproviderId - cloudregion_id: - description: 区域名称或ID - type: string - x-go-name: CloudregionId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - enabled: - description: 该资源是否被管理员*人为*启用或者禁用 - type: boolean - x-go-name: Enabled - external_access_mode: - description: Vpc外网访问模式 - type: string - x-go-name: ExternalAccessMode - 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 - globalvpc_id: - description: |- - 仅对谷歌云有用，若谷歌云订阅只有一个全局VPC，此参数可不传 - 若有多个全局VPC，谷歌云需要指定其中一个全局VPC - type: string - x-go-name: GlobalvpcId - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - VpcDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - accpet_vpc_peer_count: - format: int64 - type: integer - x-go-name: AcceptVpcPeerCount - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cidr_block: - description: CIDR地址段 - example: 192.168.222.0/24 - type: string - x-go-name: CidrBlock - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - direct: - description: Can it be connected directly - type: boolean - x-go-name: Direct - dns_zone_count: - description: DnsZone个数 - example: 2 - format: int64 - type: integer - x-go-name: DnsZoneCount - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - environment: - description: Environment - type: string - x-go-name: Environment - external_access_mode: - description: Vpc外网访问模式 - type: string - x-go-name: ExternalAccessMode - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - globalvpc: - description: 全局VPC名称 - type: string - x-go-name: Globalvpc - globalvpc_id: - type: string - x-go-name: GlobalvpcId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_default: - description: 是否是默认VPC - example: true - type: boolean - x-go-name: IsDefault - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis + CloudaccountCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + As: + description: 弹性伸缩服务 + type: string + Bms: + description: 裸金属服务器 + type: string + Bss: + description: 合作伙伴运营能力 + type: string + Cce: + description: 云容器服务 + type: string + Cci: + description: 云容器实例 CCI + type: string + Ces: + description: 监控服务 CloudEye + type: string + Csbs: + description: 云服务器备份服务 + type: string + Cts: + description: 云审计服务 + type: string + Dcs: + description: 分布式缓存服务 + type: string + DefaultRegion: + description: 默认区域Id, Apara及HCSO需要此参数 + example: cn-north-2 + type: string + DefaultSubnetDns: + description: 默认DNS + example: 10.125.0.26,10.125.0.27 + type: string + Ecs: + description: 弹性云服务 + type: string + Elb: + description: 弹性负载均衡 ELB + type: string + EndpointDomain: + description: 华为私有云Endpoint域名 + example: hcso.com.cn + type: string + Eps: + description: 企业项目 + type: string + Evs: + description: 云硬盘 EVS + type: string + Iam: + description: 统一身份认证服务 + type: string + Ims: + description: 镜像服务 + type: string + Modelarts: + description: Modelarts + type: string + Nat: + description: Nat网关 NAT + type: string + Obs: + description: 对象存储服务 OBS + type: string + Rds: + description: 关系型数据库 RDS + type: string + SfsTurbo: + description: 文件系统 + type: string + SkipDuplicateAccountCheck: + description: 跳过重复账号注册检查 + type: boolean + Vbs: + description: 云硬盘备份 VBS + type: string + Vpc: + description: 虚拟私有云 VPC + type: string + access_key_id: + description: 秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeyId + access_key_secret: + description: 秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeySecret + access_url: + description: 认证地址 + type: string + x-go-name: AccessUrl + account: + description: |- + 账号信息，各个平台字段不尽相同，以下是各个平台账号创建所需要的字段 + + + + 云平台 |字段 | 翻译 | 是否必传 | 默认值 | 可否更新 | 获取方式 | + ------ |------ | ------ | --------- | -------- |-------- |-------- | + Aliyun |access_key_id |秘钥ID | 是 | | 是 | | + Aliyun |access_key_secret |秘钥Key | 是 | | 是 | | + Qcloud |app_id |APP ID | 是 | | 否 | | + Qcloud |secret_id |秘钥ID | 是 | | 是 | | + Qcloud |secret_key |秘钥Key | 是 | | 是 | | + OpenStack |project_name |用户所在项目 | 是 | | 是 | | + OpenStack |username |用户名 | 是 | | 是 | | + OpenStack |password |用户密码 | 是 | | 是 | | + OpenStack |auth_url |认证地址 | 是 | | 否 | | + OpenStack |domain_name |用户所在的域 | 否 |Default | 是 | | + VMware |username |用户名 | 是 | | 是 | | + VMware |password |密码 | 是 | | 是 | | + VMware |host |主机IP或域名 | 是 | | 否 | | + VMware |port |主机端口 | 否 |443 | 否 | | + Azure |directory_id |目录ID | 是 | | 否 | | + Azure |environment |区域 | 是 | | 否 | | + Azure |client_id |客户端ID | 是 | | 是 | | + Azure |client_secret |客户端密码 | 是 | | 是 | | + Huawei |access_key_id |秘钥ID | 是 | | 是 | | + Huawei |access_key_secret |秘钥 | 是 | | 是 | | + Huawei |environment |区域 | 是 | | 否 | | + Aws |access_key_id |秘钥ID | 是 | | 是 | | + Aws |access_key_secret |秘钥 | 是 | | 是 | | + Aws |environment |区域 | 是 | | 否 | | + Ucloud |access_key_id |秘钥ID | 是 | | 是 | | + Ucloud |access_key_secret |秘钥 | 是 | | 是 | | + Google |project_id |项目ID | 是 | | 否 | | + Google |client_email |客户端email | 是 | | 否 | | + Google |private_key_id |秘钥ID | 是 | | 是 | | + Google |private_key |秘钥Key | 是 | | 是 | | + type: string + x-go-name: Account + app_id: + description: app id (Qcloud) + type: string + x-go-name: AppId + auto_create_project: + default: false + description: 自动根据云上项目或订阅创建本地项目, OpenStack此参数为true + type: boolean + x-go-name: AutoCreateProject + auto_url: + description: 认证地址 (openstack,zstack) + type: string + x-go-name: AuthUrl + brand: + description: |- + 指定云平台品牌, 此参数默认和provider相同 + requried: false + + + + provider | 支持的参数 | + -------- | ---------- | + VMware | VMware | + Aliyun | Aliyun | + Qcloud | Qcloud | + Azure | Azure | + Aws | Aws | + Huawei | Huawei | + OpenStack | OpenStack | + Ucloud | Ucloud | + ZStack | ZStack, DStack | + Google | Google | + Ctyun | Ctyun | + type: string + x-go-name: Brand + client_id: + description: 客户端ID (Azure) + type: string + x-go-name: ClientId + client_secret: + description: 客户端秘钥 (Azure) + type: string + x-go-name: ClientSecret + currency: + description: |- + 货币类型 + enmu: CNY, USD + type: string + x-go-name: Currency + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + directory_id: + description: 目录ID (Azure) + type: string + x-go-name: DirectoryId + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + domain_name: + default: Default + description: 账号所在的域 (openstack) + type: string + x-go-name: DomainName + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + endpoint: + description: 端点 (s3) 或 Apsara(飞天) + type: string + x-go-name: Endpoint + environment: + description: 环境 (Azure, Aws, huawei, ctyun, aliyun) + type: string + x-go-name: Environment + gcp_client_email: + description: Google服务账号email (gcp) + type: string + x-go-name: GCPClientEmail + gcp_private_key: + description: Google服务账号秘钥 (gcp) + type: string + x-go-name: GCPPrivateKey + gcp_private_key_id: + description: Google服务账号秘钥id (gcp) + type: string + x-go-name: GCPPrivateKeyId + gcp_project_id: + description: Google服务账号project id (gcp) + type: string + x-go-name: GCPProjectId + 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 + host: + description: 主机IP (esxi) + type: string + x-go-name: Host + 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 + options: + description: 额外信息,例如账单的access key + type: object + x-go-name: Options + oracle_private_key: + type: string + x-go-name: OraclePrivateKey + oracle_tenancy_ocid: + type: string + x-go-name: OracleTenancyOCID + oracle_user_ocid: + type: string + x-go-name: OracleUserOCID + organization_id: + description: 飞天允许的最高组织id, 默认为1 + format: int64 + type: integer + x-go-name: OrganizationId + password: + description: 密码 (openstack, zstack, esxi) + type: string + x-go-name: Password + port: + description: 主机端口 (esxi) + format: int64 + type: integer + x-go-name: Port + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_mapping_id: + type: string + x-go-name: ProjectMappingId + project_name: + description: 账号所在的项目 (openstack) + type: string + x-go-name: ProjectName + provider: + description: |- + 指定云平台 + Qcloud: 腾讯云 + Ctyun: 天翼云 + enum: + - VMware + - ' Aliyun' + - ' Qcloud' + - ' Azure' + - ' Aws' + - ' Huawei' + - ' OpenStack' + - ' Ucloud' + - ' ZStack' + - ' Google' + - ' Ctyun' + - ' JDcloud' + type: string + x-go-name: Provider + proxy_setting_id: + description: 代理配置 + type: string + x-go-name: ProxySettingId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + read_only: + type: boolean + x-go-name: ReadOnly + saml_auth: + default: false + description: 是否启用SAML认证 + type: boolean + x-go-name: SAMLAuth + secret_id: + description: 秘钥ID (Qcloud) + type: string + x-go-name: SecretId + secret_key: + description: 秘钥key (Qcloud) + type: string + x-go-name: SecretKey + show_sub_accounts: + description: 仅当show_sub_accounts=true并且dry_run=true时才返回sub accounts 信息, 且不会创建云账号 + type: boolean + x-go-name: ShowSubAccounts + skip_sync_resources: + $ref: '#/definitions/SkipSyncResources' + start_sync: + description: 是否立即开始同步资源 + type: boolean + x-go-name: StartSync + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + username: + description: 用户名 (openstack, zstack, esxi) + type: string + x-go-name: Username + zone: + description: VMware 账号有zone属性 + type: string + x-go-name: Zone + required: + - name + - EndpointDomain + - DefaultRegion type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - natgateway_count: - description: NAT网关个数 - example: 0 - format: int64 - type: integer - x-go-name: NatgatewayCount - network_count: - description: IP子网个数 - example: 2 - format: int64 - type: integer - x-go-name: NetworkCount - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - request_vpc_peer_count: - format: int64 - type: integer - x-go-name: RequestVpcPeerCount - routetable_count: - description: 路由表个数 - example: 0 - format: int64 - type: integer - x-go-name: RoutetableCount - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - wire_count: - description: 二层网络数量 - example: 1 - format: int64 - type: integer - x-go-name: WireCount - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - VpcPeeringConnectionCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountDetail: + properties: + LastSyncCost: + description: 上次同步耗时 + type: string + ProjectMapping: + type: string + access_url: + description: 云环境连接地址 + type: string + x-go-name: AccessUrl + account: + description: 云账号 + type: string + x-go-name: Account + account_id: + description: 云环境唯一标识 + type: string + x-go-name: AccountId + auto_create_project: + description: 是否根据云上项目自动在本地创建对应项目 + example: false + type: boolean + x-go-name: AutoCreateProject + auto_create_project_for_provider: + description: 是否根据云订阅自动在本地创建对应项目 + example: false + type: boolean + x-go-name: AutoCreateProjectForProvider + balance: + description: 账户余额 + example: 124.2 + format: double + type: number + x-go-name: Balance + brand: + description: 品牌信息, 一般和provider相同 + example: DStack + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: |- + 云账号环境类型 + public: 公有云 + private: 私有云 + onpremise: 本地IDC + example: public + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + currency: + description: |- + 账户余额货币类型 + enmu: CNY, USD + type: string + x-go-name: Currency + 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 + disk_count: + description: 云盘数量 + example: 12 + format: int64 + type: integer + x-go-name: DiskCount + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + eip_count: + description: 弹性公网Ip数量 + example: 2 + format: int64 + type: integer + x-go-name: EipCount + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + enabled_provider_count: + description: 启用的子订阅数量 + example: 1 + format: int64 + type: integer + x-go-name: EnabledProviderCount + error_count: + description: 账号探测异常错误次数 + format: int64 + type: integer + x-go-name: ErrorCount + guest_count: + description: 云主机数量 + example: 4 + format: int64 + type: integer + x-go-name: GuestCount + health_status: + description: 账号健康状态 + example: normal + type: string + x-go-name: HealthStatus + host_count: + description: 宿主机数量(不计算虚拟机宿主机数量) + example: 0 + format: int64 + type: integer + x-go-name: HostCount + iam_login_url: + description: 公有云子账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_on_premise: + description: 是否是本地IDC账号 + example: false + type: boolean + x-go-name: IsOnPremise + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_public_cloud: + description: 是否是公有云账号 + example: true + type: boolean + x-go-name: IsPublicCloud + lake_of_permissions: + $ref: '#/definitions/SAccountPermissions' + 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 + options: + description: 额外信息 + type: object + x-go-name: Options + probe_at: + description: 上次账号探测时间 + format: date-time + type: string + x-go-name: ProbeAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_mapping_id: + type: string + x-go-name: ProjectMappingId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台类型 + example: google + type: string + x-go-name: Provider + provider_count: + description: 子订阅数量 + example: 1 + format: int64 + type: integer + x-go-name: ProviderCount + proxy_setting: + $ref: '#/definitions/SProxySetting' + proxy_setting_id: + description: 默认值proxyapi.ProxySettingId_DIRECT + type: string + x-go-name: ProxySettingId + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + read_only: + type: boolean + x-go-name: ReadOnly + routetable_count: + description: 路由表数量 + example: 0 + format: int64 + type: integer + x-go-name: RoutetableCount + saml_auth: + type: boolean + x-go-name: SAMLAuth + secret: + description: 云账号密码 + type: string + x-go-name: Secret + share_mode: + default: '"false" nullable:"false"`' + description: for backward compatiblity, keep is_public field, but not usable + type: string + x-go-name: ShareMode + 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 + skip_sync_resources: + $ref: '#/definitions/SkipSyncResources' + status: + description: 资源状态 + type: string + x-go-name: Status + storage_count: + description: 块存储数量 + example: 12 + format: int64 + type: integer + x-go-name: StorageCount + storagecache_count: + description: 存储缓存数量 + example: 10 + format: int64 + type: integer + x-go-name: StoragecacheCount + sub_accounts: + $ref: '#/definitions/SubAccounts' + sync_count: + description: 并发同步数量 + format: int64 + type: integer + x-go-name: SyncCount + sync_interval_seconds: + description: 同步时间间隔 + example: 3600 + format: int64 + type: integer + x-go-name: SyncIntervalSeconds + sync_status: + type: string + x-go-name: SyncStatus + sync_stauts2: + description: 同步状态 + type: string + x-go-name: SyncStatus2 + sysinfo: + description: 云系统信息 + type: object + x-go-name: Sysinfo + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + version: + description: 云API版本 + type: string + x-go-name: Version + vpc_count: + description: 虚拟私有网络数量 + example: 4 + format: int64 + type: integer + x-go-name: VpcCount type: object - x-go-name: Metadata - Bandwidth: - description: |- - 跨区域vpc对等连接带宽，仅对腾讯云有效 - 单位Mbps,可选值 10,20,50,100,200,500,1000 - format: int64 - type: integer - PeerVpcId: - type: string - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - vpc_id: - type: string - x-go-name: VpcId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - VpcPeeringConnectionDetails: - properties: - PeerVpcName: - type: string - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountPerformPrepareNetsInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + As: + description: 弹性伸缩服务 + type: string + Bms: + description: 裸金属服务器 + type: string + Bss: + description: 合作伙伴运营能力 + type: string + Cce: + description: 云容器服务 + type: string + Cci: + description: 云容器实例 CCI + type: string + Ces: + description: 监控服务 CloudEye + type: string + Csbs: + description: 云服务器备份服务 + type: string + Cts: + description: 云审计服务 + type: string + Dcs: + description: 分布式缓存服务 + type: string + DefaultRegion: + description: 默认区域Id, Apara及HCSO需要此参数 + example: cn-north-2 + type: string + DefaultSubnetDns: + description: 默认DNS + example: 10.125.0.26,10.125.0.27 + type: string + Ecs: + description: 弹性云服务 + type: string + Elb: + description: 弹性负载均衡 ELB + type: string + EndpointDomain: + description: 华为私有云Endpoint域名 + example: hcso.com.cn + type: string + Eps: + description: 企业项目 + type: string + Evs: + description: 云硬盘 EVS + type: string + Iam: + description: 统一身份认证服务 + type: string + Ims: + description: 镜像服务 + type: string + Modelarts: + description: Modelarts + type: string + Nat: + description: Nat网关 NAT + type: string + Obs: + description: 对象存储服务 OBS + type: string + Rds: + description: 关系型数据库 RDS + type: string + SfsTurbo: + description: 文件系统 + type: string + SkipDuplicateAccountCheck: + description: 跳过重复账号注册检查 + type: boolean + Vbs: + description: 云硬盘备份 VBS + type: string + Vpc: + description: 虚拟私有云 VPC + type: string + access_key_id: + description: 秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeyId + access_key_secret: + description: 秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeySecret + access_url: + description: 认证地址 + type: string + x-go-name: AccessUrl + account: + description: |- + 账号信息，各个平台字段不尽相同，以下是各个平台账号创建所需要的字段 + + + + 云平台 |字段 | 翻译 | 是否必传 | 默认值 | 可否更新 | 获取方式 | + ------ |------ | ------ | --------- | -------- |-------- |-------- | + Aliyun |access_key_id |秘钥ID | 是 | | 是 | | + Aliyun |access_key_secret |秘钥Key | 是 | | 是 | | + Qcloud |app_id |APP ID | 是 | | 否 | | + Qcloud |secret_id |秘钥ID | 是 | | 是 | | + Qcloud |secret_key |秘钥Key | 是 | | 是 | | + OpenStack |project_name |用户所在项目 | 是 | | 是 | | + OpenStack |username |用户名 | 是 | | 是 | | + OpenStack |password |用户密码 | 是 | | 是 | | + OpenStack |auth_url |认证地址 | 是 | | 否 | | + OpenStack |domain_name |用户所在的域 | 否 |Default | 是 | | + VMware |username |用户名 | 是 | | 是 | | + VMware |password |密码 | 是 | | 是 | | + VMware |host |主机IP或域名 | 是 | | 否 | | + VMware |port |主机端口 | 否 |443 | 否 | | + Azure |directory_id |目录ID | 是 | | 否 | | + Azure |environment |区域 | 是 | | 否 | | + Azure |client_id |客户端ID | 是 | | 是 | | + Azure |client_secret |客户端密码 | 是 | | 是 | | + Huawei |access_key_id |秘钥ID | 是 | | 是 | | + Huawei |access_key_secret |秘钥 | 是 | | 是 | | + Huawei |environment |区域 | 是 | | 否 | | + Aws |access_key_id |秘钥ID | 是 | | 是 | | + Aws |access_key_secret |秘钥 | 是 | | 是 | | + Aws |environment |区域 | 是 | | 否 | | + Ucloud |access_key_id |秘钥ID | 是 | | 是 | | + Ucloud |access_key_secret |秘钥 | 是 | | 是 | | + Google |project_id |项目ID | 是 | | 否 | | + Google |client_email |客户端email | 是 | | 否 | | + Google |private_key_id |秘钥ID | 是 | | 是 | | + Google |private_key |秘钥Key | 是 | | 是 | | + type: string + x-go-name: Account + app_id: + description: app id (Qcloud) + type: string + x-go-name: AppId + auto_create_project: + default: false + description: 自动根据云上项目或订阅创建本地项目, OpenStack此参数为true + type: boolean + x-go-name: AutoCreateProject + auto_url: + description: 认证地址 (openstack,zstack) + type: string + x-go-name: AuthUrl + brand: + description: |- + 指定云平台品牌, 此参数默认和provider相同 + requried: false + + + + provider | 支持的参数 | + -------- | ---------- | + VMware | VMware | + Aliyun | Aliyun | + Qcloud | Qcloud | + Azure | Azure | + Aws | Aws | + Huawei | Huawei | + OpenStack | OpenStack | + Ucloud | Ucloud | + ZStack | ZStack, DStack | + Google | Google | + Ctyun | Ctyun | + type: string + x-go-name: Brand + client_id: + description: 客户端ID (Azure) + type: string + x-go-name: ClientId + client_secret: + description: 客户端秘钥 (Azure) + type: string + x-go-name: ClientSecret + currency: + description: |- + 货币类型 + enmu: CNY, USD + type: string + x-go-name: Currency + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + directory_id: + description: 目录ID (Azure) + type: string + x-go-name: DirectoryId + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + domain_name: + default: Default + description: 账号所在的域 (openstack) + type: string + x-go-name: DomainName + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + dvs: + type: boolean + x-go-name: Dvs + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + endpoint: + description: 端点 (s3) 或 Apsara(飞天) + type: string + x-go-name: Endpoint + environment: + description: 环境 (Azure, Aws, huawei, ctyun, aliyun) + type: string + x-go-name: Environment + gcp_client_email: + description: Google服务账号email (gcp) + type: string + x-go-name: GCPClientEmail + gcp_private_key: + description: Google服务账号秘钥 (gcp) + type: string + x-go-name: GCPPrivateKey + gcp_private_key_id: + description: Google服务账号秘钥id (gcp) + type: string + x-go-name: GCPPrivateKeyId + gcp_project_id: + description: Google服务账号project id (gcp) + type: string + x-go-name: GCPProjectId + 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 + host: + description: 主机IP (esxi) + type: string + x-go-name: Host + 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 + options: + description: 额外信息,例如账单的access key + type: object + x-go-name: Options + oracle_private_key: + type: string + x-go-name: OraclePrivateKey + oracle_tenancy_ocid: + type: string + x-go-name: OracleTenancyOCID + oracle_user_ocid: + type: string + x-go-name: OracleUserOCID + organization_id: + description: 飞天允许的最高组织id, 默认为1 + format: int64 + type: integer + x-go-name: OrganizationId + password: + description: 密码 (openstack, zstack, esxi) + type: string + x-go-name: Password + port: + description: 主机端口 (esxi) + format: int64 + type: integer + x-go-name: Port + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_mapping_id: + type: string + x-go-name: ProjectMappingId + project_name: + description: 账号所在的项目 (openstack) + type: string + x-go-name: ProjectName + provider: + description: |- + 指定云平台 + Qcloud: 腾讯云 + Ctyun: 天翼云 + enum: + - VMware + - ' Aliyun' + - ' Qcloud' + - ' Azure' + - ' Aws' + - ' Huawei' + - ' OpenStack' + - ' Ucloud' + - ' ZStack' + - ' Google' + - ' Ctyun' + - ' JDcloud' + type: string + x-go-name: Provider + proxy_setting_id: + description: 代理配置 + type: string + x-go-name: ProxySettingId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + read_only: + type: boolean + x-go-name: ReadOnly + saml_auth: + default: false + description: 是否启用SAML认证 + type: boolean + x-go-name: SAMLAuth + secret_id: + description: 秘钥ID (Qcloud) + type: string + x-go-name: SecretId + secret_key: + description: 秘钥key (Qcloud) + type: string + x-go-name: SecretKey + show_sub_accounts: + description: 仅当show_sub_accounts=true并且dry_run=true时才返回sub accounts 信息, 且不会创建云账号 + type: boolean + x-go-name: ShowSubAccounts + skip_sync_resources: + $ref: '#/definitions/SkipSyncResources' + start_sync: + description: 是否立即开始同步资源 + type: boolean + x-go-name: StartSync + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + username: + description: 用户名 (openstack, zstack, esxi) + type: string + x-go-name: Username + wire_level_for_vmware: + type: string + x-go-name: WireLevelForVmware + zone: + description: VMware 账号有zone属性 + type: string + x-go-name: Zone + required: + - name + - EndpointDomain + - DefaultRegion type: object - x-go-name: Metadata - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - 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' - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - VpcPeeringConnectionUpdateInput: - 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/compute - VpcSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - VpcTopologyOutput: - properties: - name: - type: string - x-go-name: Name - status: - type: string - x-go-name: Status - wires: - items: - $ref: '#/definitions/WireTopologyOutput' - type: array - x-go-name: Wires - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - VpcUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - external_access_mode: - description: Vpc外网访问模式 - type: string - x-go-name: ExternalAccessMode - name: - description: 资源名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafAddresses: - description: +onecloud:model-api-gen - items: - type: string - type: array - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - WafIPSetCacheDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountPerformPrepareNetsOutput: + properties: + hosts: + items: + $ref: '#/definitions/CAGuestNet' + type: array + x-go-name: Hosts + vswitchs: + items: + $ref: '#/definitions/VSwitch' + type: array + x-go-name: VSwitchs + wire_networks: + items: + $ref: '#/definitions/CAWireNet' + type: array + x-go-name: CAWireNets + wires: + description: Guests []CAGuestNet `json:"guests"` + items: + $ref: '#/definitions/CAPWire' + type: array + x-go-name: Wires type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - 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 - waf_ip_set_id: - type: string - x-go-name: WafIPSetId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafIPSetDetails: - properties: - addresses: - $ref: '#/definitions/WafAddresses' - 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_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountPerformPublicInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + share_mode: + description: 共享模式，可能值为provider_domain, system + example: provider_domain + type: string + x-go-name: ShareMode + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafInstanceCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountProjectMappingInput: + properties: + auto_create_project: + type: boolean + x-go-name: AutoCreateProject + auto_create_project_for_provider: + type: boolean + x-go-name: AutoCreateProjectForProvider + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + project_id: + type: string + x-go-name: ProjectId + project_mapping_id: + description: |- + 同步策略Id, 若不传此参数则解绑 + 绑定同步策略要求当前云账号此刻未绑定其他同步策略 + type: string + x-go-name: ProjectMappingId type: object - x-go-name: Metadata - CloudResources: - description: |- - 关联云资源列表 - 阿里云要求输入此参数或source_ips - items: - $ref: '#/definitions/SCloudResource' - type: array - DefaultAction: - $ref: '#/definitions/DefaultAction' - Type: - $ref: '#/definitions/TWafType' - cloudprovider_id: - description: 列出关联指定云订阅(ID或Name)的资源 - type: string - x-go-name: CloudproviderId - cloudregion_id: - description: 区域名称或ID - type: string - x-go-name: CloudregionId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - 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 - source_ips: - $ref: '#/definitions/WafSourceIps' - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafInstanceDetails: - properties: - Rules: - items: - $ref: '#/definitions/SWafRule' - type: array - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - default_action: - $ref: '#/definitions/DefaultAction' - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountShareModeInput: + properties: + ShareMode: + type: string type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - 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/compute - WafRegexPatterns: - description: +onecloud:model-api-gen - items: - type: string - type: array - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - WafRegexSetCacheDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountSyncSkusInput: + properties: + Force: + type: boolean + Resource: + type: string + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - 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 - waf_regex_set_id: - type: string - x-go-name: WafRegexSetId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafRegexSetDetails: - 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 - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountUpdateInput: + properties: + add_skip_sync_resources: + items: + type: string + type: array + x-go-name: AddSkipSyncResources + clean_lake_of_permissions: + description: 临时清除缺失的权限提示，云账号权限缺失依然会自动刷新 + type: boolean + x-go-name: CleanLakeOfPermissions + currency: + type: string + x-go-name: Currency + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + options: + description: 待更新的options key/value + type: object + x-go-name: Options + proxy_setting_id: + description: 代理配置 + type: string + x-go-name: ProxySettingId + read_only: + type: boolean + x-go-name: ReadOnly + remove_options: + description: 带删除的options key + items: + type: string + type: array + x-go-name: RemoveOptions + remove_skip_sync_resources: + items: + type: string + type: array + x-go-name: RemoveSkipSyncResources + saml_auth: + type: boolean + x-go-name: SAMLAuth + skip_sync_resources: + $ref: '#/definitions/SkipSyncResources' type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - regex_patterns: - $ref: '#/definitions/WafRegexPatterns' - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafRuleCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderDetails: + properties: + LastSyncCost: + description: 上次同步耗时 + type: string + ProjectMapping: + type: string + access_url: + type: string + x-go-name: AccessUrl + account: + description: 云账号的用户信息，例如用户名，access key等 + type: string + x-go-name: Account + brand: + description: 子订阅品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capabilities: + description: 支持服务列表 + items: + type: string + type: array + x-go-name: Capabilities + cloudaccount: + description: 云账号名称 + example: google-account + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 归属云账号ID + type: string + x-go-name: CloudaccountId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + dbinstance_count: + description: 数据库实例数量 + example: 2 + format: int64 + type: integer + x-go-name: DBInstanceCount + 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 + eip_count: + description: 弹性公网IP数量 + example: 12 + format: int64 + type: integer + x-go-name: EipCount + elasticcache_count: + description: 弹性缓存实例数量 + example: 2 + format: int64 + type: integer + x-go-name: ElasticcacheCount + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + guest_count: + description: 云主机数量 + example: 1 + format: int64 + type: integer + x-go-name: GuestCount + health_status: + description: |- + 云端服务健康状态。例如欠费、项目冻结都属于不健康状态。 + HealthStatus | 说明 | + ---------------|----------------------| + normal | 远端处于健康状态 | + insufficient | 不足按需资源余额 | + suspended | 远端处于冻结状态 | + arrears | 远端处于欠费状态 | + unknown | 未知状态，查询失败 | + no permission | 没有权限获取账单信息 | + type: string + x-go-name: HealthStatus + host_count: + description: 宿主机数量 + example: 2 + format: int64 + type: integer + x-go-name: HostCount + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + 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 + loadbalancer_count: + description: 负载均衡器数量 + example: 2 + format: int64 + type: integer + x-go-name: LoadbalancerCount + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_count: + description: 项目数量 + format: int64 + type: integer + x-go-name: ProjectCount + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_mapping_id: + type: string + x-go-name: ProjectMappingId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云账号的平台信息 + type: string + x-go-name: Provider + proxy_setting: + $ref: '#/definitions/SProxySetting' + read_only: + type: boolean + x-go-name: ReadOnly + secret: + description: 云账号的密码信息，例如密码，access key secret等。该字段在数据库加密存储。Google需要存储秘钥证书,需要此字段比较长 + type: string + x-go-name: Secret + snapshot_count: + description: 快照数量 + example: 0 + format: int64 + type: integer + x-go-name: SnapshotCount + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_count: + description: 块存储梳理 + example: 4 + format: int64 + type: integer + x-go-name: StorageCount + storagecache_count: + description: 存储缓存数量 + example: 1 + format: int64 + type: integer + x-go-name: StorageCacheCount + sync_region_count: + description: 同步区域数量 + format: int64 + type: integer + x-go-name: SyncRegionCount + sync_status: + type: string + x-go-name: SyncStatus + sync_status2: + description: 子订阅同步状态 + type: string + x-go-name: SyncStatus2 + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + vpc_count: + description: 虚拟私有网络数量 + example: 4 + format: int64 + type: integer + x-go-name: VpcCount type: object - x-go-name: Metadata - Statements: - description: 条件表达式 - items: - $ref: '#/definitions/SWafStatement' - type: array - action: - $ref: '#/definitions/DefaultAction' - 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 - priority: - description: |- - 优先级,不可重复 - Azure优先级范围1-100 - format: int64 - type: integer - x-go-name: Priority - statement_condition: - description: 'enmu: and, or, not' - type: string - x-go-name: StatementCondition - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - waf_instance_id: - description: WAF实例Id - type: string - x-go-name: WafInstanceId - waf_rule_group_id: - description: |- - swagger: ignore - WAF规则组Id - type: string - x-go-name: WafRuleGroupId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafRuleDetails: - properties: - Statements: - items: - $ref: '#/definitions/SWafStatement' - type: array - action: - $ref: '#/definitions/DefaultAction' - 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 - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderGetCannedAclOutput: + properties: + bucket_canned_acls: + description: Bucket支持的预置ACL列表 + items: + type: string + type: array + x-go-name: BucketCannedAcls + object_canned_acls: + description: Object支持的预置ACL列表 + items: + type: string + type: array + x-go-name: ObjectCannedAcls type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - priority: - description: 规则优先级 - format: int64 - type: integer - x-go-name: Priority - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - statement_conditon: - description: 条件 - type: string - x-go-name: StatementConditon - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - waf_instance_id: - description: 所属waf实例id - type: string - x-go-name: WafInstanceId - waf_rule_group_id: - description: 规则组的id - type: string - x-go-name: WafRuleGroupId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafRuleGroupCacheDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: 云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderGetStorageClassOutput: + properties: + storage_classes: + description: 对象存储存储类型 + items: + type: string + type: array + x-go-name: StorageClasses type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - 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 - waf_rule_group_id: - type: string - x-go-name: WafRuleGroupId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafRuleGroupDetails: - properties: - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - type: string - x-go-name: CloudEnv - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - is_system: - type: boolean - x-go-name: IsSystem - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderSync: + properties: + cloudregion_ids: + description: 指定区域信息 + items: + type: string + type: array + x-go-name: CloudregionIds + enabled: + default: false + description: 指定区域启用或禁用同步 + type: boolean + x-go-name: Enabled type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - waf_type: - description: 支持的WAF类型,仅is_system=true时有效 - type: string - x-go-name: WafType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafRuleUpdateInput: - properties: - Statements: - description: 条件表达式 - items: - $ref: '#/definitions/SWafStatement' - type: array - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WafSourceIps: - items: - type: string - type: array - x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider - WafSyncstatusInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WireCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress type: object - x-go-name: Metadata - bandwidth: - default: 0 - description: '带宽大小,单位: Mbps' - format: int64 - type: integer - x-go-name: Bandwidth - bw: - description: Deprecated - format: int64 - type: integer - x-go-name: Bw - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - external_access_mode: - description: Vpc外网访问模式 - type: string - x-go-name: ExternalAccessMode - 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 - mtu: - default: 0 - description: mtu - format: int64 - maximum: 1000000 - minimum: 0 - type: integer - x-go-name: Mtu - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - vpc_id: - description: 关联VPC(ID或Name) - type: string - x-go-name: VpcId - zone_id: - description: 可用区ID或名称 - example: zone1 - type: string - x-go-name: ZoneId - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WireDetails: - properties: - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - account_id: - description: 云账号Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: AccountId - bandwidth: - description: 带宽大小, 单位Mbps - example: 1000 - format: int64 - type: integer - x-go-name: Bandwidth - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: VPC归属区域ID - type: string - x-go-name: CloudregionId - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - host_count: - description: Host数量 - example: 1 - format: int64 - type: integer - x-go-name: HostCount - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - manager: - description: 云订阅名称 - example: google-account - type: string - x-go-name: Manager - manager_domain: - description: 子订阅所在域名称 - example: Default - type: string - x-go-name: ManagerDomain - manager_domain_id: - description: 子订阅所在域Id - example: default - type: string - x-go-name: ManagerDomainId - manager_id: - description: VPC归属云订阅ID - type: string - x-go-name: ManagerId - manager_project: - description: 子订阅所在项目名称 - example: system - type: string - x-go-name: ManagerProject - manager_project_id: - description: 子订阅所在项目Id - example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c - type: string - x-go-name: ManagerProjectId - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderregionDetails: + 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 + capabilities: + description: 支持服务列表 + items: + type: string + type: array + x-go-name: Capabilities + cloudaccount: + description: 云账号名称 + example: googl-account + type: string + x-go-name: Cloudaccount + cloudaccount_domain_id: + description: 云账号所在域Id + example: 0df40413-eb69-49c7-895e-618ddeb80f55 + type: string + x-go-name: CloudaccountDomainId + cloudaccount_id: + description: 云账号Id + example: fa4aaf88-aed8-422d-84e7-56dea533b364 + type: string + x-go-name: CloudaccountId + cloudprovider: + type: string + x-go-name: Cloudprovider + cloudprovider_sync_status: + description: 云订阅同步状态 + type: string + x-go-name: CloudproviderSyncStatus + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + last_sync_cost: + description: 上次同步耗时 + type: string + x-go-name: LastSyncCost + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' type: object - x-go-name: Metadata - mtu: - description: MTU - example: 1500 - format: int64 - type: integer - x-go-name: Mtu - name: - description: 资源名称 - type: string - x-go-name: Name - networks: - description: IP子网数量 - example: 1 - format: int64 - type: integer - x-go-name: Networks - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - shared_domains: - description: 共享的域列表 - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 - items: - $ref: '#/definitions/SharedProject' - type: array - x-go-name: SharedProjects - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' - type: string - x-go-name: Source - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - vpc: - description: Vpc Name - type: string - x-go-name: Vpc - vpc_ext_id: - description: VPC外部Id - type: string - x-go-name: VpcExtId - vpc_id: - type: string - x-go-name: VpcId - zone: - description: 可用区名称 - example: 北京一区 - type: string - x-go-name: Zone - zone_ext_id: - description: 纳管云的zoneId - type: string - x-go-name: ZoneExtId - zone_id: - type: string - x-go-name: ZoneId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WireMergeFromInput: - properties: - merge_network: - description: 'description: if merge networks under wire' - type: boolean - x-go-name: MergeNetwork - sources: - description: 'description: wire ids or names to be merged from' - items: - type: string - type: array - x-go-name: Sources - required: - - sources - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WireMergeInput: - properties: - merge_network: - description: 'description: if merge networks under wire' - type: boolean - x-go-name: MergeNetwork - target: - description: 'description: wire id or name to be merged' - example: test-wire - type: string - x-go-name: Target - required: - - target - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WireMergeNetworkInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WireTopologyOutput: - properties: - bandwidth: - format: int64 - type: integer - x-go-name: Bandwidth - hosts: - items: - $ref: '#/definitions/HostTopologyOutput' - type: array - x-go-name: Hosts - name: - type: string - x-go-name: Name - networks: - items: - $ref: '#/definitions/NetworkTopologyOutput' - type: array - x-go-name: Networks - status: - type: string - x-go-name: Status - zone: - type: string - x-go-name: Zone - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - WireUpdateInput: - properties: - bandwidth: - description: bandwidth in MB - format: int64 - type: integer - x-go-name: Bandwidth - description: - description: 资源描述 - type: string - x-go-name: Description - mtu: - description: MTU - example: 1500 - format: int64 - type: integer - x-go-name: Mtu - name: - description: 资源名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ZoneCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudregionDetails: + 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 + city: + description: 城市 + example: Guiyang + type: string + x-go-name: City + cloud_env: + description: 云类型, public, private or onpremise + example: public + type: string + x-go-name: CloudEnv + country_code: + description: 国家代码 + example: CN + type: string + x-go-name: CountryCode + 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: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: 云环境 + example: ChinaCloud + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + guest_count: + description: 云主机梳理 + example: 2 + format: int64 + type: integer + x-go-name: GuestCount + guest_increment_count: + description: 距离前天0点新增云主机数量 + example: 0 + format: int64 + type: integer + x-go-name: GuestIncrementCount + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + latitude: + description: 纬度 + example: 26.647003 + format: float + type: number + x-go-name: Latitude + longitude: + description: 经度 + example: 106.630211 + format: float + type: number + x-go-name: Longitude + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network_count: + description: IP子网数量 + example: 12 + format: int64 + type: integer + x-go-name: NetworkCount + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台 + example: Huawei + type: string + x-go-name: Provider + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc_count: + description: 虚拟私有网络数量 + example: 2 + format: int64 + type: integer + x-go-name: VpcCount + zone_count: + description: 可用区数量 + example: 3 + format: int64 + type: integer + x-go-name: ZoneCount type: object - x-go-name: Metadata - Cloudregion: - description: 区域名称或Id,建议使用Id - type: string - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - generate_name: - description: |- - 生成资源名称的模板，如果name为空，则为必填项 - description: generated resource name, given a pattern to generate name, required if name is not given - example: test### - type: string - x-go-name: GenerateName - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - name: - description: |- - 资源名称，如果generate_name为空，则为必填项 - description: resource name, required if generated_name is not given - example: test-network - type: string - uniqueItems: true - x-go-name: Name - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute - ZoneDetails: - properties: - baremetals: - description: 可用区底下的裸金属服务器数量 - example: 1 - format: int64 - type: integer - x-go-name: Baremetals - baremetals_enabled: - description: 可用区底下启用的裸金属服务器数量 - example: 1 - format: int64 - type: integer - x-go-name: BaremetalsEnabled - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - cloudregion_id: - description: 归属区域ID - type: string - x-go-name: CloudregionId - contacts: - type: string - x-go-name: Contacts - 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 - environment: - description: Environment - type: string - x-go-name: Environment - external_id: - description: 云上Id, 对应云上资源自身Id - type: string - x-go-name: ExternalId - hosts: - description: 可用区底下的宿主机数量 - example: 3 - format: int64 - type: integer - x-go-name: Hosts - hosts_enabled: - description: 可用区底下启用的宿主机数量 - example: 2 - format: int64 - type: integer - x-go-name: HostsEnabled - id: - description: 资源UUID - type: string - x-go-name: Id - imported_at: - description: 资源导入时间 - format: date-time - type: string - x-go-name: ImportedAt - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - location: - type: string - x-go-name: Location - manager_uri: - type: string - x-go-name: ManagerUri - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudregionPurgeInput: + properties: + manager_id: + description: 云订阅Id, 若region底下不存在任何资源,会删除当前region + type: string + x-go-name: ManagerId + required: + - manager_id type: object - x-go-name: Metadata - name: - description: 资源名称 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudregionSkuSyncInput: + properties: + cloudregion_ids: + description: 区域ID + items: + type: string + type: array + x-go-name: CloudregionIds + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + resource: + description: |- + 同步资源类型 + choices: serversku|elasticcachesku|dbinstance_sku + type: string + x-go-name: Resource + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ContainerCapability: + properties: + add: + items: + type: string + type: array + x-go-name: Add + drop: + items: + type: string + type: array + x-go-name: Drop + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerCreateInput: + 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 + guest_id: + type: string + x-go-name: GuestId + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + spec: + $ref: '#/definitions/ContainerSpec' + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ContainerDevice: + properties: + host: + $ref: '#/definitions/ContainerHostDevice' + isolated_device: + $ref: '#/definitions/ContainerIsolatedDevice' + type: + $ref: '#/definitions/ContainerDeviceType' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ContainerDeviceType: type: string - x-go-name: Name - name_cn: + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerExecInfoOutput: + properties: + container_id: + type: string + x-go-name: ContainerId + host_uri: + type: string + x-go-name: HostUri + pod_id: + type: string + x-go-name: PodId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ContainerHostDevice: + properties: + container_path: + description: Path of the device within the container. + type: string + x-go-name: ContainerPath + host_path: + description: Path of the device on the host. + type: string + x-go-name: HostPath + permissions: + description: |- + Cgroups permissions of the device, candidates are one or more of + r - allows container to read from the specified device. + w - allows container to write to the specified device. + m - allows container to create device files that do not yet exist. + type: string + x-go-name: Permissions + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ContainerIsolatedDevice: + properties: + id: + type: string + x-go-name: Id + index: + format: int64 + type: integer + x-go-name: Index + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ContainerKeyValue: + properties: + key: + type: string + x-go-name: Key + value: + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerLifecyle: + properties: + post_start: + $ref: '#/definitions/ContainerLifecyleHandler' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerLifecyleHandler: + properties: + exec: + $ref: '#/definitions/ContainerLifecyleHandlerExecAction' + type: + $ref: '#/definitions/ContainerLifecyleHandlerType' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerLifecyleHandlerExecAction: + properties: + command: + items: + type: string + type: array + x-go-name: Command + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerLifecyleHandlerType: type: string - x-go-name: NameCn - networks: - description: 可用区底下的子网数量 - example: 1 - format: int64 - type: integer - x-go-name: Networks - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - provider: - description: 云平台名称 - example: Google + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerMountPropagation: type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerSaveVolumeMountToImageInput: + properties: + image_id: + type: string + x-go-name: ImageId + volume_mount: + $ref: '#/definitions/ContainerVolumeMount' + volume_mount_index: + format: int64 + type: integer + x-go-name: VolumeMountIndex + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/host + ContainerSpec: + properties: + args: + description: Args for the Command (i.e. command for docker) + items: + type: string + type: array + x-go-name: Args + capabilities: + $ref: '#/definitions/ContainerCapability' + cgroup_devices_allow: + items: + type: string + type: array + x-go-name: CgroupDevicesAllow + command: + description: Command to execute (i.e., entrypoint for docker) + items: + type: string + type: array + x-go-name: Command + devices: + items: + $ref: '#/definitions/ContainerDevice' + type: array + x-go-name: Devices + enable_lxcfs: + description: Enable lxcfs + type: boolean + x-go-name: EnableLxcfs + envs: + description: List of environment variable to set in the container. + items: + $ref: '#/definitions/ContainerKeyValue' + type: array + x-go-name: Envs + image: + description: Image to use. + type: string + x-go-name: Image + image_pull_policy: + $ref: '#/definitions/ImagePullPolicy' + lifecyle: + $ref: '#/definitions/ContainerLifecyle' + privileged: + type: boolean + x-go-name: Privileged + simulate_cpu: + type: boolean + x-go-name: SimulateCpu + volume_mounts: + description: Volume mounts + items: + $ref: '#/definitions/ContainerVolumeMount' + type: array + x-go-name: VolumeMounts + working_dir: + description: Current working directory of the command. + type: string + x-go-name: WorkingDir + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ContainerStopInput: + properties: + timeout: + format: int64 + type: integer + x-go-name: Timeout + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ContainerUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + spec: + $ref: '#/definitions/ContainerSpec' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ContainerVolumeMount: + properties: + disk: + $ref: '#/definitions/ContainerVolumeMountDisk' + host_path: + $ref: '#/definitions/ContainerVolumeMountHostPath' + mount_path: + description: |- + Path within the container at which the volume should be mounted. Must + not contain ':'. + type: string + x-go-name: MountPath + propagation: + $ref: '#/definitions/ContainerMountPropagation' + read_only: + description: Mounted read-only if true, read-write otherwise (false or unspecified). + type: boolean + x-go-name: ReadOnly + selinux_relabel: + description: If set, the mount needs SELinux relabeling. + type: boolean + x-go-name: SelinuxRelabel + type: + $ref: '#/definitions/ContainerVolumeMountType' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/host + ContainerVolumeMountDisk: + properties: + id: + type: string + x-go-name: Id + index: + format: int64 + type: integer + x-go-name: Index + overlay: + $ref: '#/definitions/ContainerVolumeMountDiskOverlay' + storage_size_file: + type: string + x-go-name: StorageSizeFile + sub_directory: + type: string + x-go-name: SubDirectory + template_id: + type: string + x-go-name: TemplateId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/host + ContainerVolumeMountDiskOverlay: + properties: + lower_dir: + items: + type: string + type: array + x-go-name: LowerDir + use_disk_image: + type: boolean + x-go-name: UseDiskImage + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerVolumeMountHostPath: + properties: + path: + type: string + x-go-name: Path + type: + $ref: '#/definitions/ContainerVolumeMountHostPathType' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerVolumeMountHostPathType: type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + x-go-package: yunion.io/x/onecloud/pkg/apis + ContainerVolumeMountType: type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + x-go-package: yunion.io/x/onecloud/pkg/apis + ConvertToKvmInput: + properties: + networks: + description: dest guest network configs + items: + $ref: '#/definitions/NetworkConfig' + type: array + x-go-name: Networks + prefer_host: + description: 指定转换的宿主机 + type: string + x-go-name: PreferHost + target_hypervisor: + description: target hypervisor + type: string + x-go-name: TargetHypervisor + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CycleTimerCreateInput: + properties: + cycle_hour: + format: int64 + type: integer + x-go-name: CycleHour + cycle_type: + description: 'description: 周期类型' + enum: + - day + - week + - month + type: string + x-go-name: CycleType + end_time: + description: 'description: 截止时间' + format: date-time + type: string + x-go-name: EndTime + hour: + description: 'description: 时(0-23)' + example: 13 + format: int64 + type: integer + x-go-name: Hour + minute: + description: 'description: 分(0-59)' + example: 13 + format: int64 + type: integer + x-go-name: Minute + month_days: + description: 'description: 每月的哪几天; 1-31' + example: + - 1 + - 4 + - 31 + items: + format: int64 + type: integer + type: array + x-go-name: MonthDays + start_time: + description: 'description: 开始时间' + format: date-time + type: string + x-go-name: StartTime + week_days: + description: 'description: 每周的周几; 1-7, 1: Monday, 7: Sunday' + example: + - 1 + - 3 + - 5 + - 7 + items: + format: int64 + type: integer + type: array + x-go-name: WeekDays + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CycleTimerDetails: + properties: + cycle_type: + description: 'description: 周期类型：按天/周/月' + type: string + x-go-name: CycleType + end_time: + description: 'description: 此周期任务的截止时间' + format: date-time + type: string + x-go-name: EndTime + hour: + description: 'description: 小时' + format: int64 + type: integer + x-go-name: Hour + minute: + description: 'description: 分钟' + format: int64 + type: integer + x-go-name: Minute + month_days: + description: 'description: 每月的几天' + items: + format: int64 + type: integer + type: array + x-go-name: MonthDays + start_time: + description: 'description: 此周期任务的开始时间' + format: date-time + type: string + x-go-name: StartTime + week_days: + description: 'description: 每周的几天' + items: + format: int64 + type: integer + type: array + x-go-name: WeekDays + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceAccountCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + dbinstance: + description: |- + rds实例名称或Id,建议使用Id + + + + 平台 |支持Rds引擎 | + ---- |------- | + Aliyun |MySQL, MariaBD, SQLServer | + 华为云 |MySQL, MariaBD | + 腾讯云 |MySQL | + type: string + x-go-name: DBInstance + 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 + password: + description: 账号密码，若不指定,则会随机生成 + type: string + x-go-name: Password + privileges: + description: 账号权限 + items: + $ref: '#/definitions/SDBInstanceAccountPrivilege' + type: array + x-go-name: Privileges + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - dbinstance + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceAccountDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + dbinstance: + description: RDS实例名称 + type: string + x-go-name: DBInstance + dbinstance_id: + type: string + x-go-name: DBInstanceId + dbinstanceprivileges: + description: 账号权限列表 + items: + $ref: '#/definitions/DBInstancePrivilege' + type: array + x-go-name: DBInstanceprivileges + 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 + environment: + description: Environment + type: string + x-go-name: Environment + host: + type: string + x-go-name: Host + id: + description: 资源UUID + type: string + x-go-name: Id + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secret: + description: 数据库密码 + type: string + x-go-name: Secret + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceAccountUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceAutoRenewInput: + properties: + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceBackupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + databases: + description: 需要备份的Rds数据库列表 + items: + type: string + type: array + x-go-name: Databases + dbinstance: + description: Rds实例名称或Id, 建议使用Id + type: string + x-go-name: DBInstance + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - dbinstance + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceBackupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + backup_method: + description: 备份方式 Logical|Physical + type: string + x-go-name: BackupMethod + backup_mode: + description: 备份模式 + type: string + x-go-name: BackupMode + backup_size_mb: + description: 备份大小 + example: 32 + format: int64 + type: integer + x-go-name: BackupSizeMb + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + db_names: + description: 备份数据库名称 + type: string + x-go-name: DBNames + dbinstance: + description: RDS实例名称 + type: string + x-go-name: DBInstance + dbinstance_id: + type: string + x-go-name: DBInstanceId + 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 + end_time: + description: 备份结束时间 + format: date-time + type: string + x-go-name: EndTime + engine: + description: RDS引擎 + example: MySQL + type: string + x-go-name: Engine + engine_version: + description: RDS引擎版本 + example: "5.7" + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + start_time: + description: 备份开始时间 + format: date-time + type: string + x-go-name: StartTime + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + DBInstanceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + BillingType: + description: 计费方式 + enum: + - postpaid + - ' prepaid' + type: string + address: + description: Ip子网内的地址,不填则按照ip子网的地址分配策略分配一个ip + type: string + x-go-name: Address + auto_renew: + default: false + description: 是否自动续费(仅包年包月时生效) + type: boolean + x-go-name: AutoRenew + category: + description: |- + rds类型 + + + + 平台 | 支持类型 | 说明 | + ----- | ------ | --- | + 华为云 |ha, single, replica| ha: 高可用, single: 单机, replica: 只读| + 阿里云 |basic, high_availability, always_on, finance|basic: 基础版, high_availability: 高可用, always_on: 集群版, finance: 金融版, 三节点| + Google |Zonal, Regional | Zonal: 单区域, Regional: 区域级| + 腾讯云 |fe, ha, basic | ha: 高可用, basic: 基础版, fe: 金融版| + type: string + x-go-name: Category + dbinstancebackup_id: + description: 从备份中创建新实例 + type: string + x-go-name: DBInstancebackupId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + disk_size_gb: + description: |- + rds存储大小 + 可参考rds套餐的大小范围和步长情况 + format: int64 + type: integer + x-go-name: DiskSizeGB + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时间周期 + type: string + x-go-name: Duration + engine: + description: rds引擎 + enum: + - MySQL + - ' SQLServer' + - ' PostgreSQL' + - ' MariaDB' + - ' Oracle' + - ' PPAS' + type: string + x-go-name: Engine + engine_version: + description: |- + rds引擎版本 + 根据各个引擎版本各不相同 + type: string + x-go-name: EngineVersion + 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 + instance_type: + description: |- + 套餐名称, 若此参数不填, 则必须有vmem_size_mb及vcpu_count参数 + 套餐列表可以通过 dbinstancesku 获取 + type: string + x-go-name: InstanceType + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + master_instance: + description: |- + rds实例名称或Id,建议使用Id + 创建只读实例时此参数必传 + type: string + x-go-name: MasterInstance + multi_az: + description: 多可用区部署 + type: boolean + x-go-name: MultiAZ + 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 + network_id: + description: |- + Ip子网名称或Id,建议使用Id + 谷歌云并不实际使用Ip子网,仅仅通过Ip子网确定Vpc + type: string + x-go-name: NetworkId + password: + description: |- + rds初始化密码 + 阿里云不需要此参数 + 华为云会默认创建一个用户,若不传此参数, 则为随机密码 + 谷歌云会默认创建一个用户,若不传此参数, 则为随机密码 + 腾讯云会默认创建一个用户,若不传此参数, 则为随机密码 + type: string + x-go-name: Password + port: + description: 指定连接端口 + format: int64 + type: integer + x-go-name: Port + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + reset_password: + description: |- + 是否不设置初始密码 + 华为云不支持此参数 + 谷歌云仅mysql支持此参数 + type: boolean + x-go-name: ResetPassword + secgroup_ids: + description: |- + 安全组Id列表 + + + 云平台 | 最大支出安全组数量 | + -------------|---------- | + 腾讯云 | 5 | + 华为云 | 1 | + 阿里云 | 不支持 | + items: + type: string + type: array + x-go-name: SecgroupIds + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_type: + description: |- + rds存储类型 + + + + 平台 | 支持类型 | 说明 | + ----- | ------ | --- | + 华为云 |SSD, SAS, SATA| | + 阿里云 |local_ssd, cloud_essd, cloud_ssd| | + Google |PD_SSD, PD_HDD| PD_SSD: SSD, PD_HDD: HDD| + 腾讯云 |cloud_ssd, local_ssd| | + type: string + x-go-name: StorageType + vcpu_count: + description: |- + rds实例cpu大小 + 若指定实例套餐，此参数将根据套餐设置 + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size_mb: + description: |- + rds实例内存大小 + 若指定实例套餐，此参数将根据套餐设置 + format: int64 + type: integer + x-go-name: VmemSizeMb + zone1: + description: 主可用区名称或Id, 此参数从指定的套餐所在的可用区获取 + type: string + x-go-name: Zone1 + zone2: + description: 次可用区名称或Id, 此参数从指定的套餐所在的可用区获取 + type: string + x-go-name: Zone2 + zone3: + description: 三节点可用区名称或Id,, 此参数从指定的套餐所在的可用区获取 + type: string + x-go-name: Zone3 + required: + - name + - network_id + - engine + - engine_version + - category + - storage_type + - disk_size_gb + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceDatabaseCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + accounts: + description: 赋予账号权限 + items: + $ref: '#/definitions/SDBInstanceDatabasePrivilege' + type: array + x-go-name: Accounts + character_set: + description: 数据库字符集 + type: string + x-go-name: CharacterSet + dbinstance: + description: |- + rds实例名称或Id,建议使用Id + + + + 平台 |支持Rds引擎 | + ---- |------- | + Aliyun |MySQL, MariaBD, SQLServer | + 华为云 |MySQL, MariaBD | + 腾讯云 | | + type: string + x-go-name: DBInstance + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - dbinstance + - character_set + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceDatabaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + category: + description: 实例类型 + example: ha + type: string + x-go-name: Category + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + connection_str: + description: 外部连接地址 + type: string + x-go-name: ConnectionStr + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + databases: + items: + $ref: '#/definitions/IdNameDetails' + type: array + x-go-name: Databases + dbinstancebackup_id: + description: 从备份创建新实例 + type: string + x-go-name: DBInstancebackupId + 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 + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + disk_size_gb: + description: 存储大小 + example: 10240 + format: int64 + type: integer + x-go-name: DiskSizeGB + disk_size_used_mb: + description: 已使用的存储大小 + format: int64 + type: integer + x-go-name: DiskSizeUsedMB + domain_id: + description: 域Id + type: string + x-go-name: DomainId + engine: + description: 引擎 + example: MySQL + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + example: "5.7" + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + example: mysql.x4.large.2c + type: string + x-go-name: InstanceType + internal_connection_str: + description: 内部连接地址 + type: string + x-go-name: InternalConnectionStr + iops: + description: iops + example: 0 + format: int64 + type: integer + x-go-name: Iops + ip_addrs: + description: 内网IP地址, 若有多个以 ',' 分隔 + type: string + x-go-name: IpAddrs + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + maintain_time: + description: 维护时间 + type: string + x-go-name: MaintainTime + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + master_instance_id: + description: 主实例Id + type: string + x-go-name: MasterInstanceId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network: + description: IP子网名称, 若有多个以 ',' 分隔 + example: test-network + type: string + x-go-name: Network + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + port: + description: 端口 + example: 3306 + format: int64 + type: integer + x-go-name: Port + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secgroup: + description: 安全组名称 + example: Default + type: string + x-go-name: Secgroup + secgroups: + items: + $ref: '#/definitions/StandaloneShortDesc' + type: array + x-go-name: Secgroups + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_type: + description: 存储类型 + example: local_ssd + type: string + x-go-name: StorageType + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + vcpu_count: + description: CPU数量 + example: 1 + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size_mb: + description: 内存大小 + example: 1024 + format: int64 + type: integer + x-go-name: VmemSizeMb + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 虚拟私有网络Id + example: ed20d84e-3158-41b1-870c-1725e412e8b6 + type: string + x-go-name: VpcId + zone1: + description: 可用区1 + type: string + x-go-name: Zone1 + zone1_name: + description: Zone1名称 + type: string + x-go-name: Zone1Name + zone2: + description: 可用区2 + type: string + x-go-name: Zone2 + zone2_name: + description: Zone2名称 + type: string + x-go-name: Zone2Name + zone3: + description: 可用区3 + type: string + x-go-name: Zone3 + zone3_name: + description: Zone3名称 + type: string + x-go-name: Zone3Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstancePrivilege: + properties: + account: + description: 账号名称 + type: string + x-go-name: Account + database: + description: 数据库名称 + type: string + x-go-name: Database + dbinstancedatabase_id: + description: 数据库Id + type: string + x-go-name: DBInstancedatabaseId + privileges: + description: 权限 + type: string + x-go-name: Privileges + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceSecgroupDetails: + 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 + dbinstance: + description: RDS名称 + type: string + x-go-name: DBInstance + delete_fail_reason: + $ref: '#/definitions/Error' + secgroup: + description: 安全组名称 + type: string + x-go-name: Secgroup + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceSetSecgroupInput: + properties: + secgroup_ids: + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceSkuDetails: + 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 + category: + type: string + x-go-name: Category + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + disk_size_step: + format: int64 + type: integer + x-go-name: DiskSizeStep + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + engine: + type: string + x-go-name: Engine + engine_version: + type: string + x-go-name: EngineVersion + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + iops: + format: int64 + type: integer + x-go-name: IOPS + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + max_connections: + format: int64 + type: integer + x-go-name: MaxConnections + max_disk_size_gb: + description: 步长 + format: int64 + type: integer + x-go-name: MaxDiskSizeGb + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + min_disk_size_gb: + format: int64 + type: integer + x-go-name: MinDiskSizeGb + multi_az: + type: boolean + x-go-name: MultiAZ + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + type: string + x-go-name: Provider + qps: + format: int64 + type: integer + x-go-name: QPS + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_type: + type: string + x-go-name: StorageType + tps: + format: int64 + type: integer + x-go-name: TPS + 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 + vcpu_count: + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size_mb: + format: int64 + type: integer + x-go-name: VmemSizeMb + zone_id: + type: string + x-go-name: ZoneId + zone1: + type: string + x-go-name: Zone1 + zone1_name: + type: string + x-go-name: Zone1Name + zone2: + type: string + x-go-name: Zone2 + zone2_name: + type: string + x-go-name: Zone2Name + zone3: + type: string + x-go-name: Zone3 + zone3_name: + type: string + x-go-name: Zone3Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstancedatabaseDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + character_set: + description: 字符集 + example: utf-8 + type: string + x-go-name: CharacterSet + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + dbinstance: + description: RDS实例名称 + type: string + x-go-name: DBInstance + dbinstance_id: + type: string + x-go-name: DBInstanceId + dbinstanceprivileges: + description: 数据库权限 + items: + $ref: '#/definitions/DBInstancePrivilege' + type: array + x-go-name: DBInstanceprivileges + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceparameterDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + dbinstance: + description: RDS实例名称 + type: string + x-go-name: DBInstance + dbinstance_id: + type: string + x-go-name: DBInstanceId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + key: + description: 数据库参数名称 + type: string + x-go-name: Key + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + 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 + value: + description: 数据库参数值 + type: string + x-go-name: Value + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DefaultAction: + properties: + action: + description: Allow, Block, Log, Count, Alert, Detection, Prevention + type: string + x-go-name: Action + insert_headers: + additionalProperties: + type: string + description: 仅Action为Allow时生效 + type: object + x-go-name: InsertHeaders + response: + description: 仅Action为Block时生效 + type: string + x-go-name: Response + response_code: + description: 仅Action为Block时生效 + format: int64 + type: integer + x-go-name: ResponseCode + response_headers: + additionalProperties: + type: string + description: 仅Action为Block时生效 + type: object + x-go-name: ResponseHeaders + title: DefaultAction is an autogenerated struct via yunion.io/x/cloudmux/pkg/cloudprovider.DefaultAction. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudprovider + DeployConfig: + properties: + action: + type: string + x-go-name: Action + content: + type: string + x-go-name: Content + path: + type: string + x-go-name: Path + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskBackupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + back_storage_id: + description: 'description: backup storage id' + type: string + x-go-name: BackupStorageId + cloudregion_id: + description: 'swagger: ignore' + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disk_id: + description: 'description: disk id' + type: string + x-go-name: DiskId + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskBackupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + backup_storage_name: + description: 'description: backup storage name' + type: string + x-go-name: BackupStorageName + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + disk_name: + description: 'description: disk name' + type: string + x-go-name: DiskName + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + is_sub_backup: + description: 'description: 是否是子备份' + type: boolean + x-go-name: IsSubBackup + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskBackupRecoveryInput: + properties: + Name: + description: 'description: name of disk' + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskBackupSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskConfig: + properties: + backend: + description: |- + 后端存储类型,若指定了存储ID,此参数会根据存储设置,若不指定，则作为调度的一个参考 + + + + 平台 | 存储类型 | 中文 | 数据盘 | 系统盘 | 可否扩容 | 可否单独创建 | 扩容步长 | 说明 | + ---- | ---- | ---- | ----- | ----- | ------- | ----------- | ------- | ----- | + Esxi |local |本地盘 |1-500GB |30~500GB | 是 | 否 | 1G | | + Esxi |nas |NAS盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | + Esxi |vsan |VSAN盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | + KVM |local |本地盘盘 |1-500GB |30~500GB | 是 | 否 | 1G | | + KVM |rbd |云硬盘 |1-3072GB |30~500GB | 是 | 是 | 1G | | + Azure |standard_lrs |标准 HDD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + Azure |standardssd_lrs |标准 SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + Azure |premium_lrs |高级SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + AWS |gp2 |通用型SSD |1-16384GB |20~16384GB | 是 | 是 | 1G | | + AWS |io1 |预配置 IOPS SSD |4-16384GB |20-16384GB | 是 | 是 | 1G | | + AWS |st1 |吞吐优化HDD |500-16384GB |不支持 | 是 | 是 | 1G | | + AWS |sc1 |Cold HDD |500-16384GB |不支持 | 是 | 是 | 1G | | + AWS |standard |磁介质 |1-1024GB |20-1024GB | 是 | 是 | 1G | | + 腾讯云 |cloud_ssd |SSD云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | + 腾讯云 |cloud_basic |普通云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | + 腾讯云 |cloud_preium |高性能云硬盘 |10-16000GB |50~1024GB | 是 | 是 | 10G | | + 腾讯云 |local_basic |普通本地盘 |10-1600GB |不支持 | 否 | 否 | | | + 腾讯云 |local_ssd |SSD本地盘 |10-7000GB |部分区域套餐支持 | 否 | 否 | | | + 腾讯云 |local_pro |HDD本地盘 |跟随套餐 |部分区域套餐支持 | 否 | 否 | | | + 华为云或天翼云 |SSD |超高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + 华为云或天翼云 |SAS |高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + 华为云或天翼云 |SATA |普通IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + OpenStack |nova |nova |不支持 |30-500GB | 否 | 否 | | | + OpenStack |自定义 |... |无限制 |无限制 | 是 | 是 | 1G | | + Ucloud |CLOUD_NORMAL |普通云盘 |20-8000GB |不支持 | 是 | 是 | 1G | | + Ucloud |CLOUD_SSD |SSD云盘 |20-4000GB |20-500GB | 是 | 是 | 1G | | + Ucloud |LOCAL_NORMAL |普通本地盘 | | | 是 | 是 | 1G | | + Ucloud |LOCAL_SSD |SSD本地盘 | | | 是 | 是 | 1G | | + Ucloud |EXCLUSIVE_LOCAL_DISK |独享本地盘 | | | 是 | 是 | 1G | | + ZStack |localstorage |本地盘 | | | 是 | 是 | 1G | | + ZStack |ceph |云硬盘 | | | 是 | 是 | 1G | | + Google |local-ssd |本地SSD暂存盘 |375GB |不支持 | 否 | 否 | | 跟随实例创建，一次最多添加8个 | + Google |pd-standard |标准永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | + Google |pd-ssd |SSD永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | + type: string + x-go-name: Backend + backup_id: + type: string + x-go-name: BackupId + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + cache: + description: 磁盘缓存模式 + enum: + - writeback + - ' none' + - ' writethrough' + type: string + x-go-name: Cache + disk_type: + description: 磁盘类型 + enum: + - sys + - ' data' + - ' swap' + type: string + x-go-name: DiskType + driver: + description: 磁盘驱动方式 + enum: + - virtio + - ' ide' + - ' scsi' + - ' sata' + - ' pvscsi' + type: string + x-go-name: Driver + format: + description: 磁盘存储格式 + enum: + - qcow2 + - ' raw' + - ' docker' + - ' iso' + - ' vmdk' + - ' vmdkflatver1' + - ' vmdkflatver2' + - ' vmdkflat' + - ' vmdksparse' + - ' vmdksparsever1' + - ' vmdksparsever2' + - ' vmdksepsparse vhd' + type: string + x-go-name: Format + fs: + description: 文件系统,仅kvm支持自动格式化磁盘,私有云和公有云此参数不会生效 + enum: + - swap + - ' ext2' + - ' ext3' + - ' ext4' + - ' xfs' + - ' ntfs' + - ' fat' + - ' hfsplus' + type: string + x-go-name: Fs + image_encrypt_key_id: + description: 镜像加密key ID + type: string + x-go-name: ImageEncryptKeyId + image_id: + description: 镜像ID,通过镜像创建磁盘,创建虚拟机时第一块磁盘需要指定此参数 + type: string + x-go-name: ImageId + index: + default: -1 + description: 挂载到虚拟机的磁盘顺序, -1代表不挂载任何虚拟机 + format: int64 + type: integer + x-go-name: Index + iops: + description: requried:false + format: int64 + type: integer + x-go-name: Iops + medium: + default: hybird + description: |- + 介质类型 + rotate: 机械盘 + ssd: 固态硬盘 + hybird: 混合盘 + emum: [rotate, ssd, hybrid] + type: string + x-go-name: Medium + mountpoint: + description: |- + 挂载点,必须以 '/' 开头,例如 /opt 仅KVM此参数有效 + requried: false + type: string + x-go-name: Mountpoint + nvme_device: + $ref: '#/definitions/IsolatedDeviceConfig' + os_arch: + description: 操作系统CPU架构 + type: string + x-go-name: OsArch + preallocation: + default: "off" + description: |- + 预分配策略: + off: 关闭预分配，默认关闭 + metadata: 精简置备 + falloc: 厚置备延迟置零 + full: 厚置备快速置零 + type: string + x-go-name: Preallocation + schedtags: + items: + $ref: '#/definitions/SchedtagConfig' + type: array + x-go-name: Schedtags + size: + description: |- + 磁盘大小,单位Mb + 若创建裸金属服务器是, -1代表自动向后扩展存储 + requried:true + format: int64 + type: integer + x-go-name: SizeMb + snapshot_id: + description: 快照ID,通过快照创建磁盘,此参数必须加上 'snapshot-' 前缀 + example: snapshot-3140cecb-ccc4-4865-abae-3a5ba8c69d9b + type: string + x-go-name: SnapshotId + storage_id: + description: |- + 存储ID, 指定存储后，磁盘会在此存储上创建 + 存储列表可以参数 storage 列表API + type: string + x-go-name: Storage + throughput: + description: |- + 磁盘吞吐量, 仅对aws gp3生效 + 范围: 125-1000 + format: int64 + type: integer + x-go-name: Throughput + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + backend: + description: |- + 后端存储类型,若指定了存储ID,此参数会根据存储设置,若不指定，则作为调度的一个参考 + + + + 平台 | 存储类型 | 中文 | 数据盘 | 系统盘 | 可否扩容 | 可否单独创建 | 扩容步长 | 说明 | + ---- | ---- | ---- | ----- | ----- | ------- | ----------- | ------- | ----- | + Esxi |local |本地盘 |1-500GB |30~500GB | 是 | 否 | 1G | | + Esxi |nas |NAS盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | + Esxi |vsan |VSAN盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | + KVM |local |本地盘盘 |1-500GB |30~500GB | 是 | 否 | 1G | | + KVM |rbd |云硬盘 |1-3072GB |30~500GB | 是 | 是 | 1G | | + Azure |standard_lrs |标准 HDD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + Azure |standardssd_lrs |标准 SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + Azure |premium_lrs |高级SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + AWS |gp2 |通用型SSD |1-16384GB |20~16384GB | 是 | 是 | 1G | | + AWS |io1 |预配置 IOPS SSD |4-16384GB |20-16384GB | 是 | 是 | 1G | | + AWS |st1 |吞吐优化HDD |500-16384GB |不支持 | 是 | 是 | 1G | | + AWS |sc1 |Cold HDD |500-16384GB |不支持 | 是 | 是 | 1G | | + AWS |standard |磁介质 |1-1024GB |20-1024GB | 是 | 是 | 1G | | + 腾讯云 |cloud_ssd |SSD云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | + 腾讯云 |cloud_basic |普通云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | + 腾讯云 |cloud_preium |高性能云硬盘 |10-16000GB |50~1024GB | 是 | 是 | 10G | | + 腾讯云 |local_basic |普通本地盘 |10-1600GB |不支持 | 否 | 否 | | | + 腾讯云 |local_ssd |SSD本地盘 |10-7000GB |部分区域套餐支持 | 否 | 否 | | | + 腾讯云 |local_pro |HDD本地盘 |跟随套餐 |部分区域套餐支持 | 否 | 否 | | | + 华为云或天翼云 |SSD |超高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + 华为云或天翼云 |SAS |高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + 华为云或天翼云 |SATA |普通IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + OpenStack |nova |nova |不支持 |30-500GB | 否 | 否 | | | + OpenStack |自定义 |... |无限制 |无限制 | 是 | 是 | 1G | | + Ucloud |CLOUD_NORMAL |普通云盘 |20-8000GB |不支持 | 是 | 是 | 1G | | + Ucloud |CLOUD_SSD |SSD云盘 |20-4000GB |20-500GB | 是 | 是 | 1G | | + Ucloud |LOCAL_NORMAL |普通本地盘 | | | 是 | 是 | 1G | | + Ucloud |LOCAL_SSD |SSD本地盘 | | | 是 | 是 | 1G | | + Ucloud |EXCLUSIVE_LOCAL_DISK |独享本地盘 | | | 是 | 是 | 1G | | + ZStack |localstorage |本地盘 | | | 是 | 是 | 1G | | + ZStack |ceph |云硬盘 | | | 是 | 是 | 1G | | + Google |local-ssd |本地SSD暂存盘 |375GB |不支持 | 否 | 否 | | 跟随实例创建，一次最多添加8个 | + Google |pd-standard |标准永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | + Google |pd-ssd |SSD永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | + type: string + x-go-name: Backend + backup_id: + type: string + x-go-name: BackupId + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + cache: + description: 磁盘缓存模式 + enum: + - writeback + - ' none' + - ' writethrough' + type: string + x-go-name: Cache + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disk_type: + description: 磁盘类型 + enum: + - sys + - ' data' + - ' swap' + type: string + x-go-name: DiskType + driver: + description: 磁盘驱动方式 + enum: + - virtio + - ' ide' + - ' scsi' + - ' sata' + - ' pvscsi' + type: string + x-go-name: Driver + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + format: + description: 磁盘存储格式 + enum: + - qcow2 + - ' raw' + - ' docker' + - ' iso' + - ' vmdk' + - ' vmdkflatver1' + - ' vmdkflatver2' + - ' vmdkflat' + - ' vmdksparse' + - ' vmdksparsever1' + - ' vmdksparsever2' + - ' vmdksepsparse vhd' + type: string + x-go-name: Format + fs: + description: 文件系统,仅kvm支持自动格式化磁盘,私有云和公有云此参数不会生效 + enum: + - swap + - ' ext2' + - ' ext3' + - ' ext4' + - ' xfs' + - ' ntfs' + - ' fat' + - ' hfsplus' + type: string + x-go-name: Fs + 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 + hypervisor: + default: kvm + description: 此参数仅适用于未指定storage时进行调度到指定平台创建磁盘 + enum: + - kvm + - ' openstack' + - ' esxi' + - ' aliyun' + - ' aws' + - ' qcloud' + - ' azure' + - ' huawei' + - ' openstack' + - ' ucloud' + - ' zstack google' + - ' ctyun' + type: string + x-go-name: Hypervisor + image_encrypt_key_id: + description: 镜像加密key ID + type: string + x-go-name: ImageEncryptKeyId + image_id: + description: 镜像ID,通过镜像创建磁盘,创建虚拟机时第一块磁盘需要指定此参数 + type: string + x-go-name: ImageId + index: + default: -1 + description: 挂载到虚拟机的磁盘顺序, -1代表不挂载任何虚拟机 + format: int64 + type: integer + x-go-name: Index + iops: + description: requried:false + format: int64 + type: integer + x-go-name: Iops + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + medium: + default: hybird + description: |- + 介质类型 + rotate: 机械盘 + ssd: 固态硬盘 + hybird: 混合盘 + emum: [rotate, ssd, hybrid] + type: string + x-go-name: Medium + mountpoint: + description: |- + 挂载点,必须以 '/' 开头,例如 /opt 仅KVM此参数有效 + requried: false + type: string + x-go-name: Mountpoint + 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 + nvme_device: + $ref: '#/definitions/IsolatedDeviceConfig' + os_arch: + description: 操作系统CPU架构 + type: string + x-go-name: OsArch + preallocation: + default: "off" + description: |- + 预分配策略: + off: 关闭预分配，默认关闭 + metadata: 精简置备 + falloc: 厚置备延迟置零 + full: 厚置备快速置零 + type: string + x-go-name: Preallocation + prefer_host_id: + description: 此参数仅适用于未指定storage时进行调度到指定可用区区创建磁盘 + type: string + x-go-name: PreferHost + prefer_manager_id: + description: 调度使用指定的云账号 + type: string + x-go-name: PreferManager + prefer_region_id: + description: 此参数仅适用于未指定storage时进行调度到指定区域创建磁盘 + type: string + x-go-name: PreferRegion + prefer_zone_id: + description: 此参数仅适用于未指定storage时进行调度到指定可用区区创建磁盘 + type: string + x-go-name: PreferZone + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + schedtags: + items: + $ref: '#/definitions/SchedtagConfig' + type: array + x-go-name: Schedtags + size: + description: |- + 磁盘大小,单位Mb + 若创建裸金属服务器是, -1代表自动向后扩展存储 + requried:true + format: int64 + type: integer + x-go-name: SizeMb + snapshot_id: + description: 快照ID,通过快照创建磁盘,此参数必须加上 'snapshot-' 前缀 + example: snapshot-3140cecb-ccc4-4865-abae-3a5ba8c69d9b + type: string + x-go-name: SnapshotId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_id: + description: |- + 存储ID, 指定存储后，磁盘会在此存储上创建 + 存储列表可以参数 storage 列表API + type: string + x-go-name: Storage + throughput: + description: |- + 磁盘吞吐量, 仅对aws gp3生效 + 范围: 125-1000 + format: int64 + type: integer + x-go-name: Throughput + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskDetails: + properties: + access_path: + description: 磁盘路径 + type: string + x-go-name: AccessPath + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + auto_delete: + description: 是否跟随资源自动删除 + example: false + type: boolean + x-go-name: AutoDelete + auto_delete_at: + description: 自动清理时间 + format: date-time + type: string + x-go-name: AutoDeleteAt + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + backup_id: + description: 备份Id + type: string + x-go-name: BackupId + backup_storage_id: + description: 备份磁盘实例的存储ID + type: string + x-go-name: BackupStorageId + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + 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 + disk_format: + description: 磁盘存储类型 + example: qcow2 + type: string + x-go-name: DiskFormat + disk_size: + description: 磁盘大小, 单位Mb + example: 10240 + format: int64 + type: integer + x-go-name: DiskSize + disk_type: + description: |- + 磁盘类型 + sys: 系统盘 + data: 数据盘 + swap: 交换盘 + example: sys + type: string + x-go-name: DiskType + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + fs_format: + description: 文件系统 + type: string + x-go-name: FsFormat + guest: + description: 所挂载的虚拟机 + type: string + x-go-name: Guest + guest_count: + description: 所挂载虚拟机的数量 + format: int64 + type: integer + x-go-name: GuestCount + guest_status: + description: 所挂载虚拟机状态 + type: string + x-go-name: GuestStatus + guests: + description: 所挂载的虚拟机 + items: + $ref: '#/definitions/SimpleGuest' + type: array + x-go-name: Guests + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + iops: + description: 最大连接数 + format: int64 + type: integer + x-go-name: Iops + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_ssd: + description: 是否标记为SSD磁盘 + type: boolean + x-go-name: IsSsd + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + medium_type: + description: 存储介质类型 + type: string + x-go-name: MediumType + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nonpersistent: + description: '# is persistent' + type: boolean + x-go-name: Nonpersistent + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + preallocation: + description: |- + 预分配策略 + off: 关闭预分配，默认关闭 + metadata: 精简制备 + falloc: 厚制制备延迟置零 + full: 厚制备快速置零 + type: string + x-go-name: Preallocation + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + snapshot_id: + description: 快照Id + type: string + x-go-name: SnapshotId + snapshotpolicies: + description: 自动快照策略 + items: + $ref: '#/definitions/SimpleSnapshotPolicy' + type: array + x-go-name: Snapshotpolicies + snapshotpolicy_status: + description: 自动快照策略状态 + type: string + x-go-name: SnapshotpolicyStatus + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage: + description: 存储名称 + type: string + x-go-name: Storage + storage_id: + type: string + x-go-name: StorageId + storage_status: + description: 存储状态 + type: string + x-go-name: StorageStatus + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + template_id: + description: 镜像Id + type: string + x-go-name: TemplateId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + throughput: + description: 磁盘吞吐量 + format: int64 + type: integer + x-go-name: Throughput + 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 + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskMigrateInput: + properties: + target_storage_id: + type: string + x-go-name: TargetStorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskRebuildInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskResetInput: + properties: + auto_start: + type: boolean + x-go-name: AutoStart + snapshot_id: + type: string + x-go-name: SnapshotId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskResizeInput: + properties: + size: + description: 'default unit: Mb' + example: 1024; 40G; 1024M + type: string + x-go-name: Size + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskSaveInput: + properties: + Format: + type: string + ImageId: + description: 'swagger: ignore' + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskSnapshotpolicyInput: + properties: + snapshotpolicy_id: + type: string + x-go-name: SnapshotpolicyId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + disk_type: + description: 磁盘类型 + type: string + x-go-name: DiskType + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordCreateInput: + 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 + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dns_type: + type: string + x-go-name: DnsType + dns_value: + type: string + x-go-name: DnsValue + dns_zone_id: + type: string + x-go-name: DnsZoneId + 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 + mx_priority: + format: int64 + type: integer + x-go-name: MxPriority + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + policy_type: + type: string + x-go-name: PolicyType + policy_value: + type: string + x-go-name: PolicyValue + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + ttl: + format: int64 + type: integer + x-go-name: TTL + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordDetails: + 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 + dns_type: + type: string + x-go-name: DnsType + dns_value: + type: string + x-go-name: DnsValue + dns_zone: + type: string + x-go-name: DnsZone + dns_zone_id: + type: string + x-go-name: DnsZoneId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + mx_priority: + format: int64 + type: integer + x-go-name: MxPriority + name: + description: 资源名称 + type: string + x-go-name: Name + policy_type: + description: 解析线路类型 + type: string + x-go-name: PolicyType + policy_value: + description: 解析线路 + type: string + x-go-name: PolicyValue + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + ttl: + format: int64 + type: integer + x-go-name: TTL + 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/compute + DnsRecordDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + dns_type: + type: string + x-go-name: DnsType + dns_value: + type: string + x-go-name: DnsValue + mx_priority: + format: int64 + type: integer + x-go-name: MxPriority + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + ttl: + format: int64 + type: integer + x-go-name: TTL + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneAddVpcsInput: + properties: + vpc_ids: + description: VPC id列表 + items: + type: string + type: array + x-go-name: VpcIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + 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: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_ids: + description: VPC id列表, 仅在zone_type为PrivateZone时生效, vpc列表必须属于同一个账号 + items: + type: string + type: array + x-go-name: VpcIds + zone_type: + description: |- + 区域类型 + + + 类型 | 说明 | + ---------- |---------| + PublicZone | 公有 | + PrivateZone | 私有 | + type: string + x-go-name: ZoneType + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + dns_record_count: + description: Dns记录数量 + format: int64 + type: integer + x-go-name: DnsRecordCount + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + product_type: + type: string + x-go-name: ProductType + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + vpc_count: + description: 关联vpc数量 + format: int64 + type: integer + x-go-name: VpcCount + zone_type: + type: string + x-go-name: ZoneType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZonePurgeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneRemoveVpcsInput: + properties: + vpc_ids: + description: VPC id列表 + items: + type: string + type: array + x-go-name: VpcIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneSyncStatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DomainLevelResourceBaseUpdateInput: + 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 + DynamicschedtagDetails: + 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 + condition: + description: 动态调度标间的匹配条件 + example: host.sys_load > 1.5 || host.mem_used_percent > 0.7 => "high_load" + type: string + x-go-name: Condition + 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 + 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 + resource_type: + description: 调度标签管理的资源类型 + type: string + x-go-name: ResourceType + schedtag: + description: 调度标签名称 + type: string + x-go-name: Schedtag + schedtag_id: + description: 归属调度标签ID + type: string + x-go-name: SchedtagId + 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/compute + ElasticDissociateInput: + properties: + auto_delete: + default: false + description: |- + 注意: 若关联到aws NAT网关后，目前没办法解除关联关系 + 是否解绑后自动删除弹性公网IP + type: boolean + x-go-name: AutoDelete + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticSearchAccessInfo: + description: +onecloud:model-api-gen + properties: + Domain: + type: string + KibanaPrivateUrl: + type: string + KibanaUrl: + type: string + Port: + format: int64 + type: integer + PrivateDomain: + type: string + PrivatePort: + format: int64 + type: integer + Vip: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + ElasticSearchCreateInput: + description: 资源创建参数, 目前仅占位 + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticSearchDetails: + description: 资源返回详情 + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network: + description: IP子网名称 + type: string + x-go-name: Network + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheAccountDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_privilege: + description: 账号类型 normal |admin + type: string + x-go-name: AccountPrivilege + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + account_type: + type: string + x-go-name: AccountType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + 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 + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存ID + type: string + x-go-name: ElasticcacheId + engine: + description: 引擎 + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + password: + description: 账号权限 read | write | repl（复制, 复制权限支持读写，且开放SYNC/PSYNC命令） + type: string + x-go-name: Password + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属Zone ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheAclDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + 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 + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存ID + type: string + x-go-name: ElasticcacheId + engine: + description: 引擎 + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + ip_list: + description: Ip地址白名单列表 + type: string + x-go-name: IpList + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属Zone ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheBackupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + backup_mode: + description: 备份模式，自动|手动 + type: string + x-go-name: BackupMode + backup_size_mb: + description: 备份大小 + format: int64 + type: integer + x-go-name: BackupSizeMb + backup_type: + description: 备份类型, 全量|增量额 + type: string + x-go-name: BackupType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + 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 + download_url: + description: 下载地址 + type: string + x-go-name: DownloadURL + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存ID + type: string + x-go-name: ElasticcacheId + end_time: + description: 结束备份时间 + format: date-time + type: string + x-go-name: EndTime + engine: + description: 引擎 + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + start_time: + description: 开始备份时间 + format: date-time + type: string + x-go-name: StartTime + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属Zone ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + BillingType: + description: 计费方式 + enum: + - postpaid + - ' prepaid' + type: string + auto_renew: + default: false + description: 是否自动续费(仅包年包月时生效) + type: boolean + x-go-name: AutoRenew + capacity_mb: + format: int64 + type: integer + x-go-name: CapacityMb + cloudregion_id: + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时间周期 + type: string + x-go-name: Duration + engine: + description: 弹性缓存Engine + enum: + - redis + - ' memcached' + type: string + x-go-name: Engine + engine_version: + description: 弹性缓存Engine版本 + type: string + x-go-name: EngineVersion + 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 + instance_type: + description: 实例规格 + type: string + x-go-name: InstanceType + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + local_category: + type: string + x-go-name: LocalCategory + maintain_start_time: + description: |- + 弹性缓存维护时间段 + 华为云此参数可选,其它云该参数无效 + enum: + - "22:00:00" + - ' 02:00:00' + - ' 06:00:00' + - ' 10:00:00' + - ' 14:00:00' + - ' 18:00:00' + type: string + x-go-name: MaintainStartTime + memory_size_mb: + description: 'swagger: ignore' + format: int64 + type: integer + x-go-name: MemorySizeMb + 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 + network: + description: 'swagger: ignore' + type: string + x-go-name: Network + network_id: + description: Ip子网名称或Id,建议使用Id + type: string + x-go-name: NetworkId + network_type: + description: 网络类型 + enum: + - vpc + - ' cLassic' + type: string + x-go-name: NetworkType + node_type: + type: string + x-go-name: NodeType + password: + description: 初始密码 + type: string + x-go-name: Password + private_ip: + description: |- + 内网IP + 阿里云、华为云此参数可选，其它公有云该参数无效 + type: string + x-go-name: PrivateIp + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + reset_password: + type: boolean + x-go-name: ResetPassword + secgroup_ids: + default: default + description: 安全组名称或Id + items: + type: string + type: array + x-go-name: SecgroupIds + slave_zones: + description: |- + 备可用区名称或Id列表, split by: , + 默认副本与主可用区一致 + 支持此参数的云厂商: 腾讯云 + type: string + x-go-name: SlaveZones + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + zone: + description: 'swagger: ignore' + type: string + x-go-name: Zone + zone_id: + description: 主可用区名称或Id + type: string + x-go-name: ZoneId + required: + - name + - network_id + - network_type + - engine + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + auth_mode: + description: 访问密码？ on （开启密码）|off （免密码访问） + type: string + x-go-name: AuthMode + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + bandwidth: + description: 带宽 + format: int64 + type: integer + x-go-name: Bandwidth + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capacity_mb: + description: 容量 + example: 1024 + format: int64 + type: integer + x-go-name: CapacityMB + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + connections: + description: 最大连接数 + format: int64 + type: integer + x-go-name: Connections + 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 + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + domain_id: + description: 域Id + type: string + x-go-name: DomainId + engine: + description: |- + 后端存储引擎 + Redis | Memcache + example: redis + type: string + x-go-name: Engine + engine_version: + description: 后端存储引擎版本 + example: "4.0" + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 实例规格 + example: redis.master.micro.default + type: string + x-go-name: InstanceType + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + local_category: + description: 对应Sku + type: string + x-go-name: LocalCategory + maintain_end_time: + description: 维护结束时间 + type: string + x-go-name: MaintainEndTime + maintain_start_time: + description: 维护开始时间，格式为HH:mmZ + example: 02:00Z + type: string + x-go-name: MaintainStartTime + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + description: 所属网络ID + type: string + x-go-name: NetworkId + network_type: + description: 网络类型, CLASSIC（经典网络） VPC（专有网络） + example: CLASSIC + type: string + x-go-name: NetworkType + node_type: + description: |- + 类型 + single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | readfive（5只读） + type: string + x-go-name: NodeType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + private_connect_port: + description: 内网访问端口 + format: int64 + type: integer + x-go-name: PrivateConnectPort + private_dns: + description: 内网DNS + type: string + x-go-name: PrivateDNS + private_ip_addr: + description: 内网IP地址 + type: string + x-go-name: PrivateIpAddr + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_connect_port: + description: 外网访问端口 + format: int64 + type: integer + x-go-name: PublicConnectPort + public_dns: + description: 公网DNS + type: string + x-go-name: PublicDNS + public_ip_addr: + description: 公网IP地址 + type: string + x-go-name: PublicIpAddr + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secgroups: + description: 关联安全组列表 + items: + $ref: '#/definitions/StandaloneShortDesc' + type: array + x-go-name: Secgroups + slave_zone_infos: + description: 备可用区列表 + items: + $ref: '#/definitions/StandaloneShortDesc' + type: array + x-go-name: SlaveZoneInfos + slave_zones: + description: 备可用区 + type: string + x-go-name: SlaveZones + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheJointBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheParameterDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + 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 + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存ID + type: string + x-go-name: ElasticcacheId + engine: + description: 引擎 + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + force_restart: + description: True（重启生效） False（无需重启，提交后即生效） + type: boolean + x-go-name: ForceRestart + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + key: + description: Parameter KEY + type: string + x-go-name: Key + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + modifiable: + description: True（可修改） False（不可修改） + type: boolean + x-go-name: Modifiable + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + value: + description: Parameter Value + type: string + x-go-name: Value + value_range: + description: 校验代码，参数的可选范围。 + type: string + x-go-name: ValueRange + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属Zone ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheSecgroupsInput: + properties: + secgroup_ids: + description: |- + 安全组Id列表 + 实例必须处于运行状态 + + + 平台 | 最多绑定安全组数量 | + -------------|------------------- | + 腾讯云 | 10 | + 华为云 | 不支持安全组 | + 阿里云 | 不支持安全组 | + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheSkuDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + cpu_arch: + description: CPU 架构 x86|ARM + type: string + x-go-name: CpuArch + 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 + disk_size_gb: + description: 套餐附带硬盘容量 + format: int64 + type: integer + x-go-name: DiskSizeGB + engine: + description: "引擎\tredis|memcached" + type: string + x-go-name: Engine + engine_arch: + type: string + x-go-name: EngineArch + engine_version: + description: "引擎版本\t3.0" + type: string + x-go-name: EngineVersion + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_spec: + type: string + x-go-name: InstanceSpec + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + local_category: + type: string + x-go-name: LocalCategory + max_clients: + description: 最大客户端数 + format: int64 + type: integer + x-go-name: MaxClients + max_connections: + description: 最大连接数 + format: int64 + type: integer + x-go-name: MaxConnections + max_in_bandwidth_mb: + description: 最大内网带宽 + format: int64 + type: integer + x-go-name: MaxInBandwidthMb + max_memory_mb: + description: 实际可使用的最大内存 + format: int64 + type: integer + x-go-name: MaxMemoryMB + max_replicas_num: + description: 最大副本数量 + format: int64 + type: integer + x-go-name: MaxReplicasNum + max_shard_num: + description: 最大分片数量 + format: int64 + type: integer + x-go-name: MaxShardNum + memory_size_mb: + description: 内存容量 + format: int64 + type: integer + x-go-name: MemorySizeMB + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + node_type: + description: single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | readfive（5只读） + type: string + x-go-name: NodeType + performance_type: + description: standrad|enhanced + type: string + x-go-name: PerformanceType + postpaid_status: + type: string + x-go-name: PostpaidStatus + prepaid_status: + type: string + x-go-name: PrepaidStatus + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: "公有云厂商\tAliyun/Azure/AWS/Qcloud/..." + type: string + x-go-name: Provider + qps: + description: QPS参考值 + format: int64 + type: integer + x-go-name: QPS + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + replicas_num: + description: 最小副本数量 + format: int64 + type: integer + x-go-name: ReplicasNum + shard_num: + description: 最小分片数量 + format: int64 + type: integer + x-go-name: ShardNum + slave_zone: + description: 可用区名称 + example: 北京2区 + type: string + x-go-name: SlaveZone + slave_zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: SlaveZoneExtId + slave_zone_id: + type: string + x-go-name: SlaveZoneId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_type: + description: "存储类型\tDRAM|SCM" + type: string + x-go-name: StorageType + 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 + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcachesecgroupDetails: + 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' + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存实例ID + type: string + x-go-name: ElasticcacheId + secgroup: + description: 安全组名称 + type: string + x-go-name: Secgroup + secgroup_id: + description: 本地安全组ID + type: string + x-go-name: SecgroupId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticipAssociateInput: + properties: + instance_id: + description: 待绑定实例Id + type: string + x-go-name: InstanceId + instance_type: + default: server + description: |- + 实例类型 + enmu: server, natgateway + type: string + x-go-name: InstanceType + ip_addr: + description: EIP映射的内网IP地址，可选 + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticipDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + associate_id: + description: 绑定资源Id + type: string + x-go-name: AssociateId + associate_name: + description: 绑定资源名称 + type: string + x-go-name: AssociateName + associate_type: + description: 绑定资源类型 + type: string + x-go-name: AssociateType + auto_dellocate: + description: 是否跟随主机删除而自动释放 + type: boolean + x-go-name: AutoDellocate + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + bandwidth: + description: 带宽大小 + format: int64 + type: integer + x-go-name: Bandwidth + bgp_type: + description: 线路类型 + type: string + x-go-name: BgpType + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + charge_type: + description: '计费类型: 流量、带宽' + example: bandwidth + type: string + x-go-name: ChargeType + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + mode: + description: |- + 标识弹性或非弹性 + Mode | 说明 | + ------------|------------| + public_ip | 公网IP | + elastic_ip | 弹性公网IP | + example: elastic_ip + type: string + x-go-name: Mode + name: + description: 资源名称 + type: string + x-go-name: Name + network_id: + description: IP子网Id, 仅私有云不为空 + type: string + x-go-name: NetworkId + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + ElasticipRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticipSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + EnabledStatusInfrasResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + EnabledStatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + EnabledStatusStandaloneResourceCreateInput: + 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 + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + ExternalProjectChangeProjectInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ExternalProjectCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudaccount_id: + type: string + x-go-name: CloudaccountId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + manager_id: + type: string + x-go-name: ManagerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ExternalProjectDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudaccount_id: + description: 归属云账号ID + type: string + x-go-name: CloudaccountId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + environment: + description: Environment + type: string + x-go-name: Environment + external_domain_id: + type: string + x-go-name: ExternalDomainId + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + priority: + description: |- + 优先级，同一个本地项目映射多个云上项目，优先级高的优先选择 + 数值越高，优先级越大 + format: int64 + type: integer + x-go-name: Priority + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + FileSystemCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + auto_renew: + default: false + description: 是否自动续费(仅包年包月时生效) + type: boolean + x-go-name: AutoRenew + billing_type: + description: 计费方式 + enum: + - postpaid + - ' prepaid' + type: string + x-go-name: BillingType + capacity: + description: 容量大小 + format: int64 + type: integer + x-go-name: Capacity + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时间周期 + type: string + x-go-name: Duration + expired_at: + description: 到期释放时间，仅后付费支持 + format: date-time + type: string + x-go-name: ExpiredAt + file_system_type: + description: |- + 文件系统类型 + enmu: extreme, standard, cpfs + type: string + x-go-name: FileSystemType + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + manager_id: + description: 订阅Id, 若传入network_id此参数可忽略 + type: string + x-go-name: ManagerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network_id: + description: IP子网Id + type: string + x-go-name: NetworkId + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + protocol: + description: 协议类型 + enum: + - NFS + - ' SMB' + - ' CPFS' + type: string + x-go-name: Protocol + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_type: + description: |- + 存储类型 + enmu: performance, capacity, standard, advance, advance_100, advance_200 + type: string + x-go-name: StorageType + zone_id: + description: 可用区Id, 若不指定IP子网，此参数必填 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + FileSystemDetails: + properties: + Network: + type: string + Vpc: + type: string + Zone: + type: string + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + FileSystemRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + FileSystemSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + Floppy: + properties: + detail: + type: string + x-go-name: Detail + ordinal: + format: int64 + type: integer + x-go-name: Ordinal + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + GetNetworkAddressesOutput: + properties: + addresses: + description: IP子网地址记录 + items: + $ref: '#/definitions/SNetworkUsedAddress' + type: array + x-go-name: Addresses + addresses6: + description: IPv6子网地址记录 + items: + $ref: '#/definitions/SNetworkUsedAddress' + type: array + x-go-name: Addresses6 + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GetNetworkAvailableAddressesOutput: + properties: + addresses: + description: IP子网地址记录 + items: + type: string + type: array + x-go-name: Addresses + addresses6: + description: IPv6子网地址记录 + items: + type: string + type: array + x-go-name: Addresses6 + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GlobalVpcCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GlobalVpcDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc_count: + description: vpc数量 + format: int64 + type: integer + x-go-name: VpcCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GlobalvpcUpdateInput: + 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/compute + GroupAttachNetworkInput: + properties: + alloc_dir: + $ref: '#/definitions/IPAllocationDirection' + ip_addr: + description: candidate IPv4 addr + type: string + x-go-name: IpAddr + ip6_addr: + description: candidate IPv6 addr + type: string + x-go-name: Ip6Addr + network_id: + description: network id or name + type: string + x-go-name: NetworkId + require_designated_ip: + description: Required Designed IP + type: boolean + x-go-name: RequireDesignatedIp + require_ipv6: + description: allocate ipv6 address + type: boolean + x-go-name: RequireIPv6 + reserved: + description: Reserved + type: boolean + x-go-name: Reserved + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GroupDetachNetworkInput: + properties: + ip_addr: + description: candidate IPaddr, can be either IPv4 or IPv6 address + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GroupguestDetails: + properties: + Guest: + type: string + Server: + type: string + 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' + guest_id: + type: string + x-go-name: GuestId + guest_status: + type: string + x-go-name: GuestStatus + instance_group: + description: 主机组的名称 + type: string + x-go-name: Instancegroup + tag: + type: string + x-go-name: Tag + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GroupnetworkDetails: + 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' + eip_addr: + description: EipAddr if eip is associated with this groupnetwork + type: string + x-go-name: EipAddr + eip_id: + type: string + x-go-name: EipId + index: + format: uint8 + type: integer + x-go-name: Index + instance_group: + description: 主机组的名称 + type: string + x-go-name: Instancegroup + ip_addr: + description: IPv4地址 + type: string + x-go-name: IpAddr + ip6_addr: + description: IPv6地址 + type: string + x-go-name: Ip6Addr + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestAddSecgroupInput: + properties: + secgroup_ids: + description: |- + 安全组Id列表 + 实例必须处于运行,休眠或者关机状态 + + + 平台 | 最多绑定安全组数量 | + -------------|------------------- | + Azure | 1 | + VMware | 不支持安全组 | + Baremetal | 不支持安全组 | + ZStack | 1 | + 其他 | 5 | + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestAddSubIpsInput: + properties: + alloc_dir: + $ref: '#/definitions/IPAllocationDirection' + count: + format: int64 + type: integer + x-go-name: Count + index: + format: int64 + type: integer + x-go-name: Index + ip_addr: + type: string + x-go-name: IpAddr + ip6_addr: + type: string + x-go-name: Ip6Addr + mac: + type: string + x-go-name: Mac + reserved: + type: boolean + x-go-name: Reserved + sub_ips: + items: + type: string + type: array + x-go-name: SubIps + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestAutoRenewInput: + properties: + auto_renew: + default: false + description: 设置自动续费 + type: boolean + x-go-name: AutoRenew + duration: + default: 1M + description: 续费周期 + example: 1Y, 1M, 1W + type: string + x-go-name: Duration + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestDiskDetails: + properties: + Disk: + description: 磁盘名称 + type: string + aio_mode: + description: Column(VARCHAR(32, charset='ascii'), nullable=True) + type: string + x-go-name: AioMode + boot_index: + description: Column(TINYINT(4), nullable=False, default=0) + format: uint8 + type: integer + x-go-name: BootIndex + bps: + format: int64 + type: integer + x-go-name: Bps + cache_mode: + description: Column(VARCHAR(32, charset='ascii'), nullable=True) + type: string + x-go-name: CacheMode + 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 + disk_id: + type: string + x-go-name: DiskId + disk_size: + description: 磁盘大小, 单位Mb + example: 10240 + format: int64 + type: integer + x-go-name: DiskSize + disk_type: + description: 磁盘类型 + example: data + type: string + x-go-name: DiskType + driver: + type: string + x-go-name: Driver + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + type: string + x-go-name: GuestId + image_path: + type: string + x-go-name: ImagePath + index: + format: uint8 + type: integer + x-go-name: Index + iops: + description: Column(VARCHAR(32, charset='ascii'), nullable=True) + format: int64 + type: integer + x-go-name: Iops + medium_type: + description: 介质类型 + example: ssd + type: string + x-go-name: MediumType + mountpoint: + type: string + x-go-name: Mountpoint + row_id: + format: int64 + type: integer + x-go-name: RowId + server: + description: 云主机名称 + type: string + x-go-name: Server + status: + description: 磁盘状态 + example: ready + type: string + x-go-name: Status + storage_type: + description: 存储类型 + example: local + type: string + x-go-name: StorageType + 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/compute + GuestDiskInfo: + properties: + aio_mode: + type: string + x-go-name: AioMode + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + bps: + format: int64 + type: integer + x-go-name: Bps + cache_mode: + type: string + x-go-name: CacheMode + disk_format: + type: string + x-go-name: DiskFormat + disk_type: + type: string + x-go-name: DiskType + driver: + type: string + x-go-name: Driver + fs: + type: string + x-go-name: FsFormat + id: + type: string + x-go-name: Id + image: + type: string + x-go-name: Image + image_id: + type: string + x-go-name: ImageId + index: + format: int8 + type: integer + x-go-name: Index + iops: + format: int64 + type: integer + x-go-name: Iops + medium_type: + type: string + x-go-name: MediumType + name: + type: string + x-go-name: Name + preallocation: + type: string + x-go-name: Preallocation + size: + format: int64 + type: integer + x-go-name: SizeMb + storage_id: + type: string + x-go-name: StorageId + storage_type: + type: string + x-go-name: StorageType + title: GuestDiskInfo describe the information of disk on the guest. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestHaveAgentInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestHaveAgentOutput: + properties: + Have: + type: boolean + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestJointBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestJointResourceDetails: + 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' + guest: + description: 云主机名称 + type: string + x-go-name: Guest + server: + description: 云主机名称 + type: string + x-go-name: Server + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestLiveMigrateInput: + properties: + enable_tls: + description: 是否启用 tls + type: boolean + x-go-name: EnableTLS + keep_dest_guest_on_failed: + type: boolean + x-go-name: KeepDestGuestOnFailed + max_bandwidth_mb: + description: 迁移带宽限制 + format: int64 + type: integer + x-go-name: MaxBandwidthMb + prefer_host: + description: 'swagger: ignore' + type: string + x-go-name: PreferHost + prefer_host_id: + description: 指定期望的迁移目标宿主机 + type: string + x-go-name: PreferHostId + quickly_finish: + description: 快速完成，内存同步一定周期后调整 downtime + type: boolean + x-go-name: QuicklyFinish + skip_cpu_check: + description: 是否跳过CPU检查，默认要做CPU检查 + type: boolean + x-go-name: SkipCpuCheck + skip_kernel_check: + description: 是否跳过kernel检查 + type: boolean + x-go-name: SkipKernelCheck + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestMakeSshableCmdOutput: + properties: + ShellCmd: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestMakeSshableInput: + properties: + Password: + type: string + Port: + format: int64 + type: integer + PrivateKey: + type: string + User: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestMakeSshableOutput: + properties: + AnsiblePlaybookId: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestMigrateInput: + properties: + auto_start: + type: boolean + x-go-name: AutoStart + prefer_host: + description: 'swagger: ignore' + type: string + x-go-name: PreferHost + prefer_host_id: + type: string + x-go-name: PreferHostId + rescue_mode: + type: boolean + x-go-name: IsRescueMode + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestPerformStartInput: + properties: + qemu_version: + description: |- + 指定启动虚拟机的Qemu版本，可选值：2.12.1, 4.2.0 + 仅适用于KVM虚拟机 + type: string + x-go-name: QemuVersion + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestPublicipToEipInput: + properties: + auto_start: + default: false + description: 转换完成后是否自动启动 + type: boolean + x-go-name: AutoStart + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestRevokeSecgroupInput: + properties: + secgroup_ids: + description: |- + 安全组Id列表 + 实例必须处于运行,休眠或者关机状态 + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSaveToTemplateInput: + properties: + generate_name: + description: The generate name of guest template + type: string + x-go-name: GenerateName + name: + description: The name of guest template + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSetSecgroupInput: + properties: + secgroup_ids: + description: |- + 安全组Id列表 + 实例必须处于运行,休眠或者关机状态 + + + 平台 | 最多绑定安全组数量 | + -------------|------------------- | + Azure | 1 | + VMware | 不支持安全组 | + Baremetal | 不支持安全组 | + ZStack | 1 | + 其他 | 5 | + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSetSshportInput: + properties: + Port: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSshportOutput: + properties: + Port: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSyncFixNicsInput: + properties: + ip: + description: 需要修正的IP地址列表 + items: + type: string + type: array + x-go-name: Ip + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateConfigInfo: + properties: + disks: + items: + $ref: '#/definitions/GuestTemplateDisk' + type: array + x-go-name: Disks + image: + type: string + x-go-name: Image + isolated_device_config: + items: + $ref: '#/definitions/IsolatedDeviceConfig' + type: array + x-go-name: IsolatedDeviceConfig + keypair: + type: string + x-go-name: Keypair + metadata: + additionalProperties: + type: string + type: object + x-go-name: Metadata + nets: + items: + $ref: '#/definitions/GuestTemplateNetwork' + type: array + x-go-name: Nets + reset_password: + type: boolean + x-go-name: ResetPassword + secgroup: + type: string + x-go-name: Secgroup + sku: + $ref: '#/definitions/GuestTemplateSku' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + billing_type: + type: string + x-go-name: BillingType + cloudregion_id: + type: string + x-go-name: CloudregionId + content: + description: 'description: the content of guest template' + type: object + x-go-name: Content + 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 + hypervisor: + type: string + x-go-name: Hypervisor + image_id: + type: string + x-go-name: ImageId + image_type: + type: string + x-go-name: ImageType + instance_type: + type: string + x-go-name: InstanceType + 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: 'description: indicate the resource is a system resource, which is not visible to user' + 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 + os_type: + type: string + x-go-name: OsType + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vcpu_count: + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size: + format: int64 + type: integer + x-go-name: VmemSize + vpc_id: + type: string + x-go-name: VpcId + required: + - name + - content + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + billing_type: + description: 计费方式 + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + config_info: + $ref: '#/definitions/GuestTemplateConfigInfo' + content: + description: 其他配置信息 + type: object + x-go-name: Content + 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 + environment: + description: Environment + type: string + x-go-name: Environment + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + hypervisor: + description: 虚拟机技术 + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + image_id: + description: 镜像ID + type: string + x-go-name: ImageId + image_type: + description: 镜像类型 + type: string + x-go-name: ImageType + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + 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 + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + os_type: + description: 虚拟机操作系统类型 + pattern: Linux|Windows|VMWare + type: string + x-go-name: OsType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secgroups: + items: + type: string + type: array + x-go-name: Secgroups + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + vcpu_count: + description: 虚拟机CPU数量 + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size: + description: 虚拟机内存大小（MB） + format: int64 + type: integer + x-go-name: VmemSize + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + zone: + type: string + x-go-name: Zone + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateDisk: + properties: + backend: + type: string + x-go-name: Backend + disk_type: + type: string + x-go-name: DiskType + index: + format: int64 + type: integer + x-go-name: Index + size_mb: + format: int64 + type: integer + x-go-name: SizeMb + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateNetwork: + properties: + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_start: + type: string + x-go-name: GuestIpStart + id: + type: string + x-go-name: ID + name: + type: string + x-go-name: Name + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + vpc_id: + type: string + x-go-name: VpcId + vpc_name: + type: string + x-go-name: VpcName + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateSku: + properties: + cpu_core_count: + format: int64 + type: integer + x-go-name: CpuCoreCount + instance_type_category: + type: string + x-go-name: InstanceTypeCategory + instance_type_family: + type: string + x-go-name: InstanceTypeFamily + memory_size_mb: + format: int64 + type: integer + x-go-name: MemorySizeMb + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateUpdateInput: + properties: + billing_type: + type: string + x-go-name: BillingType + cloudregion_id: + type: string + x-go-name: CloudregionId + content: + description: 'description: the content of guest template' + type: object + x-go-name: Content + description: + description: 资源描述 + type: string + x-go-name: Description + hypervisor: + type: string + x-go-name: Hypervisor + image_id: + type: string + x-go-name: ImageId + image_type: + type: string + x-go-name: ImageType + instance_type: + type: string + x-go-name: InstanceType + name: + description: 资源名称 + type: string + x-go-name: Name + os_type: + type: string + x-go-name: OsType + progress: + format: float + type: number + x-go-name: Progress + vcpu_count: + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size: + format: int64 + type: integer + x-go-name: VmemSize + vpc_id: + type: string + x-go-name: VpcId + required: + - content + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestdiskUpdateInput: + properties: + aio_mode: + type: string + x-go-name: AioMode + bps: + format: int64 + type: integer + x-go-name: Bps + cache_mode: + type: string + x-go-name: CacheMode + driver: + type: string + x-go-name: Driver + index: + format: int8 + type: integer + x-go-name: Index + iops: + format: int64 + type: integer + x-go-name: Iops + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestnetworkDetails: + properties: + bw_limit: + description: 带宽限制，单位mbps + format: int64 + type: integer + x-go-name: BwLimit + 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 + driver: + description: 虚拟网卡驱动 + type: string + x-go-name: Driver + eip_addr: + description: EipAddr associate with this guestnetwork + type: string + x-go-name: EipAddr + eip_id: + description: 网卡关联的Eip实例 + type: string + x-go-name: EipId + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + type: string + x-go-name: GuestId + ifname: + description: 虚拟网卡设备名称 + type: string + x-go-name: Ifname + index: + description: 网卡序号 + format: int64 + type: integer + x-go-name: Index + ip_addr: + description: IPv4地址 + type: string + x-go-name: IpAddr + ip6_addr: + description: IPv6地址 + type: string + x-go-name: Ip6Addr + is_default: + description: 是否为缺省路由 + type: boolean + x-go-name: IsDefault + mac_addr: + description: MAC地址 + type: string + x-go-name: MacAddr + mapped_ip_addr: + description: IPv4映射地址，当子网属于私有云vpc的时候分配，用于访问外网 + type: string + x-go-name: MappedIpAddr + network: + description: IP子网名称 + type: string + x-go-name: Network + network_addresses: + items: + $ref: '#/definitions/NetworkAddrConf' + type: array + x-go-name: NetworkAddresses + network_id: + type: string + x-go-name: NetworkId + num_queues: + description: 网卡队列数 + format: int64 + type: integer + x-go-name: NumQueues + row_id: + format: int64 + type: integer + x-go-name: RowId + rx_traffic_limit: + description: 下行流量限制，单位 bytes + format: int64 + type: integer + x-go-name: RxTrafficLimit + rx_traffic_used: + format: int64 + type: integer + x-go-name: RxTrafficUsed + server: + description: 云主机名称 + type: string + x-go-name: Server + team_with: + description: bind配对网卡MAC地址 + type: string + x-go-name: TeamWith + tx_traffic_limit: + description: 上行流量限制，单位 bytes + format: int64 + type: integer + x-go-name: TxTrafficLimit + tx_traffic_used: + format: int64 + type: integer + x-go-name: TxTrafficUsed + 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 + virtual: + description: 是否为虚拟接口（无IP） + type: boolean + x-go-name: Virtual + wire_id: + description: 所属Wire + type: string + x-go-name: WireId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestnetworkShortDesc: + properties: + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + ip6_addr: + description: IPv6地址 + type: string + x-go-name: Ip6Addr + is_exit: + description: |- + 是否为外网网卡 + Deprecated + type: boolean + x-go-name: IsExit + mac: + description: Mac地址 + type: string + x-go-name: Mac + network_id: + description: 所属Network + type: string + x-go-name: NetworkId + sub_ips: + description: 附属IP + type: string + x-go-name: SubIps + team_with: + description: Bonding的配对网卡MAC + type: string + x-go-name: TeamWith + vpc_id: + description: 所属Vpc + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestnetworkUpdateInput: + properties: + bw_limit: + format: int64 + type: integer + x-go-name: BwLimit + driver: + type: string + x-go-name: Driver + index: + format: int8 + type: integer + x-go-name: Index + is_default: + type: boolean + x-go-name: IsDefault + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestsecgroupDetails: + 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 + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + type: string + x-go-name: GuestId + row_id: + format: int64 + type: integer + x-go-name: RowId + secgroup: + description: 安全组名称 + type: string + x-go-name: Secgroup + secgroup_id: + description: 本地安全组ID + type: string + x-go-name: SecgroupId + server: + description: 云主机名称 + type: string + x-go-name: Server + 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/compute + Header: + additionalProperties: + items: + type: string + type: array + description: |- + The keys should be in canonical form, as returned by + CanonicalHeaderKey. + title: A Header represents the key-value pairs in an HTTP header. + type: object + x-go-package: net/http + Host: + description: Host represents an ansible host + properties: + Name: + description: Name denotes the host to operate on + type: string + Vars: + additionalProperties: + type: string + description: Vars is a map recording host vars + type: object + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/ansible + HostAddNetifInput: + properties: + bridge: + type: string + x-go-name: Bridge + index: + format: int64 + type: integer + x-go-name: Index + interface: + type: string + x-go-name: Interface + ip_addr: + type: string + x-go-name: IpAddr + link_up: + type: string + x-go-name: LinkUp + mac: + type: string + x-go-name: Mac + mtu: + format: int16 + type: integer + x-go-name: Mtu + nic_type: + $ref: '#/definitions/TNicType' + rate: + format: int64 + type: integer + x-go-name: Rate + require_designated_ip: + type: boolean + x-go-name: RequireDesignatedIp + reserve: + type: boolean + x-go-name: Reserve + reset: + type: boolean + x-go-name: Reset + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + wire: + description: Deprecated + type: string + x-go-name: Wire + wire_id: + type: string + x-go-name: WireId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostAutoMigrateInput: + properties: + auto_migrate_on_host_down: + type: string + x-go-name: AutoMigrateOnHostDown + auto_migrate_on_host_shutdown: + type: string + x-go-name: AutoMigrateOnHostShutdown + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostBackupstorageCreateInput: + properties: + backupstorage_id: + type: string + x-go-name: BackupstorageId + host_id: + type: string + x-go-name: HostId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostBackupstorageDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + backupstorage: + description: 存储名称 + type: string + x-go-name: Backupstorage + backupstorage_id: + description: 存储Id + type: string + x-go-name: BackupstorageId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capacity_mb: + description: 存储大小 + format: int64 + type: integer + x-go-name: CapacityMb + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + enabled: + description: 是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_enabled: + description: 宿主是否启用 + type: boolean + x-go-name: HostEnabled + host_id: + description: 宿主机Id + type: string + x-go-name: HostId + host_service_status: + description: 宿主机服务状态` + type: string + x-go-name: HostServiceStatus + host_sn: + description: 宿主机序列号 + type: string + x-go-name: HostSN + host_status: + description: 宿主机状态 + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + storage_type: + $ref: '#/definitions/TBackupStorageType' + update_fail_reason: + $ref: '#/definitions/Error' + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + access_ip: + description: 物理机管理口IP + type: string + x-go-name: AccessIp + access_mac: + description: 物理机管理口MAC + type: string + x-go-name: AccessMac + access_net: + description: 物理机管理口IP子网 + type: string + x-go-name: AccessNet + access_wire: + description: 物理机管理口二次网络 + type: string + x-go-name: AccessWire + boot_mode: + description: 主机启动模式, 可能值位PXE和ISO + type: string + x-go-name: BootMode + cpu_architecture: + description: CPU架构 + type: string + x-go-name: CpuArchitecture + cpu_cache: + description: CPU缓存大小,单位KB + type: string + x-go-name: CpuCache + cpu_cmtbound: + description: CPU超分比 + format: float + type: number + x-go-name: CpuCmtbound + cpu_count: + description: CPU核数 + format: int64 + type: integer + x-go-name: CpuCount + cpu_desc: + description: CPU描述信息 + type: string + x-go-name: CpuDesc + cpu_mhz: + description: CPU频率 + format: int64 + type: integer + x-go-name: CpuMhz + cpu_microcode: + description: CPUMicrocode + type: string + x-go-name: CpuMicrocode + cpu_reserved: + description: 预留CPU大小 + format: int64 + type: integer + x-go-name: CpuReserved + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enable_pxe_boot: + description: 是否允许PXE启动 + type: boolean + x-go-name: EnablePxeBoot + 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 + host_type: + description: Host类型 + type: string + x-go-name: HostType + hostname: + description: |- + 主机名 + 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 + 字符长度2-60个字符 + Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 + 若输入为空，则会根据资源名称自动生成主机名 + 输入不为空则会自动剔除不符合规则的字符, 并进行校验 + 若长度大于允许的最大长度，会自动截取 + type: string + x-go-name: Hostname + ipmi_cdrom_boot: + description: Cdrom boot support + type: boolean + x-go-name: IpmiCdromBoot + ipmi_ip_addr: + description: ip address + type: string + x-go-name: IpmiIpAddr + ipmi_lan_channel: + description: lan channel + format: int64 + type: integer + x-go-name: IpmiLanChannel + ipmi_password: + description: password + type: string + x-go-name: IpmiPassword + ipmi_present: + description: presence + type: boolean + x-go-name: IpmiPresent + ipmi_pxe_boot: + description: ipmi_pxe_boot + type: boolean + x-go-name: IpmiPxeBoot + ipmi_redfish_api: + description: Redfish API support + type: boolean + x-go-name: IpmiRedfishApi + ipmi_username: + description: username + type: string + x-go-name: IpmiUsername + ipmi_verified: + description: verified + type: boolean + x-go-name: IpmiVerified + is_baremetal: + description: 是否为裸金属 + type: boolean + x-go-name: IsBaremetal + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_import: + description: 是否为导入的宿主机 + type: boolean + x-go-name: IsImport + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager_uri: + description: 物理机管理URI + type: string + x-go-name: ManagerUri + mem_cmtbound: + description: 内存超分比 + format: float + type: number + x-go-name: MemCmtbound + mem_reserved: + description: 预留内存大小(单位MB) + type: string + x-go-name: MemReserved + mem_size: + description: 内存大小(单位MB) + type: string + x-go-name: MemSize + 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 + no_bmc: + description: 物理机不带 BMC 控制器 + type: boolean + x-go-name: NoBMC + no_probe: + description: 新建带IPMI信息的物理机时不进行IPMI信息探测 + type: boolean + x-go-name: NoProbe + node_count: + description: 物理CPU颗数 + format: int8 + type: integer + x-go-name: NodeCount + ovn_version: + description: OVN软件版本 + type: string + x-go-name: OvnVersion + page_size_kb: + description: 页大小 + format: int64 + type: integer + x-go-name: PageSizeKB + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + rack: + description: 机架 + type: string + x-go-name: Rack + slots: + description: 机位 + type: string + x-go-name: Slots + sn: + description: 物理机序列号信息 + type: string + x-go-name: SN + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_driver: + description: 存储驱动类型 + type: string + x-go-name: StorageDriver + storage_info: + description: 存储详情 + type: object + x-go-name: StorageInfo + storage_size: + description: 存储大小,单位Mb + format: int64 + type: integer + x-go-name: StorageSize + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + sys_info: + description: 系统信息 + type: object + x-go-name: SysInfo + uuid: + description: host uuid + type: string + x-go-name: Uuid + version: + description: host服务软件版本 + type: string + x-go-name: Version + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostDetails: + properties: + IsolatedDeviceCount: + description: isolated device count + format: int64 + type: integer + access_ip: + description: 管理口Ip地址 + type: string + x-go-name: AccessIp + access_mac: + description: 管理口MAC + type: string + x-go-name: AccessMac + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + actual_storage_used: + description: 实际已使用存储大小 + format: int64 + type: integer + x-go-name: ActualStorageUsed + allow_health_check: + description: 允许开启宿主机健康检查 + type: boolean + x-go-name: AllowHealthCheck + auto_migrate_on_host_down: + type: boolean + x-go-name: AutoMigrateOnHostDown + auto_migrate_on_host_shutdown: + type: boolean + x-go-name: AutoMigrateOnHostShutdown + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + backup_guests: + description: 主备云主机数量 + example: 10 + format: int64 + type: integer + x-go-name: BackupGuests + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + boot_mode: + description: 主机启动模式, 可能值为PXE和ISO + type: string + x-go-name: BootMode + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_prepare: + type: boolean + x-go-name: CanPrepare + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + cpu_architecture: + description: CPU架构 + type: string + x-go-name: CpuArchitecture + cpu_cache: + description: CPU缓存大小,单位KB + format: int64 + type: integer + x-go-name: CpuCache + cpu_cmtbound: + description: CPU超分比 + format: float + type: number + x-go-name: CpuCmtbound + cpu_commit: + description: CPU超分比 + format: int64 + type: integer + x-go-name: CpuCommit + cpu_commit_bound: + description: CPU超售比 + format: float + type: number + x-go-name: CpuCommitBound + cpu_commit_rate: + description: CPU超分率 + format: double + type: number + x-go-name: CpuCommitRate + cpu_count: + description: CPU核数 + format: int64 + type: integer + x-go-name: CpuCount + cpu_desc: + description: CPU描述信息 + type: string + x-go-name: CpuDesc + cpu_mhz: + description: CPU频率 + format: int64 + type: integer + x-go-name: CpuMhz + cpu_microcode: + description: CPUMicrocode + type: string + x-go-name: CpuMicrocode + cpu_reserved: + description: 预留CPU大小 + format: int64 + type: integer + x-go-name: CpuReserved + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enable_health_check: + description: health check enabled by host agent online + type: boolean + x-go-name: EnableHealthCheck + enable_numa_allocate: + type: boolean + x-go-name: EnableNumaAllocate + enable_pxe_boot: + description: 是否允许PXE启动 + type: boolean + x-go-name: EnablePxeBoot + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + guests: + description: 云主机数量 + example: 10 + format: int64 + type: integer + x-go-name: Guests + host_status: + description: 宿主机状态 + example: online + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + hostname: + type: string + x-go-name: Hostname + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + ipmi_info: + description: IPMI详情 + type: object + x-go-name: IpmiInfo + ipmi_ip: + description: IPMI地址 + type: string + x-go-name: IpmiIp + is_baremetal: + type: boolean + x-go-name: IsBaremetal + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_import: + description: 是否为导入的宿主机 + type: boolean + x-go-name: IsImport + is_maintenance: + description: 是否处于维护状态 + type: boolean + x-go-name: IsMaintenance + is_prepaid_recycle: + type: boolean + x-go-name: IsPrepaidRecycle + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + manager_uri: + description: 管理地址 + type: string + x-go-name: ManagerUri + mem_cmtbound: + description: 内存超分比 + format: float + type: number + x-go-name: MemCmtbound + mem_commit: + description: 内存超分比 + format: int64 + type: integer + x-go-name: MemCommit + mem_commit_bound: + description: 内存超售比 + format: float + type: number + x-go-name: MemCommitBound + mem_commit_rate: + description: 内存超分率 + format: double + type: number + x-go-name: MemCommitRate + mem_reserved: + description: 预留内存大小 + format: int64 + type: integer + x-go-name: MemReserved + mem_size: + description: 内存大小,单位Mb + format: int64 + type: integer + x-go-name: MemSize + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nic_count: + description: 网卡数量 + format: int64 + type: integer + x-go-name: NicCount + nic_info: + description: 网卡详情 + items: + $ref: '#/definitions/SNic' + type: array + x-go-name: NicInfo + node_count: + description: 物理CPU颗数 + format: uint8 + type: integer + x-go-name: NodeCount + nonsystem_guests: + description: 非系统云主机数量 + example: 0 + format: int64 + type: integer + x-go-name: NonsystemGuests + other_guests: + description: 其他状态云主机数量 + example: 2 + format: int64 + type: integer + x-go-name: OtherGuests + ovn_mapped_ip_addr: + description: IPv4地址，作为私有云vpc访问外网时的网关 + type: string + x-go-name: OvnMappedIpAddr + ovn_version: + description: OVN软件版本 + type: string + x-go-name: OvnVersion + page_size_kb: + description: 页大小 + format: int64 + type: integer + x-go-name: PageSizeKB + pending_deleted_guests: + description: 回收站中云主机数量 + example: 2 + format: int64 + type: integer + x-go-name: PendingDeletedGuests + prepare_fail_reason: + type: string + x-go-name: PrepareFailReason + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + rack: + description: 机架 + type: string + x-go-name: Rack + ready_guests: + description: 关机状态云主机数量 + example: 2 + format: int64 + type: integer + x-go-name: ReadyGuests + real_external_id: + type: string + x-go-name: RealExternalId + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + reserved_resource_for_gpu: + $ref: '#/definitions/IsolatedDeviceReservedResourceInput' + resource_type: + type: string + x-go-name: ResourceType + running_guests: + description: 运行状态云主机数量 + example: 2 + format: int64 + type: integer + x-go-name: RunningGuests + schedtags: + items: + $ref: '#/definitions/SchedtagShortDescDetails' + type: array + x-go-name: Schedtags + server: + type: string + x-go-name: Server + server_id: + type: string + x-go-name: ServerId + server_ips: + type: string + x-go-name: ServerIps + server_pending_deleted: + type: boolean + x-go-name: ServerPendingDeleted + 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 + slots: + description: 机位 + type: string + x-go-name: Slots + sn: + description: 物理机序列号信息 + type: string + x-go-name: SN + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + spec: + type: object + x-go-name: Spec + status: + description: 资源状态 + type: string + x-go-name: Status + storage: + description: 存储大小 + format: int64 + type: integer + x-go-name: Storage + storage_commit_rate: + description: 存储超分率 + format: double + type: number + x-go-name: StorageCommitRate + storage_driver: + description: 存储驱动类型 + type: string + x-go-name: StorageDriver + storage_free: + description: 可用存储大小 + format: int64 + type: integer + x-go-name: StorageFree + storage_info: + description: 存储详情 + type: object + x-go-name: StorageInfo + storage_size: + description: 存储大小,单位Mb + format: int64 + type: integer + x-go-name: StorageSize + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + storage_used: + description: 已使用存储大小 + format: int64 + type: integer + x-go-name: StorageUsed + storage_virtual: + description: 虚拟存储大小 + format: int64 + type: integer + x-go-name: StorageVirtual + storage_waste: + description: 浪费存储大小(异常磁盘存储大小) + format: int64 + type: integer + x-go-name: StorageWaste + sys_error: + description: host init error info + type: string + x-go-name: SysError + sys_info: + description: 系统信息 + type: object + x-go-name: SysInfo + sys_warn: + description: host init warnning + type: string + x-go-name: SysWarn + uefi_info: + description: UEFI详情 + type: object + x-go-name: UefiInfo + 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 + uuid: + description: 主机UUID + type: string + x-go-name: Uuid + version: + description: host服务软件版本 + type: string + x-go-name: Version + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostDisableNetifInput: + properties: + mac: + type: string + x-go-name: Mac + reserve: + type: boolean + x-go-name: Reserve + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostEnableNetifInput: + properties: + alloc_dir: + type: string + x-go-name: AllocDir + ip_addr: + type: string + x-go-name: IpAddr + mac: + type: string + x-go-name: Mac + net_type: + type: string + x-go-name: NetType + network: + description: Deprecated + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + require_designated_ip: + type: boolean + x-go-name: RequireDesignatedIp + reserve: + type: boolean + x-go-name: Reserve + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostIsolatedDeviceModelDetails: + properties: + DevType: + type: string + DeviceId: + type: string + DisableAutoDetect: + type: boolean + HotPluggable: + type: boolean + Model: + type: string + VendorId: + type: string + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_enabled: + description: 宿主是否启用 + type: boolean + x-go-name: HostEnabled + host_id: + description: 宿主机Id + type: string + x-go-name: HostId + host_service_status: + description: 宿主机服务状态` + type: string + x-go-name: HostServiceStatus + host_sn: + description: 宿主机序列号 + type: string + x-go-name: HostSN + host_status: + description: 宿主机状态 + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + isolated_device_model_id: + description: 存储Id + type: string + x-go-name: IsolatedDeviceModelId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostLoginInfoInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostLoginInfoOutput: + properties: + ip: + type: string + x-go-name: Ip + password: + type: string + x-go-name: Password + username: + type: string + x-go-name: Username + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostOfflineInput: + properties: + Reason: + type: string + update_health_status: + type: boolean + x-go-name: UpdateHealthStatus + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostPerformStartInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostRemoveNetifInput: + properties: + mac: + type: string + x-go-name: Mac + reserve: + type: boolean + x-go-name: Reserve + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostReserveCpusInput: + properties: + Cpus: + type: string + Mems: + type: string + disable_sched_load_balance: + type: boolean + x-go-name: DisableSchedLoadBalance + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostStorageCreateInput: + properties: + host_id: + type: string + x-go-name: HostId + mount_point: + type: string + x-go-name: MountPoint + storage_id: + type: string + x-go-name: StorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostTopologyOutput: + properties: + host_status: + type: string + x-go-name: HostStatus + host_type: + type: string + x-go-name: HostType + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + networks: + items: + $ref: '#/definitions/HostnetworkTopologyOutput' + type: array + x-go-name: Networks + schedtags: + items: + $ref: '#/definitions/SchedtagShortDescDetails' + type: array + x-go-name: Schedtags + status: + type: string + x-go-name: Status + storages: + items: + $ref: '#/definitions/StorageShortDesc' + type: array + x-go-name: Storages + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostUpdateInput: + properties: + access_ip: + description: 物理机管理口IP + type: string + x-go-name: AccessIp + access_mac: + description: 物理机管理口MAC + type: string + x-go-name: AccessMac + access_net: + description: 物理机管理口IP子网 + type: string + x-go-name: AccessNet + access_wire: + description: 物理机管理口二次网络 + type: string + x-go-name: AccessWire + boot_mode: + description: 主机启动模式, 可能值位PXE和ISO + type: string + x-go-name: BootMode + cpu_architecture: + description: CPU架构 + type: string + x-go-name: CpuArchitecture + cpu_cache: + description: CPU缓存大小,单位KB + type: string + x-go-name: CpuCache + cpu_cmtbound: + description: CPU超分比 + format: float + type: number + x-go-name: CpuCmtbound + cpu_count: + description: CPU核数 + format: int64 + type: integer + x-go-name: CpuCount + cpu_desc: + description: CPU描述信息 + type: string + x-go-name: CpuDesc + cpu_mhz: + description: CPU频率 + format: int64 + type: integer + x-go-name: CpuMhz + cpu_microcode: + description: CPUMicrocode + type: string + x-go-name: CpuMicrocode + cpu_reserved: + description: 预留CPU大小 + format: int64 + type: integer + x-go-name: CpuReserved + description: + description: 资源描述 + type: string + x-go-name: Description + enable_numa_allocate: + type: boolean + x-go-name: EnableNumaAllocate + enable_pxe_boot: + description: 是否允许PXE启动 + type: boolean + x-go-name: EnablePxeBoot + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + hostname: + description: |- + 主机名 + 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 + 字符长度2-60个字符 + Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 + 若输入为空，则会根据资源名称自动生成主机名 + 输入不为空则会自动剔除不符合规则的字符, 并进行校验 + 若长度大于允许的最大长度，会自动截取 + type: string + x-go-name: Hostname + ipmi_cdrom_boot: + description: Cdrom boot support + type: boolean + x-go-name: IpmiCdromBoot + ipmi_info: + description: IPMI info + type: object + x-go-name: IpmiInfo + ipmi_ip_addr: + description: ip address + type: string + x-go-name: IpmiIpAddr + ipmi_lan_channel: + description: lan channel + format: int64 + type: integer + x-go-name: IpmiLanChannel + ipmi_password: + description: password + type: string + x-go-name: IpmiPassword + ipmi_present: + description: presence + type: boolean + x-go-name: IpmiPresent + ipmi_pxe_boot: + description: ipmi_pxe_boot + type: boolean + x-go-name: IpmiPxeBoot + ipmi_redfish_api: + description: Redfish API support + type: boolean + x-go-name: IpmiRedfishApi + ipmi_username: + description: username + type: string + x-go-name: IpmiUsername + ipmi_verified: + description: verified + type: boolean + x-go-name: IpmiVerified + is_baremetal: + description: 是否为裸金属 + type: boolean + x-go-name: IsBaremetal + manager_uri: + description: 物理机管理URI + type: string + x-go-name: ManagerUri + mem_cmtbound: + description: 内存超分比 + format: float + type: number + x-go-name: MemCmtbound + mem_reserved: + description: 预留内存大小(单位MB) + type: string + x-go-name: MemReserved + mem_size: + description: 内存大小(单位MB) + type: string + x-go-name: MemSize + name: + description: 资源名称 + type: string + x-go-name: Name + node_count: + description: 物理CPU颗数 + format: int8 + type: integer + x-go-name: NodeCount + ovn_version: + description: OVN软件版本 + type: string + x-go-name: OvnVersion + page_size_kb: + description: 页大小 + format: int64 + type: integer + x-go-name: PageSizeKB + rack: + description: 机架 + type: string + x-go-name: Rack + slots: + description: 机位 + type: string + x-go-name: Slots + sn: + description: 物理机序列号信息 + type: string + x-go-name: SN + storage_driver: + description: 存储驱动类型 + type: string + x-go-name: StorageDriver + storage_info: + description: 存储详情 + type: object + x-go-name: StorageInfo + storage_size: + description: 存储大小,单位Mb + format: int64 + type: integer + x-go-name: StorageSize + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + sys_info: + description: 系统信息 + type: object + x-go-name: SysInfo + uuid: + description: 主机UUID + type: string + x-go-name: Uuid + version: + description: host服务软件版本 + type: string + x-go-name: Version + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostnetworkDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + baremetal_id: + description: 宿主机ID + type: string + x-go-name: BaremetalId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_enabled: + description: 宿主是否启用 + type: boolean + x-go-name: HostEnabled + host_service_status: + description: 宿主机服务状态` + type: string + x-go-name: HostServiceStatus + host_sn: + description: 宿主机序列号 + type: string + x-go-name: HostSN + host_status: + description: 宿主机状态 + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + mac_addr: + description: MAC地址 + type: string + x-go-name: MacAddr + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + description: 网络ID + type: string + x-go-name: NetworkId + nic_type: + $ref: '#/definitions/TNicType' + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + vlan_id: + description: VLAN + format: int64 + type: integer + x-go-name: VlanId + wire: + description: 二层网络名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostnetworkTopologyOutput: + properties: + ip_addr: + type: string + x-go-name: IpAddr + mac_addr: + type: string + x-go-name: MacAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HoststorageDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capacity: + description: 存储大小 + format: int64 + type: integer + x-go-name: Capacity + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + cmtbound: + description: 超售比 + format: float + type: number + x-go-name: Cmtbound + config: + description: 配置信息 + type: object + x-go-name: Config + delete_fail_reason: + $ref: '#/definitions/Error' + enabled: + description: 是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + free_capacity: + description: 可用存储大小 + format: int64 + type: integer + x-go-name: FreeCapacity + guest_disk_count: + format: int64 + type: integer + x-go-name: GuestDiskCount + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_enabled: + description: 宿主是否启用 + type: boolean + x-go-name: HostEnabled + host_id: + description: 宿主机Id + type: string + x-go-name: HostId + host_service_status: + description: 宿主机服务状态` + type: string + x-go-name: HostServiceStatus + host_sn: + description: 宿主机序列号 + type: string + x-go-name: HostSN + host_status: + description: 宿主机状态 + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + imagecache_path: + description: 镜像缓存路径 + type: string + x-go-name: ImagecachePath + is_root_partition: + description: 是否是根分区 + type: boolean + x-go-name: IsRootPartition + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + medium_type: + description: 介质类型 + example: ssd + type: string + x-go-name: MediumType + mount_point: + description: |- + 挂载点 + nvme pci address + type: string + x-go-name: MountPoint + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + real_capacity: + description: 真实容量大小 + format: int64 + type: integer + x-go-name: RealCapacity + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + storage: + description: 存储名称 + type: string + x-go-name: Storage + storage_conf: + description: 存储配置信息 + type: object + x-go-name: StorageConf + storage_id: + description: 存储Id + type: string + x-go-name: StorageId + storage_type: + description: 存储类型 + example: local + type: string + x-go-name: StorageType + storagecache_id: + description: 存储缓存Id + type: string + x-go-name: StoragecacheId + update_fail_reason: + $ref: '#/definitions/Error' + used_capacity: + description: 已使用存储大小 + format: int64 + type: integer + x-go-name: UsedCapacity + waste_capacity: + description: 浪费存储大小(异常磁盘总大小) + format: int64 + type: integer + x-go-name: WasteCapacity + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IPAllocationDirection: type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IPv6GatewayCreateInput: + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IPv6GatewayDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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 + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IPv6GatewayUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IdNameDetails: + 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 + ImagePullPolicy: type: string - x-go-name: RegionId - source: - description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + x-go-package: yunion.io/x/onecloud/pkg/apis + InstanceBackupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + backup_storage_name: + description: 存储类型 + type: string + x-go-name: BackupStorageName + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + delete_fail_reason: + $ref: '#/definitions/Error' + disk_backups: + description: 硬盘备份详情 + items: + $ref: '#/definitions/SSimpleBackup' + type: array + x-go-name: DiskBackups + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_status: + description: 云主机状态 + type: string + x-go-name: GuestStatus + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + size: + description: 主机快照大小 + format: int64 + type: integer + x-go-name: Size + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceBackupManagerCreateFromPackageInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + BackupStorageId: + type: string + PackageName: + type: string + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceBackupManagerSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceBackupPackInput: + properties: + PackageName: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceBackupRecoveryInput: + properties: + Name: + description: 'description: name of guest' + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceGroupDetail: + 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 + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + force_dispersion: + type: boolean + x-go-name: ForceDispersion + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + granularity: + description: the upper limit number of guests with this group in a host + format: int64 + type: integer + x-go-name: Granularity + guest_count: + description: 云主机数量 + format: int64 + type: integer + x-go-name: GuestCount + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + 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 + network: + description: Attached Network + type: string + x-go-name: Network + network_id: + description: Attached NetworkId + type: string + x-go-name: NetworkId + parent_id: + type: string + x-go-name: ParentId + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + sched_strategy: + description: 调度策略 + type: string + x-go-name: SchedStrategy + service_type: + description: 服务类型 + type: string + x-go-name: ServiceType + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + vip_eip: + description: EIP of VIP + type: string + x-go-name: VipEip + vips: + description: VIP + items: + type: string + type: array + x-go-name: Vips + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceSnapshotDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + auto_delete: + description: 是否自动删除 + type: boolean + x-go-name: AutoDelete + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + description: 云主机Id + type: string + x-go-name: GuestId + guest_status: + description: 云主机状态 + type: string + x-go-name: GuestStatus + id: + description: 资源UUID + type: string + x-go-name: Id + image_id: + description: 镜像ID + type: string + x-go-name: ImageId + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + type: string + x-go-name: InstanceType + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + keypair_id: + description: 秘钥Id + type: string + x-go-name: KeypairId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + memory_file_checksum: + description: 内存文件校验和 + type: string + x-go-name: MemoryFileChecksum + memory_file_host_id: + description: 内存文件所在宿主机 + type: string + x-go-name: MemoryFileHostId + memory_file_path: + description: 内存文件路径 + type: string + x-go-name: MemoryFilePath + memory_size_mb: + description: 内存文件大小 + format: int64 + type: integer + x-go-name: MemorySizeMB + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + os_type: + description: 操作系统类型 + type: string + x-go-name: OsType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + properties: + additionalProperties: + type: string + type: object + x-go-name: Properties + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + ref_count: + description: 引用次数 + format: int64 + type: integer + x-go-name: RefCount + sec_groups: + description: 安全组 + type: object + x-go-name: SecGroups + server_config: + description: 云主机配置 + type: object + x-go-name: ServerConfig + server_metadata: + description: 云主机标签 + type: object + x-go-name: ServerMetadata + size: + description: 主机快照大小 + format: int64 + type: integer + x-go-name: Size + size_mb: + description: 主机快照磁盘容量和 + format: int64 + type: integer + x-go-name: SizeMb + snapshots: + description: 快照列表 + items: + $ref: '#/definitions/SimpleSnapshot' + type: array + x-go-name: Snapshots + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + with_memory: + description: 是否保存内存 + type: boolean + x-go-name: WithMemory + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkAddVpcInput: + properties: + vpc_id: + description: |- + 待加入的vpc id + vpc和当前vpc互联所必须是同一平台，且运营平台一致，例如aws中国区不能和aws国际区运营平台不一致 + 可以通过 /vpcs?usable_for_inter_vpc_network_id=<当前vpc互联id> 过滤可以加入的vpc列表 + type: string + x-go-name: VpcId + required: + - vpc_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkCreateInput: + 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 + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager_id: + type: string + x-go-name: ManagerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + 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' + vpc_count: + format: int64 + type: integer + x-go-name: VpcCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkRemoveVpcInput: + properties: + VpcId: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkRouteSetDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkRouteSetDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkRouteSetEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolateDeviceDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + addr: + description: '# pci address of `Bus:Device.Function` format, or usb bus address of `bus.addr`' + type: string + x-go-name: Addr + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + 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 + dev_type: + description: |- + # PCI / GPU-HPC / GPU-VGA / USB / NIC + 设备类型 + type: string + x-go-name: DevType + device_path: + type: string + x-go-name: DevicePath + disk_index: + description: guest disk index + format: uint8 + type: integer + x-go-name: DiskIndex + environment: + description: Environment + type: string + x-go-name: Environment + framebuffer: + description: The frame buffer size in Mbytes + type: string + x-go-name: Framebuffer + frl: + description: The frame rate limiter (FRL) configuration in frames per second + type: string + x-go-name: FRL + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + description: 云主机Id + type: string + x-go-name: GuestId + guest_status: + description: 云主机状态 + type: string + x-go-name: GuestStatus + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_enabled: + description: 宿主是否启用 + type: boolean + x-go-name: HostEnabled + host_id: + type: string + x-go-name: HostId + host_service_status: + description: 宿主机服务状态` + type: string + x-go-name: HostServiceStatus + host_sn: + description: 宿主机序列号 + type: string + x-go-name: HostSN + host_status: + description: 宿主机状态 + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_infiniband_nic: + description: Is infiniband nic + type: boolean + x-go-name: IsInfinibandNic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + max_instance: + description: The maximum number of vGPU instances per physical GPU + type: string + x-go-name: MaxInstance + max_resolution: + description: 'The maximum resolution per display head, eg: 5120x2880' + type: string + x-go-name: MaxResolution + mdev_id: + default: '"false" list:"domain" create:"domain_optional"`' + description: Is vgpu physical funcion, That means it cannot be attached to guest + type: string + x-go-name: MdevId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + model: + description: '# Specific device name read from lspci command, e.g. `Tesla K40m` ...' + type: string + x-go-name: Model + name: + description: 资源名称 + type: string + x-go-name: Name + network_index: + description: guest network index + format: int64 + type: integer + x-go-name: NetworkIndex + num_heads: + description: |- + The maximum number of virtual display heads that the vGPU type supports + In computer graphics and display technology, the term "head" is commonly used to + describe the physical interface of a display device or display output. + It refers to a connection point on the monitor, such as HDMI, DisplayPort, or VGA interface. + type: string + x-go-name: NumHeads + numa_node: + description: device numa node + format: uint8 + type: integer + x-go-name: NumaNode + nvme_size_mb: + description: NVME disk size + format: int64 + type: integer + x-go-name: NvmeSizeMB + ovs_offload_interface: + description: Offload interface name + type: string + x-go-name: OvsOffloadInterface + pcie_info: + $ref: '#/definitions/IsolatedDevicePCIEInfo' + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + reserved_cpu: + description: reserved cpu count for isolated device + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: reserved memory size for isolated device + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: reserved storage size for isolated device + format: int64 + type: integer + x-go-name: ReservedStorage + 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 + vendor_device_id: + type: string + x-go-name: VendorDeviceId + wire_id: + description: Nic wire id + type: string + x-go-name: WireId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceConfig: + properties: + dev_type: + type: string + x-go-name: DevType + device_path: + type: string + x-go-name: DevicePath + disk_index: + format: int8 + type: integer + x-go-name: DiskIndex + id: + type: string + x-go-name: Id + index: + format: int64 + type: integer + x-go-name: Index + model: + type: string + x-go-name: Model + network_index: + format: int64 + type: integer + x-go-name: NetworkIndex + vendor: + type: string + x-go-name: Vendor + wire_id: + type: string + x-go-name: WireId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + addr: + description: |- + PCI地址 + # pci address of `Bus:Device.Function` format, or usb bus address of `bus.addr` + type: string + x-go-name: Addr + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dev_type: + description: 设备类型USB/GPU + example: GPU + type: string + x-go-name: DevType + device_path: + description: Host device path + type: string + x-go-name: DevicePath + 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 + host_id: + description: 宿主机或物理机（ID或Name） + type: string + x-go-name: HostId + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + mdev_id: + description: legacy vgpu mdev id + type: string + x-go-name: MdevId + model: + description: |- + 设备型号 + # Specific device name read from lspci command, e.g. `Tesla K40m` ... + type: string + x-go-name: Model + 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 + pcie_info: + $ref: '#/definitions/IsolatedDevicePCIEInfo' + reserved_cpu: + description: GPU 预留CPU + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: GPU 预留内存 + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: GPU 预留磁盘 + format: int64 + type: integer + x-go-name: ReservedStorage + vendor_device_id: + description: 设备VendorId + type: string + x-go-name: VendorDeviceId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceModelCreateInput: + 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 + dev_type: + description: 设备类型 + example: NPU + type: string + x-go-name: DevType + device_id: + description: 设备DeviceId + type: string + x-go-name: DeviceId + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + hosts: + description: hosts scan isolated device after isolated_device_model created + items: + type: string + type: array + x-go-name: Hosts + hot_pluggable: + description: 支持热插拔 HotPluggable + type: boolean + x-go-name: HotPluggable + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + model: + description: 设备型号 + type: string + x-go-name: Model + vendor_id: + description: 设备VendorId + type: string + x-go-name: VendorId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceModelHardwareInfo: + properties: + bandwidth: + description: GPU bandwidth. The unit is GB/s + format: double + type: number + x-go-name: Bandwidth + memory_mb: + description: GPU memory size + format: int64 + type: integer + x-go-name: MemoryMB + tflops: + description: TFLOPS stands for number of floating point operations per second. + format: double + type: number + x-go-name: TFLOPS + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceModelUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + dev_type: + description: 设备类型 + example: NPU + type: string + x-go-name: DevType + device_id: + description: 设备DeviceId + type: string + x-go-name: DeviceId + hot_pluggable: + description: 支持热插拔 HotPluggable + type: boolean + x-go-name: HotPluggable + model: + description: 设备型号 + type: string + x-go-name: Model + vendor_id: + description: 设备VendorId + type: string + x-go-name: VendorId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDevicePCIEInfo: + properties: + lane_width: + description: Lane width + format: int64 + type: integer + x-go-name: LaneWidth + throughput: + description: |- + Throughput indicates the unencoded bandwidth (without 8b/10b, 128b/130b, or 242B/256B encoding overhead). + The PCIe 1.0 transfer rate of 2.5 GT/s per lane means a 2.5 Gbit/s serial bit rate corresponding to a throughput of 2.0 Gbit/s or 250 MB/s prior to 8b/10b encoding. + type: string + x-go-name: Throughput + transfer_rate_per_lane: + description: |- + Transder rate per lane + Transfer rate refers to the encoded serial bit rate; 2.5 GT/s means 2.5 Gbit/s serial data rate. + type: string + x-go-name: TransferRatePerLane + version: + description: Version is the PCIE version + type: string + x-go-name: Version + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceReservedResourceInput: + properties: + reserved_cpu: + description: GPU 预留CPU + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: GPU 预留内存 + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: GPU 预留磁盘 + format: int64 + type: integer + x-go-name: ReservedStorage + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + dev_type: + type: string + x-go-name: DevType + device_path: + description: Host device path + type: string + x-go-name: DevicePath + name: + description: 资源名称 + type: string + x-go-name: Name + pcie_info: + $ref: '#/definitions/IsolatedDevicePCIEInfo' + reserved_cpu: + description: GPU 预留CPU + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: GPU 预留内存 + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: GPU 预留磁盘 + format: int64 + type: integer + x-go-name: ReservedStorage + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + JoinResourceBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseDetails: + 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 + JointResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + KafkaCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KafkaDetails: + description: 资源返回详情 + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + bandwidth_mb: + description: 带宽峰值 + example: 1024 + format: int64 + type: integer + x-go-name: BandwidthMb + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + disk_size_gb: + description: 存储大小 + example: 1024 + format: int64 + type: integer + x-go-name: DiskSizeGb + domain_id: + description: 域Id + type: string + x-go-name: DomainId + endpoint: + description: 连接端点 + type: string + x-go-name: Endpoint + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + example: elasticsearch.sn2ne.xlarge + type: string + x-go-name: InstanceType + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_multi_az: + description: 是否是多可用区部署 + type: boolean + x-go-name: IsMultiAz + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + msg_retention_minute: + description: 消息保留时长 + format: int64 + type: integer + x-go-name: MsgRetentionMinute + name: + description: 资源名称 + type: string + x-go-name: Name + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_type: + description: 存储类型 + example: local_ssd + type: string + x-go-name: StorageType + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + version: + description: 版本 + type: string + x-go-name: Version + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区Id + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KeypairCreateInput: + 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 + owner_id: + description: 本地用户Id，若为空则使用当前用户Id作为此参数值 + type: string + x-go-name: OwnerId + public_key: + description: 公钥内容,若为空则自动生成公钥 + type: string + x-go-name: PublicKey + scheme: + default: RSA + description: 秘钥类型 + enum: + - RSA + type: string + x-go-name: Scheme + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KeypairDetails: + 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 + fingerprint: + description: 指纹信息 + example: 1d:3a:83:4a:a1:f3:75:97:ec:d1:ef:f8:3f:a7:5d:9e + type: string + x-go-name: Fingerprint + 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 + linked_guest_count: + description: 关联云主机次数 + format: int64 + type: integer + x-go-name: LinkedGuestCount + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + owner_id: + description: 本地用户Id + type: string + x-go-name: OwnerId + owner_name: + description: 用户名称 + type: string + x-go-name: OwnerName + private_key: + description: 私钥 + type: string + x-go-name: PrivateKey + private_key_len: + description: 私钥长度 + format: int64 + type: integer + x-go-name: PrivateKeyLen + public_key: + description: 公钥 + type: string + x-go-name: PublicKey + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + scheme: + description: 加密类型 + example: RSA + type: string + x-go-name: Scheme + 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/compute + KubeClusterCreateInput: + 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 + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + 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 + network_ids: + $ref: '#/definitions/SKubeNetworkIds' + private_access: + type: boolean + x-go-name: PrivateAccess + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_access: + type: boolean + x-go-name: PublicAccess + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + role_name: + type: string + x-go-name: RoleName + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + version: + type: string + x-go-name: Version + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + required: + - name + - network_ids + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeClusterDeleteInput: + properties: + retain: + default: false + description: 是否保留集群关联的实例及slb + type: boolean + x-go-name: Retain + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeClusterDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_cluster_id: + description: 本地KubeserverId + type: string + x-go-name: ExternalClusterId + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network_ids: + $ref: '#/definitions/SKubeNetworkIds' + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + version: + type: string + x-go-name: Version + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeClusterUpdateInput: + 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/compute + KubeNodeCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodeDetails: + properties: + DomainId: + type: string + 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 + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + 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' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodePoolCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloud_kube_cluster_id: + type: string + x-go-name: CloudKubeClusterId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + desired_instance_count: + default: 2 + description: 预期节点数量, 不得小于min_instance_count + format: int64 + type: integer + x-go-name: DesiredInstanceCount + 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 + instance_types: + $ref: '#/definitions/SInstanceTypes' + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + keypair_id: + description: 秘钥id，若不传，则使用系统级秘钥 + type: string + x-go-name: KeypairId + max_instance_count: + default: 2 + format: int64 + type: integer + x-go-name: MaxInstanceCount + min_instance_count: + default: 2 + format: int64 + type: integer + x-go-name: MinInstanceCount + 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 + network_ids: + $ref: '#/definitions/SKubeNetworkIds' + public_key: + description: 'swagger: ignore' + type: string + x-go-name: PublicKey + root_disk_size_gb: + format: int64 + type: integer + x-go-name: RootDiskSizeGb + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodePoolDetails: + properties: + DomainId: + type: string + 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 + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + 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' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodePoolUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodeUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ListResult: + properties: + MarkerField: + type: string + MarkerOrder: + type: string + NextMarker: + type: string + data: + items: + type: object + type: array + x-go-name: Data + 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 + totals: + type: object + x-go-name: Totals + type: object + x-go-package: yunion.io/x/pkg/util/printutils + LoadbalancerAclCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + acl_entries: + $ref: '#/definitions/SAclEntries' + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + 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 + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAclDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + acl_entries: + $ref: '#/definitions/SAclEntries' + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + lb_listener_count: + format: int64 + type: integer + x-go-name: ListenerCount + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + LoadbalancerAclPatchInput: + properties: + adds: + items: + $ref: '#/definitions/SAclEntry' + type: array + x-go-name: Adds + dels: + items: + $ref: '#/definitions/SAclEntry' + type: array + x-go-name: Dels + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAclUpdateInput: + properties: + acl_entries: + $ref: '#/definitions/SAclEntries' + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAgentDeployInput: + properties: + DeployMethod: + type: string + Host: + $ref: '#/definitions/Host' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAgentDetails: + 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 + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + cluster: + description: 负载均衡集群名称 + type: string + x-go-name: Cluster + cluster_id: + description: 归属LB集群 + type: string + x-go-name: ClusterId + 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 + deployment: + $ref: '#/definitions/SLoadbalancerAgentDeployment' + description: + description: 资源描述信息 + type: string + x-go-name: Description + ha_state: + type: string + x-go-name: HaState + hb_last_seen: + description: LB_HA_STATE_UNKNOWN + format: date-time + type: string + x-go-name: HbLastSeen + hb_timeout: + format: int64 + type: integer + x-go-name: HbTimeout + id: + description: 资源UUID + type: string + x-go-name: Id + interface: + type: string + x-go-name: Interface + ip: + type: string + x-go-name: IP + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + loadbalancer_acls: + format: date-time + type: string + x-go-name: LoadbalancerAcls + loadbalancer_backend_groups: + format: date-time + type: string + x-go-name: LoadbalancerBackendGroups + loadbalancer_backends: + format: date-time + type: string + x-go-name: LoadbalancerBackends + loadbalancer_certificates: + format: date-time + type: string + x-go-name: LoadbalancerCertificates + loadbalancer_listener_rules: + format: date-time + type: string + x-go-name: LoadbalancerListenerRules + loadbalancer_listeners: + format: date-time + type: string + x-go-name: LoadbalancerListeners + loadbalancer_networks: + format: date-time + type: string + x-go-name: LoadbalancerNetworks + loadbalancers: + format: date-time + type: string + x-go-name: Loadbalancers + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + format: date-time + type: string + x-go-name: Networks + params: + $ref: '#/definitions/SLoadbalancerAgentParams' + priority: + format: int64 + type: integer + x-go-name: Priority + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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 + version: + type: string + x-go-name: Version + vpc: + description: VPC名称 + type: string + x-go-name: Vpc + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAgentJoinClusterInput: + properties: + cluster_id: + type: string + x-go-name: ClusterId + priority: + format: int64 + type: integer + x-go-name: Priority + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAgentLeaveClusterInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAssociateEipInput: + properties: + eip_id: + description: 弹性公网IP的ID + type: string + x-go-name: EipId + ip_addr: + description: 弹性IP映射的内网IP地址，可选 + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + address: + type: string + x-go-name: Address + backend: + description: 'swagger: ignore' + type: string + x-go-name: Backend + backend_group: + description: 'swagger: ignore' + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + backend_id: + type: string + x-go-name: BackendId + backend_type: + type: string + x-go-name: BackendType + 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 + port: + format: int64 + type: integer + x-go-name: Port + send_proxy: + type: string + x-go-name: SendProxy + ssl: + type: string + x-go-name: Ssl + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + weight: + format: int64 + type: integer + x-go-name: Weight + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + address: + type: string + x-go-name: Address + backend_group: + description: 负载均衡后端组名称 + type: string + x-go-name: BackendGroup + backend_group_id: + description: 负载均衡后端组ID + type: string + x-go-name: BackendGroupId + backend_id: + type: string + x-go-name: BackendId + backend_role: + type: string + x-go-name: BackendRole + backend_type: + type: string + x-go-name: BackendType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + port: + format: int64 + type: integer + x-go-name: Port + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + send_proxy: + type: string + x-go-name: SendProxy + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + ssl: + type: string + x-go-name: Ssl + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_id: + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + weight: + format: int64 + type: integer + x-go-name: Weight + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendGroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + backends: + items: + properties: + Address: + type: string + BackendRole: + type: string + BackendType: + type: string + ExternalId: + type: string + HostName: + type: string + Id: + type: string + Index: + format: int64 + type: integer + Name: + type: string + Port: + format: int64 + type: integer + Weight: + format: int64 + type: integer + ZoneId: + type: string + type: object + type: array + x-go-name: Backends + 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 + loadbalancer: + description: 'swagger: ignore' + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + type: + type: string + x-go-name: Type + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendGroupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default: + type: boolean + x-go-name: IsDefault + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + lb_listener_count: + format: int64 + type: integer + x-go-name: LbListenerCount + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + port: + format: int64 + type: integer + x-go-name: Port + progress: + format: float + type: number + x-go-name: Progress + send_proxy: + type: string + x-go-name: SendPorxy + ssl: + type: string + x-go-name: Ssl + weight: + format: int64 + type: integer + x-go-name: Weight + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerCertificateCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + certificate: + type: string + x-go-name: Certificate + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + common_name: + description: 'swagger: ignore' + type: string + x-go-name: CommonName + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + fingerprint: + description: 'swagger: ignore' + type: string + x-go-name: Fingerprint + 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: 'description: indicate the resource is a system resource, which is not visible to user' + 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 + not_after: + description: 'swagger: ignore' + format: date-time + type: string + x-go-name: NotAfter + not_before: + description: 'swagger: ignore' + format: date-time + type: string + x-go-name: NotBefore + private_key: + type: string + x-go-name: PrivateKey + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_key_algorithm: + description: 'swagger: ignore' + type: string + x-go-name: PublicKeyAlgorithm + public_key_bit_len: + description: 'swagger: ignore' + format: int64 + type: integer + x-go-name: PublicKeyBitLen + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + signature_algorithm: + description: 'swagger: ignore' + type: string + x-go-name: SignatureAlgorithm + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + subject_alternative_names: + description: 'swagger: ignore' + type: string + x-go-name: SubjectAlternativeNames + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerCertificateDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + certificate: + type: string + x-go-name: Certificate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + domain_id: + description: 域Id + type: string + x-go-name: DomainId + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + fingerprint: + type: string + x-go-name: Fingerprint + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + lb_listener_count: + format: int64 + type: integer + x-go-name: ListenerCount + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + 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 + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + private_key: + type: string + x-go-name: PrivateKey + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_key_algorithm: + description: derived attributes + type: string + x-go-name: PublicKeyAlgorithm + public_key_bit_len: + format: int64 + type: integer + x-go-name: PublicKeyBitLen + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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 + signature_algorithm: + type: string + x-go-name: SignatureAlgorithm + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + subject_alternative_names: + type: string + x-go-name: SubjectAlternativeNames + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + LoadbalancerCertificateUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerClusterDetails: + properties: + RefCounts: + additionalProperties: + format: int64 + type: integer + type: object + 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 + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + 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 + 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 + params: + $ref: '#/definitions/SLoadbalancerClusterParams' + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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 + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerCreateEipInput: + properties: + auto_dellocate: + description: auto_dellocate + type: boolean + x-go-name: AutoDellocate + bandwidth: + description: Bandwidth + format: int64 + type: integer + x-go-name: Bandwidth + bgp_type: + description: bgp_type + type: string + x-go-name: BgpType + charge_type: + description: 计费方式，traffic or bandwidth + type: string + x-go-name: ChargeType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Networks: + description: |- + 多子网 + swagger: ignore + items: + type: string + type: array + address: + description: IP地址 + type: string + x-go-name: Address + address_type: + description: 地址类型 + type: string + x-go-name: AddressType + charge_type: + description: 计费类型 + type: string + x-go-name: ChargeType + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + cluster_id: + description: 负载均衡集群Id + type: string + x-go-name: ClusterId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时长 + type: string + x-go-name: Duration + egress_mbps: + description: 出口带宽 + format: int64 + type: integer + x-go-name: EgressMbps + eip: + description: 'swagger: ignore' + type: string + x-go-name: Eip + eip_auto_dellocate: + description: 是否跟随主机删除而自动释放 + type: boolean + x-go-name: EipAutoDellocate + eip_bgp_type: + description: 弹性公网IP线路类型 + type: string + x-go-name: EipBgpType + eip_bw: + description: |- + 弹性公网IP带宽 + 指定此参数后会创建新的弹性公网IP并绑定到新建的负载均衡 + format: int64 + type: integer + x-go-name: EipBw + eip_charge_type: + description: 弹性公网IP计费类型 + type: string + x-go-name: EipChargeType + eip_id: + description: EIP Id + type: string + x-go-name: EipId + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + lb_info: + description: LB的其他配置信息 + type: object + x-go-name: LBInfo + loadbalancer_spec: + description: 套餐名称 + type: string + x-go-name: LoadbalancerSpec + 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 + network_id: + description: IP子网（ID或Name） + type: string + x-go-name: NetworkId + network_type: + description: 网络类型 + type: string + x-go-name: NetworkType + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + zone_1: + description: 从可用区1 + type: string + x-go-name: Zone1 + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + address: + description: IP地址 + type: string + x-go-name: Address + address_type: + description: 地址类型 + type: string + x-go-name: AddressType + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + backend_group: + description: 后端服务器组名称 + type: string + x-go-name: BackendGroup + backend_group_id: + description: 默认后端服务器组Id + type: string + x-go-name: BackendGroupId + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + charge_type: + description: 计费类型 + type: string + x-go-name: ChargeType + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + cluster: + description: 负载均衡集群名称 + type: string + x-go-name: Cluster + cluster_id: + description: 归属LB集群 + type: string + x-go-name: ClusterId + 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 + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + domain_id: + description: 域Id + type: string + x-go-name: DomainId + egress_mbps: + format: int64 + type: integer + x-go-name: EgressMbps + eip: + description: 公网IP地址 + type: string + x-go-name: Eip + eip_id: + type: string + x-go-name: EipId + eip_mode: + description: '公网IP地址类型: 弹性、非弹性' + example: public_ip + type: string + x-go-name: EipMode + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + lb_info: + description: LB的其他配置信息 + type: object + x-go-name: LBInfo + loadbalancer_spec: + description: 套餐名称 + type: string + x-go-name: LoadbalancerSpec + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + network_type: + description: 网络类型 + type: string + x-go-name: NetworkType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secgroups: + description: 关联安全组列表 + items: + $ref: '#/definitions/SimpleSecurityGroup' + type: array + x-go-name: Secgroups + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_1: + description: 备可用区 + type: string + x-go-name: Zone1 + zone_1_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: Zone1ExtId + zone_1_name: + description: 可用区名称 + example: 北京2区 + type: string + x-go-name: Zone1Name + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerDissociateEipInput: + properties: + auto_delete: + description: 是否自动释放 + type: boolean + x-go-name: AudoDelete + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + acl: + description: 'swagger: ignore' + type: string + x-go-name: Acl + acl_id: + type: string + x-go-name: AclId + acl_status: + type: string + x-go-name: AclStatus + acl_type: + type: string + x-go-name: AclType + backend_connect_timeout: + default: 5 + description: range 1-180 + format: int64 + type: integer + x-go-name: BackendConnectTimeout + backend_group: + description: 'swagger: ignore' + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + backend_idle_timeout: + default: 90 + description: range 1-600 + format: int64 + type: integer + x-go-name: BackendIdleTimeout + certificate: + description: 'swagger: ignore' + type: string + x-go-name: Certificate + certificate_id: + type: string + x-go-name: CertificateId + client_idle_timeout: + default: 90 + description: range 1-600 + format: int64 + type: integer + x-go-name: ClientIdleTimeout + client_request_timeout: + default: 10 + description: range 1-600 + format: int64 + type: integer + x-go-name: ClientReqeustTimeout + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + egress_mbps: + format: int64 + type: integer + x-go-name: EgressMbps + enable_http2: + default: true + type: boolean + x-go-name: EnableHttp2 + 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 + gzip: + type: boolean + x-go-name: Gzip + health_check: + default: "on" + type: string + x-go-name: HealthCheck + health_check_fail: + default: 2 + description: 2-10 + format: int64 + type: integer + x-go-name: HealthCheckFail + health_check_http_code: + default: http_2xx,http_3xx + type: string + x-go-name: HealthCheckHttpCode + health_check_interval: + default: 30 + description: 5-300 + format: int64 + type: integer + x-go-name: HealthCheckInterval + health_check_path: + type: string + x-go-name: HealthCheckPath + health_check_rise: + default: 5 + description: 2-10 + format: int64 + type: integer + x-go-name: HealthCheckRise + health_check_timeout: + default: 5 + description: 2-120 + format: int64 + type: integer + x-go-name: HealthCheckTimeout + health_check_type: + enum: + - tcp + - ' udp' + - ' http' + type: string + x-go-name: HealthCheckType + http_request_rate: + format: int64 + type: integer + x-go-name: HttpRequestRate + http_request_rate_src: + format: int64 + type: integer + x-go-name: HttpRequestRatePerSrc + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + listener_port: + format: int64 + type: integer + x-go-name: ListenerPort + listener_type: + type: string + x-go-name: ListenerType + loadbalancer: + description: 'swagger: ignore' + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + 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 + redirect: + default: "off" + type: string + x-go-name: Redirect + redirect_code: + format: int64 + type: integer + x-go-name: RedirectCode + redirect_host: + type: string + x-go-name: RedirectHost + redirect_path: + type: string + x-go-name: RedirectPath + redirect_scheme: + type: string + x-go-name: RedirectScheme + scheduler: + type: string + x-go-name: Scheduler + send_proxy: + type: string + x-go-name: SendProxy + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + sticky_session: + type: string + x-go-name: StickySession + sticky_session_cookie: + type: string + x-go-name: StickySessionCookie + sticky_session_cookie_timeout: + format: int64 + type: integer + x-go-name: StickySessionCookieTimeout + sticky_session_type: + type: string + x-go-name: StickySessionType + string: + type: string + x-go-name: HealthCheckDomain + tls_cipher_policy: + type: string + x-go-name: TLSCipherPolicy + x_forwarded_for: + default: true + type: boolean + x-go-name: XForwardedFor + required: + - name + - listener_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + acl: + description: 负载均衡ACL名称 + type: string + x-go-name: Acl + acl_id: + description: 本地Acl ID + type: string + x-go-name: AclId + acl_status: + type: string + x-go-name: AclStatus + acl_type: + type: string + x-go-name: AclType + backend_connect_timeout: + description: 连接空闲超时时间 + format: int64 + type: integer + x-go-name: BackendConnectTimeout + backend_group: + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + backend_idle_timeout: + description: 后端连接超时时间 + format: int64 + type: integer + x-go-name: BackendIdleTimeout + backend_server_port: + format: int64 + type: integer + x-go-name: BackendServerPort + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + certificate: + description: 负载均衡证书名称 + type: string + x-go-name: Certificate + certificate_id: + description: 本地负载均衡证书ID + type: string + x-go-name: CertificateId + certificate_name: + type: string + x-go-name: CertificateName + client_idle_timeout: + description: 连接请求超时时间 + format: int64 + type: integer + x-go-name: ClientIdleTimeout + client_request_timeout: + format: int64 + type: integer + x-go-name: ClientRequestTimeout + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + 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 + egress_mbps: + format: int64 + type: integer + x-go-name: EgressMbps + enable_http2: + type: boolean + x-go-name: EnableHttp2 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + gzip: + description: 获取客户端真实IP + type: boolean + x-go-name: Gzip + health_check: + type: string + x-go-name: HealthCheck + health_check_domain: + type: string + x-go-name: HealthCheckDomain + health_check_exp: + description: UDP监听健康检查的请求串 + type: string + x-go-name: HealthCheckExp + health_check_fall: + description: 健康检查健康阈值 3秒 + format: int64 + type: integer + x-go-name: HealthCheckFall + health_check_http_code: + description: 健康检查路径 / + type: string + x-go-name: HealthCheckHttpCode + health_check_interval: + description: 健康检查超时时间 10秒 + format: int64 + type: integer + x-go-name: HealthCheckInterval + health_check_req: + type: string + x-go-name: HealthCheckReq + health_check_rise: + format: int64 + type: integer + x-go-name: HealthCheckRise + health_check_timeout: + description: 健康检查不健康阈值 15秒 + format: int64 + type: integer + x-go-name: HealthCheckTimeout + health_check_type: + description: 健康检查开启状态 on|off + type: string + x-go-name: HealthCheckType + health_check_uri: + description: 健康检查域名 yunion.cn + type: string + x-go-name: HealthCheckURI + http_request_rate: + format: int64 + type: integer + x-go-name: HTTPRequestRate + http_request_rate_per_src: + description: 限定监听接收请示速率 + format: int64 + type: integer + x-go-name: HTTPRequestRatePerSrc + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + listener_port: + format: int64 + type: integer + x-go-name: ListenerPort + listener_type: + type: string + x-go-name: ListenerType + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + redirect: + type: string + x-go-name: Redirect + redirect_code: + description: 跳转类型 + format: int64 + type: integer + x-go-name: RedirectCode + redirect_host: + description: 跳转uri scheme + type: string + x-go-name: RedirectHost + redirect_path: + description: 跳转时变更Host + type: string + x-go-name: RedirectPath + redirect_scheme: + description: 跳转HTTP code + type: string + x-go-name: RedirectScheme + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + scheduler: + type: string + x-go-name: Scheduler + send_proxy: + type: string + x-go-name: SendProxy + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + sticky_session: + type: string + x-go-name: StickySession + sticky_session_cookie: + description: Cookie处理方式 insert(植入cookie)|server(重写cookie) + type: string + x-go-name: StickySessionCookie + sticky_session_cookie_timeout: + description: Cookie名称 + format: int64 + type: integer + x-go-name: StickySessionCookieTimeout + sticky_session_type: + description: 会话保持开启状态 on|off + type: string + x-go-name: StickySessionType + tenant_id: + type: string + x-go-name: ProjectId + tls_cipher_policy: + type: string + x-go-name: TLSCipherPolicy + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + xforwarded_for: + type: boolean + x-go-name: XForwardedFor + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerRuleCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Redirect: + type: string + RedirectCode: + format: int64 + type: integer + RedirectHost: + type: string + RedirectPath: + type: string + RedirectScheme: + type: string + backend_group: + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + conditon: + type: string + x-go-name: Condition + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + domain: + type: string + x-go-name: Domain + 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 + http_request_rate: + format: int64 + type: integer + x-go-name: HttpRequstRate + http_request_rate_per_sec: + format: int64 + type: integer + x-go-name: HttpRequstRatePerSec + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + listener: + description: 'swagger: ignore' + type: string + x-go-name: Listener + listener_id: + type: string + x-go-name: ListenerId + 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 + path: + type: string + x-go-name: Path + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerRuleDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + backend_group: + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + condition: + type: string + x-go-name: Condition + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + health_check: + type: string + x-go-name: HealthCheck + health_check_domain: + type: string + x-go-name: HealthCheckDomain + health_check_exp: + description: UDP监听健康检查的请求串 + type: string + x-go-name: HealthCheckExp + health_check_fall: + description: 健康检查健康阈值 3秒 + format: int64 + type: integer + x-go-name: HealthCheckFall + health_check_http_code: + description: 健康检查路径 / + type: string + x-go-name: HealthCheckHttpCode + health_check_interval: + description: 健康检查超时时间 10秒 + format: int64 + type: integer + x-go-name: HealthCheckInterval + health_check_req: + type: string + x-go-name: HealthCheckReq + health_check_rise: + format: int64 + type: integer + x-go-name: HealthCheckRise + health_check_timeout: + description: 健康检查不健康阈值 15秒 + format: int64 + type: integer + x-go-name: HealthCheckTimeout + health_check_type: + description: 健康检查开启状态 on|off + type: string + x-go-name: HealthCheckType + health_check_uri: + description: 健康检查域名 yunion.cn + type: string + x-go-name: HealthCheckURI + http_request_rate: + format: int64 + type: integer + x-go-name: HTTPRequestRate + http_request_rate_per_src: + description: 限定监听接收请示速率 + format: int64 + type: integer + x-go-name: HTTPRequestRatePerSrc + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default: + description: 默认转发策略，目前只有aws用到其它云都是false + type: boolean + x-go-name: IsDefault + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + listener: + description: 负载均衡监听器名称 + type: string + x-go-name: Listener + listener_id: + description: 负载均衡监听器ID + type: string + x-go-name: ListenerId + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + path: + type: string + x-go-name: Path + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + redirect: + type: string + x-go-name: Redirect + redirect_code: + description: 跳转类型 + format: int64 + type: integer + x-go-name: RedirectCode + redirect_host: + description: 跳转uri scheme + type: string + x-go-name: RedirectHost + redirect_path: + description: 跳转时变更Host + type: string + x-go-name: RedirectPath + redirect_scheme: + description: 跳转HTTP code + type: string + x-go-name: RedirectScheme + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_id: + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerRuleUpdateInput: + properties: + Redirect: + type: string + RedirectCode: + format: int64 + type: integer + RedirectHost: + type: string + RedirectPath: + type: string + RedirectScheme: + type: string + backend_group: + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + conditon: + type: string + x-go-name: Condition + description: + description: 资源描述 + type: string + x-go-name: Description + domain: + type: string + x-go-name: Domain + http_request_rate: + format: int64 + type: integer + x-go-name: HttpRequstRate + http_request_rate_per_sec: + format: int64 + type: integer + x-go-name: HttpRequstRatePerSec + listener: + description: 'swagger: ignore' + type: string + x-go-name: Listener + listener_id: + type: string + x-go-name: ListenerId + name: + description: 资源名称 + type: string + x-go-name: Name + path: + type: string + x-go-name: Path + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerUpdateInput: + properties: + acl: + description: 'swagger: ignore' + type: string + x-go-name: Acl + acl_id: + type: string + x-go-name: AclId + acl_status: + type: string + x-go-name: AclStatus + acl_type: + type: string + x-go-name: AclType + backend_connect_timeout: + default: 5 + description: range 1-180 + format: int64 + type: integer + x-go-name: BackendConnectTimeout + backend_idle_timeout: + default: 90 + description: range 1-600 + format: int64 + type: integer + x-go-name: BackendIdleTimeout + certificate: + description: 'swagger: ignore' + type: string + x-go-name: Certificate + certificate_id: + type: string + x-go-name: CertificateId + client_idle_timeout: + default: 90 + description: range 1-600 + format: int64 + type: integer + x-go-name: ClientIdleTimeout + client_request_timeout: + default: 10 + description: range 1-600 + format: int64 + type: integer + x-go-name: ClientReqeustTimeout + description: + description: 资源描述 + type: string + x-go-name: Description + enable_http2: + default: true + type: boolean + x-go-name: EnableHttp2 + gzip: + type: boolean + x-go-name: Gzip + health_check: + default: "on" + type: string + x-go-name: HealthCheck + health_check_fail: + default: 2 + description: 2-10 + format: int64 + type: integer + x-go-name: HealthCheckFail + health_check_http_code: + default: http_2xx,http_3xx + type: string + x-go-name: HealthCheckHttpCode + health_check_interval: + default: 30 + description: 5-300 + format: int64 + type: integer + x-go-name: HealthCheckInterval + health_check_path: + type: string + x-go-name: HealthCheckPath + health_check_rise: + default: 5 + description: 2-10 + format: int64 + type: integer + x-go-name: HealthCheckRise + health_check_timeout: + default: 5 + description: 2-120 + format: int64 + type: integer + x-go-name: HealthCheckTimeout + health_check_type: + enum: + - tcp + - ' udp' + - ' http' + type: string + x-go-name: HealthCheckType + http_request_rate: + format: int64 + type: integer + x-go-name: HttpRequestRate + http_request_rate_src: + format: int64 + type: integer + x-go-name: HttpRequestRatePerSrc + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + redirect: + default: "off" + type: string + x-go-name: Redirect + redirect_code: + format: int64 + type: integer + x-go-name: RedirectCode + redirect_host: + type: string + x-go-name: RedirectHost + redirect_path: + type: string + x-go-name: RedirectPath + redirect_scheme: + type: string + x-go-name: RedirectScheme + scheduler: + type: string + x-go-name: Scheduler + send_proxy: + type: string + x-go-name: SendProxy + sticky_session: + type: string + x-go-name: StickySession + sticky_session_cookie: + type: string + x-go-name: StickySessionCookie + sticky_session_cookie_timeout: + format: int64 + type: integer + x-go-name: StickySessionCookieTimeout + sticky_session_type: + type: string + x-go-name: StickySessionType + string: + type: string + x-go-name: HealthCheckDomain + tls_cipher_policy: + type: string + x-go-name: TLSCipherPolicy + x_forwarded_for: + default: true + type: boolean + x-go-name: XForwardedFor + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MappingRules: + items: + $ref: '#/definitions/ProjectMappingRuleInfo' + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MiscResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MiscResourceDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + 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 + ModelartsPoolChangeConfigInput: + properties: + NodeCount: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ModelartsPoolCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cidr: + type: string + x-go-name: Cidr + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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 + node_count: + format: int64 + type: integer + x-go-name: NodeCount + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ModelartsPoolDetails: + description: 资源返回详情 + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + 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 + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + ModelartsPoolSkuDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ModelartsPoolSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MongoDBCreateInput: + 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 + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MongoDBDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + category: + description: 实例类型 + example: ha + type: string + x-go-name: Category + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + disk_size_mb: + description: 存储大小, 单位Mb + example: 10240 + format: int64 + type: integer + x-go-name: DiskSizeMb + domain_id: + description: 域Id + type: string + x-go-name: DomainId + engine: + description: 引擎 + example: MySQL + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + example: "5.7" + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + example: mysql.x4.large.2c + type: string + x-go-name: InstanceType + iops: + format: int64 + type: integer + x-go-name: Iops + ip_addr: + description: 实例IP地址 + type: string + x-go-name: IpAddr + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + maintain_time: + description: 维护时间 + type: string + x-go-name: MaintainTime + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + max_connections: + description: 最大连接数 + format: int64 + type: integer + x-go-name: MaxConnections + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network: + description: IP子网名称 + example: test-network + type: string + x-go-name: Network + network_address: + description: 连接地址 + type: string + x-go-name: NetworkAddress + network_id: + description: 所属网络ID + type: string + x-go-name: NetworkId + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + port: + description: 端口 + example: 3306 + format: int64 + type: integer + x-go-name: Port + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + replication_num: + description: 分片数量 + example: 3 + format: int64 + type: integer + x-go-name: ReplicationNum + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + vcpu_count: + description: CPU数量 + example: 1 + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size_mb: + description: 内存大小 + example: 1024 + format: int64 + type: integer + x-go-name: VmemSizeMb + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 虚拟私有网络Id + example: ed20d84e-3158-41b1-870c-1725e412e8b6 + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MongoDBRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MountTargetCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + access_group_id: + description: 权限组Id + type: string + x-go-name: AccessGroupId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + file_system_id: + description: 文件系统Id + type: string + x-go-name: FileSystemId + 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 + network_id: + description: Ip子网名称或Id, network_type == vpc时有效 + type: string + x-go-name: NetworkId + network_type: + default: vpc + description: |- + 网络类型 + enmu: vpc, classic + type: string + x-go-name: NetworkType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - file_system_id + - network_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MountTargetDetails: + properties: + FileSystem: + type: string + access_group: + description: 权限组名称 + type: string + x-go-name: AccessGroup + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network: + description: IP子网名称 + type: string + x-go-name: Network + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区 + type: string + x-go-name: Zone + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MountTargetSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NasSkuDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatDEntryDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + natgateway: + description: NAT网关名称 + type: string + x-go-name: Natgateway + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatEntryDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + natgateway: + description: NAT网关名称 + type: string + x-go-name: Natgateway + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatGatewaySyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatSEntryDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + natgateway: + description: NAT网关名称 + type: string + x-go-name: Natgateway + network: + $ref: '#/definitions/SimpleNetwork' + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatSkuDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatgatewayCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + auto_renew: + default: false + description: 是否自动续费(仅包年包月时生效) + type: boolean + x-go-name: AutoRenew + billing_type: + description: 计费方式 + enum: + - postpaid + - ' prepaid' + type: string + x-go-name: BillingType + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时间周期 + type: string + x-go-name: Duration + eip: + description: 绑定已有弹性公网IP，要求EIP必须和Vpc在同一区域 + type: string + x-go-name: Eip + eip_auto_dellocate: + type: boolean + x-go-name: EipAutoDellocate + eip_bgp_type: + type: string + x-go-name: EipBgpType + eip_bw: + description: 绑定新建弹性公网IP + format: int64 + type: integer + x-go-name: EipBw + eip_charge_type: + default: traffic + description: 弹性公网IP计费类型 + enum: + - bandwidth + - ' traffic' + type: string + x-go-name: EipChargeType + expired_at: + description: 到期释放时间，仅后付费支持 + format: date-time + type: string + x-go-name: ExpiredAt + 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 + network_id: + type: string + x-go-name: NetworkId + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatgatewayDeleteInput: + properties: + force: + type: boolean + x-go-name: Force + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatgatewayDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + bandwidth_mb: + format: int64 + type: integer + x-go-name: BandwidthMb + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + 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 + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + ip_addr: + type: string + x-go-name: IpAddr + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nat_spec: + type: string + x-go-name: NatSpec + network: + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + network_type: + type: string + x-go-name: NetworkType + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetTapFlowCreateInput: + 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 + direction: + type: string + x-go-name: Direction + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + guest_id: + type: string + x-go-name: GuestId + host_id: + type: string + x-go-name: HostId + ip_addr: + type: string + x-go-name: IpAddr + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + mac_addr: + type: string + x-go-name: MacAddr + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + tap_id: + type: string + x-go-name: TapId + type: + type: string + x-go-name: Type + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + wire_id: + type: string + x-go-name: WireId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetTapFlowDetails: + 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 + net: + type: string + x-go-name: Net + source: + type: string + x-go-name: Source + source_ips: + type: string + x-go-name: SourceIps + tap: + description: 关联的tap服务名称 + type: string + x-go-name: Tap + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetTapServiceCreateInput: + 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 + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + mac_addr: + description: 监听网卡的Mac地址 + type: string + x-go-name: MacAddr + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + target_id: + description: 资源ID，如果Type=host，该值为宿主机的ID，如果Type=guest，该值为虚拟机的ID + type: string + x-go-name: TargetId + type: + description: TAP服务类型，监听宿主机的网卡还是虚拟机的网卡, 可能值为 host|guest + type: string + x-go-name: Type + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetTapServiceDetails: + 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' + flow_count: + description: tap flow数量 + format: int64 + type: integer + x-go-name: FlowCount + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + target: + description: 流量镜像目标名称 + type: string + x-go-name: Target + target_ips: + description: 流量镜像目标IP地址 + type: string + x-go-name: TargetIps + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworSyncAdditionalWiresInput: + properties: + wire_ids: + items: + type: string + type: array + x-go-name: WireIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkAddrConf: + properties: + gateway: + type: string + x-go-name: Gateway + id: + type: string + x-go-name: Id + ip_addr: + type: string + x-go-name: IpAddr + masklen: + format: int64 + type: integer + x-go-name: Masklen + type: + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkAddressCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + GuestId: + type: string + GuestnetworkIndex: + format: int8 + type: integer + NetworkId: + type: string + ParentId: + format: int64 + type: integer + ParentType: + type: string + Type: + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + ip_addr: + type: string + x-go-name: IPAddr + ip_addrs: + items: + type: string + type: array + x-go-name: IPAddrs + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkAddressDetails: + properties: + Guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + IpAddr: + type: string + NetworkId: + type: string + ParentId: + type: string + ParentType: + type: string + SubCtrVid: + format: int64 + type: integer + Type: + type: string + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network: + description: IP子网名称 + type: string + x-go-name: Network + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区 + type: string + x-go-name: Zone + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkConfig: + properties: + address: + description: 子网内的IPv4地址, 若不指定会按照子网的地址分配策略分配一个IP地址 + type: string + x-go-name: Address + address6: + description: 子网内的IPv6地址 + type: string + x-go-name: Address6 + addresses: + description: 如果是批量创建，指定每台主机子网内的IPv4地址 + items: + type: string + type: array + x-go-name: Addresses + addresses6: + description: 如果是批量创建，指定每台主机子网内的IPv4地址 + items: + type: string + type: array + x-go-name: Addresses6 + bw_limit: + format: int64 + type: integer + x-go-name: BwLimit + driver: + description: |- + 驱动方式 + 若指定镜像的网络驱动方式，此参数会被覆盖 + type: string + x-go-name: Driver + exit: + description: 内网地址 + type: boolean + x-go-name: Exit + ifname: + type: string + x-go-name: Ifname + index: + description: 网卡序号, 从0开始 + format: int64 + type: integer + x-go-name: Index + is_default: + type: boolean + x-go-name: IsDefault + mac: + description: |- + 网卡MAC地址 + requried: false + type: string + x-go-name: Mac + macs: + description: |- + 如果是批量创建，指定每个网卡MAC地址 + requried: false + items: + type: string + type: array + x-go-name: Macs + net_type: + type: string + x-go-name: NetType + network: + description: 子网名称或ID + type: string + x-go-name: Network + num_queues: + format: int64 + type: integer + x-go-name: NumQueues + private: + type: boolean + x-go-name: Private + require_designated_ip: + type: boolean + x-go-name: RequireDesignatedIP + require_ipv6: + description: 是否要求分配IPv6地址 + type: boolean + x-go-name: RequireIPv6 + require_teaming: + type: boolean + x-go-name: RequireTeaming + reserved: + type: boolean + x-go-name: Reserved + rx_traffic_limit: + format: int64 + type: integer + x-go-name: RxTrafficLimit + schedtags: + items: + $ref: '#/definitions/SchedtagConfig' + type: array + x-go-name: Schedtags + sriov_device: + $ref: '#/definitions/IsolatedDeviceConfig' + standby_addr_count: + format: int64 + type: integer + x-go-name: StandbyAddrCount + standby_port_count: + format: int64 + type: integer + x-go-name: StandbyPortCount + try_teaming: + type: boolean + x-go-name: TryTeaming + tx_traffic_limit: + format: int64 + type: integer + x-go-name: TxTrafficLimit + vip: + type: boolean + x-go-name: Vip + required: + - index + - network + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + assign_public_ip: + description: 是否申请ip时自动挂载公网ip，仅对aws生效 + type: boolean + x-go-name: AssignPublicIp + bgp_type: + description: 线路类型 + type: string + x-go-name: BgpType + 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 + guest_dhcp: + description: 'description: guest dhcp' + example: 192.168.222.1,192.168.222.4 + type: string + x-go-name: GuestDHCP + guest_dns: + description: 'description: guest dns' + example: 114.114.114.114,8.8.8.8 + type: string + x-go-name: GuestDns + guest_gateway: + description: 'description: guest gateway' + example: 192.168.222.1 + type: string + x-go-name: GuestGateway + guest_gateway6: + description: 'description: guest gateway of IPv6' + example: 3ffe:3200:2001:2300::1 + type: string + x-go-name: GuestGateway6 + guest_ip_end: + description: 'description: ip range of guest ip end, if set guest_ip_prefix, this parameter will be ignored' + example: 10.168.222.100 + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + description: 'description: ip range of guest ip mask, if set guest_ip_prefix, this parameter will be ignored' + example: 24 + format: int8 + maximum: 30 + minimum: 12 + type: integer + x-go-name: GuestIpMask + guest_ip_prefix: + description: 'description: ip range of guest, if not set, you shoud set guest_ip_start,guest_ip_end and guest_ip_mask params' + example: 10.168.222.1/24 + type: string + x-go-name: GuestIpPrefix + guest_ip_start: + description: 'description: ip range of guest ip start, if set guest_ip_prefix, this parameter will be ignored' + example: 10.168.222.1 + type: string + x-go-name: GuestIpStart + guest_ip6_end: + description: 'description: ipv6 range of guest ip end, if set guest_ip6_prefix, this parameter will be ignored' + example: 3ffe:3200:2001:2300:ffff:ffff:ffff:ffff + type: string + x-go-name: GuestIp6End + guest_ip6_mask: + description: 'description: ipv6 range of guest ip mask, if set guest_ip6_prefix, this parameter will be ignored' + example: 64 + format: uint8 + maximum: 126 + minimum: 48 + type: integer + x-go-name: GuestIp6Mask + guest_ip6_prefix: + description: 'description: ipv6 range of guest, if not set, you shoud set guest_ip6_start,guest_ip6_end and guest_ip6_mask params' + example: 3ffe:3200:2001:2300::/64 + type: string + x-go-name: GuestIp6Prefix + guest_ip6_start: + description: 'description: ipv6 range of guest ip start, if set guest_ip6_prefix, this parameter will be ignored' + example: 3ffe:3200:2001:2300::1 + type: string + x-go-name: GuestIp6Start + guest_ntp: + description: 'description: guest ntp' + example: cn.pool.ntp.org,0.cn.pool.ntp.org + type: string + x-go-name: GuestNtp + ifname_hint: + type: string + x-go-name: IfnameHint + is_auto_alloc: + description: 是否加入自动分配地址池 + type: boolean + x-go-name: IsAutoAlloc + 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: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + server_type: + default: guest + description: 'description: server type' + enum: + - guest + - baremetal + - pxe + - ipmi + type: string + x-go-name: ServerType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vlan: + description: deprecated + format: int64 + type: integer + x-go-name: Vlan + vlan_id: + description: VlanId + format: int64 + type: integer + x-go-name: VlanId + vpc: + description: 'description: vpc id or name' + type: string + x-go-name: Vpc + wire: + description: 'description: wire id or name' + type: string + x-go-name: Wire + zone: + description: 'description: zone id or name' + type: string + x-go-name: Zone + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + additional_wires: + items: + $ref: '#/definitions/SSimpleWire' + type: array + x-go-name: AdditionalWires + alloc_policy: + description: 分配策略 + type: string + x-go-name: AllocPolicy + alloc_timout_seconds: + format: int64 + type: integer + x-go-name: AllocTimoutSeconds + bgp_type: + description: 线路类型 + type: string + x-go-name: BgpType + bm_reused_vnics: + format: int64 + type: integer + x-go-name: BmReusedVnics + bm_vnics: + description: 裸金属网卡数量 + format: int64 + type: integer + x-go-name: BmVnics + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + 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 + dns: + type: string + x-go-name: Dns + domain_id: + description: 域Id + type: string + x-go-name: DomainId + eip_vnics: + description: 浮动Ip网卡数量 + format: int64 + type: integer + x-go-name: EipVnics + environment: + description: Environment + type: string + x-go-name: Environment + exit: + description: 是否是内网 + type: boolean + x-go-name: Exit + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + group_vnics: + description: VIP数量 + format: int64 + type: integer + x-go-name: GroupVnics + guest_dhcp: + description: allow multiple dhcp, seperated by "," + type: string + x-go-name: GuestDhcp + guest_dns: + description: DNS, allow multiple dns, seperated by "," + type: string + x-go-name: GuestDns + guest_dns6: + description: IPv6域名服务器 + type: string + x-go-name: GuestDns6 + guest_domain: + description: search domain + type: string + x-go-name: GuestDomain + guest_domain6: + type: string + x-go-name: GuestDomain6 + guest_gateway: + description: 网关地址 + type: string + x-go-name: GuestGateway + guest_gateway6: + description: IPv6网关 + type: string + x-go-name: GuestGateway6 + guest_ip_end: + description: 结束IP地址 + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + description: 掩码 + format: uint8 + type: integer + x-go-name: GuestIpMask + guest_ip_start: + description: 起始IP地址 + type: string + x-go-name: GuestIpStart + guest_ip6_end: + description: 结束IPv6地址 + type: string + x-go-name: GuestIp6End + guest_ip6_mask: + description: IPv6子网掩码 + format: uint8 + type: integer + x-go-name: GuestIp6Mask + guest_ip6_start: + description: 起始IPv6地址 + type: string + x-go-name: GuestIp6Start + guest_ntp: + description: allow mutiple ntp, seperated by "," + type: string + x-go-name: GuestNtp + id: + description: 资源UUID + type: string + x-go-name: Id + ifname_hint: + type: string + x-go-name: IfnameHint + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_auto_alloc: + description: |- + 该网段是否用于自动分配IP地址，如果为false，则用户需要明确选择该网段，才会使用该网段分配IP， + 如果为true，则用户不指定网段时，则自动从该值为true的网络中选择一个分配地址 + type: boolean + x-go-name: IsAutoAlloc + is_classic: + type: boolean + x-go-name: IsClassic + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + 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 + lb_vnics: + description: 负载均衡网卡数量 + format: int64 + type: integer + x-go-name: LbVnics + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nat_vnics: + description: NAT网关网卡数量 + format: int64 + type: integer + x-go-name: NatVnics + networkinterface_vnics: + description: 弹性网卡数量 + format: int64 + type: integer + x-go-name: NetworkinterfaceVnics + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + ports: + description: 端口数量 + format: int64 + type: integer + x-go-name: Ports + ports_used: + description: 已使用端口数量 + format: int64 + type: integer + x-go-name: PortsUsed + ports6_used: + description: 已使用IPv4端口数量 + format: int64 + type: integer + x-go-name: Ports6Used + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + rds_vnics: + description: RDS网卡数量 + format: int64 + type: integer + x-go-name: RdsVnics + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + reserve_vnics4: + description: 预留IPv4数量 + format: int64 + type: integer + x-go-name: ReserveVnics4 + reserve_vnics6: + description: 预留IPv6数量 + format: int64 + type: integer + x-go-name: ReserveVnics6 + routes: + description: 路由信息 + items: + $ref: '#/definitions/SRoute' + type: array + x-go-name: Routes + schedtags: + items: + $ref: '#/definitions/SchedtagShortDescDetails' + type: array + x-go-name: Schedtags + server_type: + description: 服务器类型 + example: server + type: string + x-go-name: ServerType + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + total: + format: int64 + type: integer + x-go-name: Total + total6: + format: int64 + type: integer + x-go-name: Total6 + 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 + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + vnics: + description: 虚拟机网卡数量 + format: int64 + type: integer + x-go-name: Vnics + vnics4: + description: IPv4地址数量 + format: int64 + type: integer + x-go-name: Vnics4 + vnics6: + description: IPv6地址数量 + format: int64 + type: integer + x-go-name: Vnics6 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区 + type: string + x-go-name: Zone + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkInterfaceDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + associate_id: + description: 绑定资源Id + type: string + x-go-name: AssociateId + associate_type: + description: 绑定资源类型 + type: string + x-go-name: AssociateType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + mac: + description: MAC地址 + type: string + x-go-name: Mac + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + description: 弹性网卡网络信息 + items: + $ref: '#/definitions/NetworkInterfaceNetworkInfo' + type: array + x-go-name: Networks + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkInterfaceNetworkInfo: + properties: + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + description: Ip子网Id + type: string + x-go-name: NetworkId + networkinterface_id: + description: 弹性网卡id + type: string + x-go-name: NetworkinterfaceId + primary: + description: 是否是主ip地址 + type: boolean + x-go-name: Primary + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkIpMacBatchCreateInput: + properties: + ip_mac: + additionalProperties: + type: string + type: object + x-go-name: IpMac + network_id: + type: string + x-go-name: NetworkId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkIpMacCreateInput: + 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 + ip_addr: + type: string + x-go-name: IpAddr + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + mac_addr: + type: string + x-go-name: MacAddr + network_id: + type: string + x-go-name: NetworkId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkIpMacDetails: + 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' + ip_addr: + type: string + x-go-name: IpAddr + mac_addr: + type: string + x-go-name: MacAddr + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network_id: + type: string + x-go-name: NetworkId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkIpMacUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + ip_addr: + type: string + x-go-name: IpAddr + mac_addr: + type: string + x-go-name: MacAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkMergeInput: + properties: + target: + description: 'description: network id or name to be merged' + example: test-network + type: string + x-go-name: Target + required: + - target + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkPurgeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkReleaseReservedIpInput: + properties: + ip: + description: 'description: IP to be released' + example: 10.168.222.121 + type: string + x-go-name: Ip + required: + - ip + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkReserveIpInput: + properties: + duration: + description: 'description: The reserved cycle' + type: string + x-go-name: Duration + ips: + description: 'description: reserved ip list' + example: '[10.168.222.131, 10.168.222.134]' + items: + type: string + type: array + x-go-name: Ips + notes: + description: 'description: the comment' + example: reserve ip for test + type: string + x-go-name: Notes + status: + type: string + x-go-name: Status + required: + - ips + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkSetBgpTypeInput: + properties: + bgp_type: + description: 'description: new BgpType name' + example: ChinaTelecom, BGP, etc. + type: string + x-go-name: BgpType + required: + - bgp_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkSplitInput: + properties: + name: + description: 'description: another network name after split' + type: string + x-go-name: Name + split_ip: + description: 'description: The middle - separated IP must belong to the network' + example: 10.168.222.181 + type: string + x-go-name: SplitIp + required: + - split_ip + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkSwitchWireInput: + properties: + wire_id: + description: 'description: new wire Id or name' + example: bcast0 + type: string + x-go-name: WireId + required: + - wire_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkSyncInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkTopologyOutput: + properties: + addresses: + description: IP子网地址记录 + items: + $ref: '#/definitions/SNetworkUsedAddress' + type: array + x-go-name: Addresses + addresses6: + description: IPv6子网地址记录 + items: + $ref: '#/definitions/SNetworkUsedAddress' + type: array + x-go-name: Addresses6 + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + format: int8 + type: integer + x-go-name: GuestIpMask + guest_ip_start: + type: string + x-go-name: GuestIpStart + name: + type: string + x-go-name: Name + server_type: + type: string + x-go-name: ServerType + status: + type: string + x-go-name: Status + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkTryCreateNetworkInput: + properties: + ip: + type: string + x-go-name: Ip + is_on_premise: + type: boolean + x-go-name: IsOnPremise + mask: + format: int64 + type: integer + x-go-name: Mask + server_type: + type: string + x-go-name: ServerType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkUpdateInput: + properties: + alloc_policy: + description: 分配策略 + type: string + x-go-name: AllocPolicy + description: + description: 资源描述 + type: string + x-go-name: Description + guest_dhcp: + description: allow multiple dhcp, seperated by "," + type: string + x-go-name: GuestDhcp + guest_dns: + description: DNS + type: string + x-go-name: GuestDns + guest_domain: + type: string + x-go-name: GuestDomain + guest_gateway: + description: 网关地址 + type: string + x-go-name: GuestGateway + guest_gateway6: + description: IP6网关地址 + type: string + x-go-name: GuestGateway6 + guest_ip_end: + description: 结束IP地址 + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + description: 掩码 + format: int8 + type: integer + x-go-name: GuestIpMask + guest_ip_start: + description: 起始IP地址 + type: string + x-go-name: GuestIpStart + guest_ip6_end: + description: 结束IP6地址 + type: string + x-go-name: GuestIp6End + guest_ip6_mask: + description: IP6子网掩码长度 + format: uint8 + type: integer + x-go-name: GuestIp6Mask + guest_ip6_start: + description: 起始IP6地址 + type: string + x-go-name: GuestIp6Start + guest_ntp: + description: NTP + type: string + x-go-name: GuestNtp + is_auto_alloc: + description: 是否加入自动分配地址池 + type: boolean + x-go-name: IsAutoAlloc + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PerformChangeDomainOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformChangeProjectOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformFreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicDomainInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicProjectInput: + 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 + shared_project_ids: + description: 如果共享范围为项目，则在此列表中指定共享的目标项目 + items: + type: string + type: array + x-go-name: SharedProjectIds + 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 + PerformUnfreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PodContainerCreateInput: + properties: + args: + description: Args for the Command (i.e. command for docker) + items: + type: string + type: array + x-go-name: Args + capabilities: + $ref: '#/definitions/ContainerCapability' + cgroup_devices_allow: + items: + type: string + type: array + x-go-name: CgroupDevicesAllow + command: + description: Command to execute (i.e., entrypoint for docker) + items: + type: string + type: array + x-go-name: Command + devices: + items: + $ref: '#/definitions/ContainerDevice' + type: array + x-go-name: Devices + enable_lxcfs: + description: Enable lxcfs + type: boolean + x-go-name: EnableLxcfs + envs: + description: List of environment variable to set in the container. + items: + $ref: '#/definitions/ContainerKeyValue' + type: array + x-go-name: Envs + image: + description: Image to use. + type: string + x-go-name: Image + image_pull_policy: + $ref: '#/definitions/ImagePullPolicy' + lifecyle: + $ref: '#/definitions/ContainerLifecyle' + name: + description: Container name + type: string + x-go-name: Name + privileged: + type: boolean + x-go-name: Privileged + simulate_cpu: + type: boolean + x-go-name: SimulateCpu + volume_mounts: + description: Volume mounts + items: + $ref: '#/definitions/ContainerVolumeMount' + type: array + x-go-name: VolumeMounts + working_dir: + description: Current working directory of the command. + type: string + x-go-name: WorkingDir + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PodCreateInput: + properties: + containers: + items: + $ref: '#/definitions/PodContainerCreateInput' + type: array + x-go-name: Containers + port_mappings: + items: + $ref: '#/definitions/PodPortMapping' + type: array + x-go-name: PortMappings + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PodPortMapping: + properties: + container_port: + format: int64 + type: integer + x-go-name: ContainerPort + host_ip: + type: string + x-go-name: HostIp + host_port: + format: int64 + type: integer + x-go-name: HostPort + host_port_range: + $ref: '#/definitions/PodPortMappingPortRange' + protocol: + $ref: '#/definitions/PodPortMappingProtocol' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PodPortMappingPortRange: + properties: + end: + format: int64 + type: integer + x-go-name: End + start: + format: int64 + type: integer + x-go-name: Start + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PodPortMappingProtocol: type: string - x-go-name: Source - status: - description: 资源状态 + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PolicyAssignmentCreateInput: + 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 + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + name: + description: 资源名称 + type: string + x-go-name: Name + policydefinition_id: + description: 策略Id + type: string + x-go-name: PolicydefinitionId + 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/compute + PolicyAssignmentDetails: + properties: + Policydefinition: + type: string + 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_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + policydefinition_id: + description: 策略Id + type: string + x-go-name: PolicydefinitionId + 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 + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PolicyDefinitionCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + category: + description: 类别 + type: string + x-go-name: Category + condition: + description: 条件 + type: string + x-go-name: Condition + 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 + description: + description: 资源描述信息 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + 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 + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + name: + description: 资源名称 + example: test-network + type: string + uniqueItems: true + x-go-name: Name + parameters: + description: 参数 + type: object + x-go-name: Parameters + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PolicyDefinitionDetails: + 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 + category: + description: 类别 + type: string + x-go-name: Category + condition: + description: 条件 + type: string + x-go-name: Condition + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + parameters: + description: 参数 + type: object + x-go-name: Parameters + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PostpaidExpireInput: + properties: + duration: + type: string + x-go-name: Duration + expire_time: + format: date-time + type: string + x-go-name: ExpireTime + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ProjectMappingCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Rules: + $ref: '#/definitions/MappingRules' + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ProjectMappingDetails: + properties: + Rules: + items: + $ref: '#/definitions/ProjectMappingRuleInfoDetails' + type: array + accounts: + description: 所绑定的云账号列表 + items: + $ref: '#/definitions/SProjectMappingAccount' + type: array + x-go-name: Accounts + 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_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + 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 + managers: + description: 所绑定的云订阅列表 + items: + $ref: '#/definitions/SProjectMappingAccount' + type: array + x-go-name: Managers + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + rules: + $ref: '#/definitions/MappingRules' + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ProjectMappingRuleInfo: + properties: + auto_create_project: + description: 是否自动根据标签值创建项目, 仅标签列表中有且仅有一个没有value的key时支持 + type: boolean + x-go-name: AutoCreateProject + condition: + default: and + description: |- + 条件表达式 + enmu: and, or + type: string + x-go-name: Condition + project_id: + description: 符合条件时，资源放置的项目id, 此参数和auto_create_project互斥 + type: string + x-go-name: ProjectId + tags: + $ref: '#/definitions/TTagSet' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ProjectMappingRuleInfoDetails: + properties: + Domain: + type: string + Project: + type: string + Tenant: + type: string + TenantId: + type: string + auto_create_project: + description: 是否自动根据标签值创建项目, 仅标签列表中有且仅有一个没有value的key时支持 + type: boolean + x-go-name: AutoCreateProject + condition: + default: and + description: |- + 条件表达式 + enmu: and, or + type: string + x-go-name: Condition + project_id: + description: 符合条件时，资源放置的项目id, 此参数和auto_create_project互斥 + type: string + x-go-name: ProjectId + tags: + $ref: '#/definitions/TTagSet' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ProjectMappingUpdateInput: + properties: + Rules: + $ref: '#/definitions/MappingRules' + 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/compute + ProjectStatistic: + properties: + Count: + format: int64 + type: integer + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + RenewInput: + properties: + duration: + type: string + x-go-name: Duration + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ReservedipDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + expired: + description: 是否过期 + type: boolean + x-go-name: Expired + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + id: + description: 自增Id + format: int64 + type: integer + x-go-name: Id + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + ip6_addr: + description: IPv6地址 + type: string + x-go-name: Ip6Addr + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + notes: + description: 预留原因或描述 + type: string + x-go-name: Notes + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + status: + description: 状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区 + type: string + x-go-name: Zone + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ResourceBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResourceBaseDetails: + 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 + ResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + RouteTableCreateInput: + 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 + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + 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 + routes: + $ref: '#/definitions/SRoutes' + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + type: + type: string + x-go-name: Type + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + RouteTableDetails: + properties: + AccociationCount: + format: int64 + type: integer + RouteSetCount: + format: int64 + type: integer + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + routes: + $ref: '#/definitions/SRoutes' + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + RouteTableRouteSetCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + RouteTableId: + type: string + cidr: + type: string + x-go-name: Cidr + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + ext_next_hop_id: + type: string + x-go-name: ExtNextHopId + 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 + next_hop_id: + type: string + x-go-name: NextHopId + next_hop_type: + type: string + x-go-name: NextHopType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + RouteTableRouteSetUpdateInput: + properties: + cidr: + type: string + x-go-name: Cidr + description: + description: 资源描述 + type: string + x-go-name: Description + ext_next_hop_id: + type: string + x-go-name: ExtNextHopId + name: + description: 资源名称 + type: string + x-go-name: Name + next_hop_id: + type: string + x-go-name: NextHopId + next_hop_type: + type: string + x-go-name: NextHopType + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + RouteTableUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + routes: + $ref: '#/definitions/SRoutes' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SAccountPermission: + properties: + Permissions: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SAccountPermissions: + additionalProperties: + $ref: '#/definitions/SAccountPermission' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SAclEntries: + items: + $ref: '#/definitions/SAclEntry' + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SAclEntry: + properties: + Cidr: + type: string + Comment: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SBucketAccessUrl: + properties: + Description: + type: string + Primary: + type: boolean + Url: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCdnOrigin: + description: +onecloud:model-api-gen + properties: + Enabled: + type: string + Origin: + description: 源站地址 + type: string + Path: + type: string + Port: + format: int64 + type: integer + Priority: + format: int64 + type: integer + Protocol: + description: |- + 回源协议 + enmu: http, follow, https + type: string + ServerName: + description: 回主源站时 Host 头部 + type: string + Type: + description: |- + 源站类型 + domain: 域名类型, cos：对象存储源站, ip：IP 列表作为源站 + enmu: domain, cos, ip + type: string + required: + - Type + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCdnOrigins: + description: +onecloud:model-api-gen + items: + $ref: '#/definitions/SCdnOrigin' + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCloudObject: + properties: + Acl: + type: string + ETag: + type: string + Key: + type: string + LastModified: + format: date-time + type: string + Meta: + $ref: '#/definitions/Header' + SizeBytes: + format: int64 + type: integer + StorageClass: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCloudResource: + properties: + CanDissociate: + description: 是否可以解除关联 + type: boolean + Id: + description: 资源Id + type: string + Name: + description: 资源名称 + type: string + Port: + description: 资源映射端口 + format: int64 + type: integer + Type: + description: 资源类型 + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCloudResources: + properties: + Data: + items: + $ref: '#/definitions/SCloudResource' + type: array + Total: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCloudaccountCredential: + properties: + As: + description: 弹性伸缩服务 + type: string + Bms: + description: 裸金属服务器 + type: string + Bss: + description: 合作伙伴运营能力 + type: string + Cce: + description: 云容器服务 + type: string + Cci: + description: 云容器实例 CCI + type: string + Ces: + description: 监控服务 CloudEye + type: string + Csbs: + description: 云服务器备份服务 + type: string + Cts: + description: 云审计服务 + type: string + Dcs: + description: 分布式缓存服务 + type: string + DefaultRegion: + description: 默认区域Id, Apara及HCSO需要此参数 + example: cn-north-2 + type: string + DefaultSubnetDns: + description: 默认DNS + example: 10.125.0.26,10.125.0.27 + type: string + Ecs: + description: 弹性云服务 + type: string + Elb: + description: 弹性负载均衡 ELB + type: string + EndpointDomain: + description: 华为私有云Endpoint域名 + example: hcso.com.cn + type: string + Eps: + description: 企业项目 + type: string + Evs: + description: 云硬盘 EVS + type: string + Iam: + description: 统一身份认证服务 + type: string + Ims: + description: 镜像服务 + type: string + Modelarts: + description: Modelarts + type: string + Nat: + description: Nat网关 NAT + type: string + Obs: + description: 对象存储服务 OBS + type: string + Rds: + description: 关系型数据库 RDS + type: string + SfsTurbo: + description: 文件系统 + type: string + Vbs: + description: 云硬盘备份 VBS + type: string + Vpc: + description: 虚拟私有云 VPC + type: string + access_key_id: + description: 秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeyId + access_key_secret: + description: 秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeySecret + app_id: + description: app id (Qcloud) + type: string + x-go-name: AppId + auto_url: + description: 认证地址 (openstack,zstack) + type: string + x-go-name: AuthUrl + client_id: + description: 客户端ID (Azure) + type: string + x-go-name: ClientId + client_secret: + description: 客户端秘钥 (Azure) + type: string + x-go-name: ClientSecret + directory_id: + description: 目录ID (Azure) + type: string + x-go-name: DirectoryId + domain_name: + default: Default + description: 账号所在的域 (openstack) + type: string + x-go-name: DomainName + endpoint: + description: 端点 (s3) 或 Apsara(飞天) + type: string + x-go-name: Endpoint + environment: + description: 环境 (Azure, Aws, huawei, ctyun, aliyun) + type: string + x-go-name: Environment + gcp_client_email: + description: Google服务账号email (gcp) + type: string + x-go-name: GCPClientEmail + gcp_private_key: + description: Google服务账号秘钥 (gcp) + type: string + x-go-name: GCPPrivateKey + gcp_private_key_id: + description: Google服务账号秘钥id (gcp) + type: string + x-go-name: GCPPrivateKeyId + gcp_project_id: + description: Google服务账号project id (gcp) + type: string + x-go-name: GCPProjectId + host: + description: 主机IP (esxi) + type: string + x-go-name: Host + oracle_private_key: + type: string + x-go-name: OraclePrivateKey + oracle_tenancy_ocid: + type: string + x-go-name: OracleTenancyOCID + oracle_user_ocid: + type: string + x-go-name: OracleUserOCID + organization_id: + description: 飞天允许的最高组织id, 默认为1 + format: int64 + type: integer + x-go-name: OrganizationId + password: + description: 密码 (openstack, zstack, esxi) + type: string + x-go-name: Password + port: + description: 主机端口 (esxi) + format: int64 + type: integer + x-go-name: Port + project_name: + description: 账号所在的项目 (openstack) + type: string + x-go-name: ProjectName + secret_id: + description: 秘钥ID (Qcloud) + type: string + x-go-name: SecretId + secret_key: + description: 秘钥key (Qcloud) + type: string + x-go-name: SecretKey + username: + description: 用户名 (openstack, zstack, esxi) + type: string + x-go-name: Username + required: + - EndpointDomain + - DefaultRegion + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SDBInstanceAccountPrivilege: + properties: + database: + description: 数据库名称或Id + type: string + x-go-name: Database + privilege: + description: |- + 权限类型 + + + + 平台 |Rds引擎 | 支持类型 | + ---- |------- | -------- | + Aliyun |MySQL, MariaBD | rw, r, ddl, dml | + Aliyun |SQLServer | rw, r, owner | + Huawei |MySQL, MariaDB | rw, r | + 同一平台不同的rds类型支持的权限不尽相同 + type: string + x-go-name: Privilege + required: + - database + - privilege + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SDBInstanceChangeConfigInput: + properties: + DiskSizeGB: + format: int64 + type: integer + InstanceType: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SDBInstanceDatabasePrivilege: + properties: + account: + description: 数据库账号名称或Id + type: string + x-go-name: Account + privilege: + description: |- + 权限 + + + + 平台 |Rds引擎 | 支持类型 | + ---- |------- | -------- | + Aliyun |MySQL, MariaBD | rw, r, ddl, dml | + Aliyun |SQLServer | rw, r, owner | + Huawei |MySQL, MariaDB | rw, r | + 同一平台不同的rds类型支持的权限不尽相同 + type: string + x-go-name: Privilege + required: + - account + - privilege + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SDBInstanceRecoveryConfigInput: + properties: + databases: + additionalProperties: + type: string + description: 数据库信息, 例如 {"src":"dest"} 是将备份中的src数据库恢复到目标实例的dest数据库中, 阿里云此参数为必传 + example: + sdb1: ddb1 + type: object + x-go-name: Databases + dbinstancebackup_id: + description: |- + 备份Id + + + 平台 | 支持引擎 | 说明 | + ----- | ------ | --- | + 华为云 |MySQL, SQL Server | 仅SQL Server支持恢复到当前实例 | + 阿里云 |MySQL, SQL Server | MySQL要求必须开启单库单表恢复功能 并且只能是MySQL 8.0 高可用版（本地SSD盘）MySQL 5.7 高可用版（本地SSD盘）或MySQL 5.6 高可用版, MySQL仅支持恢复到当前实例| + Google |MySQL, PostgreSQL, SQL Server | PostgreSQL备份恢复时，要求实例不能有副本 | + type: string + x-go-name: DBInstancebackupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SDomainQuotaDetail: + description: 域配额详情 + properties: + cloudaccount: + format: int64 + type: integer + x-go-name: Cloudaccount + 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 + dns_zone: + format: int64 + type: integer + x-go-name: DnsZone + domain: + description: 配额适用的项目的域名称 + type: string + x-go-name: Domain + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + globalvpc: + format: int64 + type: integer + x-go-name: Globalvpc + 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/compute/models + SElasticipCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + bandwidth: + format: int64 + type: integer + x-go-name: BandwidthMb + bgp_type: + default: BGP + description: |- + 线路类型 + + + + 平台 | 支持类型 | 说明 | + --- | -------- | --- | + Aliyun | BGP, BGP_PRO(精品线路) | 部分区域不支持BGP_PRO| + type: string + x-go-name: BgpType + charge_type: + default: traffic + description: |- + 计费类型: 流量或带宽 + + + + 平台 | 支持类型 | + --- | -------- | + Aliyun | traffic, bandwidth | + 腾讯云 | traffic | + Azure | traffic | + Google | traffic, bandwidth | + Ucloud | traffic | + Aws | traffic | + 华为云 | traffic, bandwidth | + 天翼云 | traffic, bandwidth | + KVM | 不支持创建 | + VMware | 不支持创建 | + ZStack | traffic | + OpenStack | traffic | + enum: + - traffic + - ' bandwidth' + type: string + x-go-name: ChargeType + cloudregion_id: + description: |- + 区域名称或Id, 建议使用Id + 在指定区域内创建弹性公网ip + type: string + x-go-name: CloudregionId + 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 + ip_addr: + description: 指定新建EIP的地址 + type: string + x-go-name: IpAddr + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + manager_id: + description: |- + 子订阅Id, 建议使用Id + 使用指定子订阅创建弹性公网ip + 弹性公网ip和虚拟机在同一区域同一子订阅底下，才可以进行绑定操作 + type: string + x-go-name: ManagerId + mode: + type: string + x-go-name: Mode + 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 + network_id: + description: |- + 子网Id + 私有云创建此参数必传,例如Openstack, ZStack + type: string + x-go-name: NetworkId + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SEnrollmentAccount: + properties: + id: + description: Enrollment Account Id + type: string + x-go-name: Id + name: + description: Enrollment Account name + type: string + x-go-name: Name + type: + description: Enrollment Account 类型 + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SExcludeRule: + properties: + Name: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SExcludeRules: + items: + $ref: '#/definitions/SExcludeRule' + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SGPerformDetachScalingGroupInput: + properties: + auto: + description: 'description: 自动行为' + example: true + type: boolean + x-go-name: Auto + delete_server: + description: 'description: 是否删除机器' + example: false + type: boolean + x-go-name: DeleteServer + scaling_group: + description: 'description: 伸缩组 Id or Name' + example: sg-1234 + type: string + x-go-name: ScalingGroup + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SGroup: + 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 + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + force_dispersion: + type: boolean + x-go-name: ForceDispersion + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + granularity: + description: the upper limit number of guests with this group in a host + format: int64 + type: integer + x-go-name: Granularity + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + name: + description: 资源名称 + type: string + x-go-name: Name + parent_id: + type: string + x-go-name: ParentId + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + sched_strategy: + description: 调度策略 + type: string + x-go-name: SchedStrategy + service_type: + description: 服务类型 + type: string + x-go-name: ServiceType + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone_id: + type: string + x-go-name: ZoneId + title: SGroup is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SGroup. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SGuest: + properties: + admin_secgrp_id: + description: 管理员可见安全组Id + type: string + x-go-name: AdminSecgrpId + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + backup_guest_status: + type: string + x-go-name: BackupGuestStatus + backup_host_id: + description: 备份机所在宿主机Id + type: string + x-go-name: BackupHostId + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + bios: + type: string + x-go-name: Bios + boot_order: + description: 启动顺序 + type: string + x-go-name: BootOrder + cpu_sockets: + description: CPU插槽(socket)的数量 + format: int64 + type: integer + x-go-name: CpuSockets + 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 + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + flavor_id: + type: string + x-go-name: FlavorId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + host_id: + type: string + x-go-name: HostId + hostname: + type: string + x-go-name: Hostname + hypervisor: + description: 虚拟化技术 + example: kvm + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + type: string + x-go-name: InstanceType + internet_max_bandwidth_out: + description: 最大内网带宽 + format: int64 + type: integer + x-go-name: InternetMaxBandwidthOut + is_daemon: + type: boolean + x-go-name: IsDaemon + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + keypair_id: + description: 秘钥对Id + type: string + x-go-name: KeypairId + machine: + type: string + x-go-name: Machine + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + os_type: + description: 操作系统类型 + type: string + x-go-name: OsType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + power_states: + description: power_states limit in [on, off, unknown] + type: string + x-go-name: PowerStates + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + progress_mbps: + description: 迁移或克隆的速度 + format: double + type: number + x-go-name: ProgressMbps + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + qga_status: + type: string + x-go-name: QgaStatus + record_checksum: + type: string + x-go-name: RecordChecksum + rescue_mode: + description: Used for guest rescue + type: boolean + x-go-name: RescueMode + secgrp_id: + description: 安全组Id + example: default + type: string + x-go-name: SecgrpId + shutdown_behavior: + description: 关机操作类型 + example: stop + type: string + x-go-name: ShutdownBehavior + shutdown_mode: + description: 关机收费模式 + example: keep_charging, stop_charging + type: string + x-go-name: ShutdownMode + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + src_ip_check: + type: boolean + x-go-name: SrcIpCheck + src_mac_check: + type: boolean + x-go-name: SrcMacCheck + sshable_last_state: + type: boolean + x-go-name: SshableLastState + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + throughput: + description: 磁盘吞吐量 + format: int64 + type: integer + x-go-name: Throughput + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vcpu_count: + description: CPU核(core)的数量， VcpuCount = CpuSockets * (cores per socket)，例如 2颗CPU，每颗CPU8核，则 VcpuCount=2*8=16 + format: int64 + type: integer + x-go-name: VcpuCount + vdi: + type: string + x-go-name: Vdi + vga: + type: string + x-go-name: Vga + vmem_size: + description: 内存大小, 单位MB + format: int64 + type: integer + x-go-name: VmemSize + title: SGuest is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SGuest. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SHostPingInput: + properties: + memory_used_mb: + format: int64 + type: integer + x-go-name: MemoryUsedMb + root_partition_used_capacity_mb: + format: int64 + type: integer + x-go-name: RootPartitionUsedCapacityMb + storage_stats: + items: + $ref: '#/definitions/SHostStorageStat' + type: array + x-go-name: StorageStats + with_data: + type: boolean + x-go-name: WithData + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SHostStorageStat: + properties: + actual_capacity_used_mb: + format: int64 + type: integer + x-go-name: ActualCapacityUsedMb + capacity_mb: + format: int64 + type: integer + x-go-name: CapacityMb + storage_id: + type: string + x-go-name: StorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SHostTapConfig: + properties: + mirrors: + items: + $ref: '#/definitions/SMirrorConfig' + type: array + x-go-name: Mirrors + taps: + items: + $ref: '#/definitions/STapServiceConfig' + type: array + x-go-name: Taps + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SInfrasQuotaDetail: + description: 基础设施配额详情 + properties: + account: + description: 配额适用的云账号名称 + type: string + x-go-name: Account + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + 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 + host: + format: int64 + type: integer + x-go-name: Host + manager: + description: 配额适用的云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region: + description: 配额适用的区域名称 + type: string + x-go-name: Region + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + format: int64 + type: integer + x-go-name: Vpc + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SInstanceTypes: + items: + type: string + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SIsolatedDevice: + properties: + addr: + description: '# pci address of `Bus:Device.Function` format, or usb bus address of `bus.addr`' + type: string + x-go-name: Addr + 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 + description: + description: 资源描述信息 + type: string + x-go-name: Description + dev_type: + description: |- + # PCI / GPU-HPC / GPU-VGA / USB / NIC + 设备类型 + type: string + x-go-name: DevType + device_path: + type: string + x-go-name: DevicePath + disk_index: + description: guest disk index + format: uint8 + type: integer + x-go-name: DiskIndex + framebuffer: + description: The frame buffer size in Mbytes + type: string + x-go-name: Framebuffer + frl: + description: The frame rate limiter (FRL) configuration in frames per second + type: string + x-go-name: FRL + guest_id: + description: 云主机Id + type: string + x-go-name: GuestId + host_id: + type: string + x-go-name: HostId + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_infiniband_nic: + description: Is infiniband nic + type: boolean + x-go-name: IsInfinibandNic + max_instance: + description: The maximum number of vGPU instances per physical GPU + type: string + x-go-name: MaxInstance + max_resolution: + description: 'The maximum resolution per display head, eg: 5120x2880' + type: string + x-go-name: MaxResolution + mdev_id: + default: '"false" list:"domain" create:"domain_optional"`' + description: Is vgpu physical funcion, That means it cannot be attached to guest + type: string + x-go-name: MdevId + model: + description: '# Specific device name read from lspci command, e.g. `Tesla K40m` ...' + type: string + x-go-name: Model + name: + description: 资源名称 + type: string + x-go-name: Name + network_index: + description: guest network index + format: int64 + type: integer + x-go-name: NetworkIndex + num_heads: + description: |- + The maximum number of virtual display heads that the vGPU type supports + In computer graphics and display technology, the term "head" is commonly used to + describe the physical interface of a display device or display output. + It refers to a connection point on the monitor, such as HDMI, DisplayPort, or VGA interface. + type: string + x-go-name: NumHeads + numa_node: + description: device numa node + format: uint8 + type: integer + x-go-name: NumaNode + nvme_size_mb: + description: NVME disk size + format: int64 + type: integer + x-go-name: NvmeSizeMB + ovs_offload_interface: + description: Offload interface name + type: string + x-go-name: OvsOffloadInterface + pcie_info: + $ref: '#/definitions/IsolatedDevicePCIEInfo' + reserved_cpu: + description: reserved cpu count for isolated device + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: reserved memory size for isolated device + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: reserved storage size for isolated device + format: int64 + type: integer + x-go-name: ReservedStorage + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vendor_device_id: + type: string + x-go-name: VendorDeviceId + wire_id: + description: Nic wire id + type: string + x-go-name: WireId + title: SIsolatedDevice is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SIsolatedDevice. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SKafkaTopic: + properties: + Description: + type: string + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SKubeNetworkIds: + items: + type: string + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SKubeconfig: + properties: + config: + type: string + x-go-name: Config + expiration: + format: date-time + type: string + x-go-name: Expiration + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SLoadbalancerAgentDeployment: + properties: + ansible_playbook: + type: string + x-go-name: AnsiblePlaybook + ansible_playbook_undeployment: + type: string + x-go-name: AnsiblePlaybookUndeployment + host: + type: string + x-go-name: Host + title: SLoadbalancerAgentDeployment is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentDeployment. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SLoadbalancerAgentParams: + properties: + haproxy: + $ref: '#/definitions/SLoadbalancerAgentParamsHaproxy' + haproxy_conf_tmpl: + type: string + x-go-name: HaproxyConfTmpl + keepalived_conf_tmpl: + type: string + x-go-name: KeepalivedConfTmpl + telegraf: + $ref: '#/definitions/SLoadbalancerAgentParamsTelegraf' + telegraf_conf_tmpl: + type: string + x-go-name: TelegrafConfTmpl + vrrp: + $ref: '#/definitions/SLoadbalancerAgentParamsVrrp' + title: SLoadbalancerAgentParams is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentParams. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SLoadbalancerAgentParamsHaproxy: + properties: + global_log: + type: string + x-go-name: GlobalLog + global_nbthread: + format: int64 + type: integer + x-go-name: GlobalNbthread + log_http: + type: boolean + x-go-name: LogHttp + log_normal: + type: boolean + x-go-name: LogNormal + log_tcp: + type: boolean + x-go-name: LogTcp + tune_http_maxhdr: + format: int64 + type: integer + x-go-name: TuneHttpMaxhdr + title: SLoadbalancerAgentParamsHaproxy is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentParamsHaproxy. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SLoadbalancerAgentParamsTelegraf: + properties: + haproxy_input_interval: + format: int64 + type: integer + x-go-name: HaproxyInputInterval + influx_db_output_name: + type: string + x-go-name: InfluxDbOutputName + influx_db_output_unsafe_ssl: + type: boolean + x-go-name: InfluxDbOutputUnsafeSsl + influx_db_output_url: + type: string + x-go-name: InfluxDbOutputUrl + title: SLoadbalancerAgentParamsTelegraf is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentParamsTelegraf. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SLoadbalancerAgentParamsVrrp: + properties: + advert_int: + format: int64 + type: integer + x-go-name: AdvertInt + garp_master_refresh: + format: int64 + type: integer + x-go-name: GarpMasterRefresh + interface: + type: string + x-go-name: Interface + pass: + type: string + x-go-name: Pass + preempt: + type: boolean + x-go-name: Preempt + priority: + format: int64 + type: integer + x-go-name: Priority + virtual_router_id: + format: int64 + type: integer + x-go-name: VirtualRouterId + title: SLoadbalancerAgentParamsVrrp is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentParamsVrrp. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SLoadbalancerClusterParams: + properties: + advert_int: + format: int64 + type: integer + x-go-name: AdvertInt + garp_master_refresh: + format: int64 + type: integer + x-go-name: GarpMasterRefresh + pass: + type: string + x-go-name: Pass + preempt: + type: boolean + x-go-name: Preempt + virtual_router_id: + format: int64 + type: integer + x-go-name: VirtualRouterId + title: SLoadbalancerClusterParams is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerClusterParams. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SMirrorConfig: + properties: + bridge: + type: string + x-go-name: Bridge + direction: + type: string + x-go-name: Direction + flow_id: + format: uint16 + type: integer + x-go-name: FlowId + host_ip: + type: string + x-go-name: HostIp + port: + type: string + x-go-name: Port + tap_host_ip: + type: string + x-go-name: TapHostIp + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SMongoDBBackup: + properties: + BackupMethod: + $ref: '#/definitions/TMongoDBBackupMethod' + BackupSizeKb: + format: int64 + type: integer + BackupType: + $ref: '#/definitions/TMongoDBBackupType' + Description: + type: string + EndTime: + format: date-time + type: string + Name: + type: string + StartTime: + format: date-time + type: string + Status: + $ref: '#/definitions/TMongoDBBackupStatus' + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SMongoDBBackups: + properties: + Data: + items: + $ref: '#/definitions/SMongoDBBackup' + type: array + Total: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SNatDCreateInput: + properties: + ExternalIp: + type: string + ExternalPort: + format: int64 + type: integer + InternalIp: + type: string + InternalPort: + format: int64 + type: integer + IpProtocol: + type: string + Name: + type: string + NatgatewayId: + type: string + eip: + type: string + x-go-name: Eip + external_ip_id: + type: string + x-go-name: ExternalIpId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SNatSCreateInput: + properties: + Ip: + description: 'swagger: ignore' + type: string + Name: + type: string + NatgatewayId: + type: string + NetworkId: + type: string + SourceCidr: + type: string + eip: + type: string + x-go-name: Eip + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SNetworkUsedAddress: + properties: + AssociateId: + type: string + AssociateType: + type: string + CreatedAt: + format: date-time + type: string + Ip6Addr: + type: string + IpAddr: + type: string + MacAddr: + type: string + Owner: + type: string + OwnerId: + type: string + OwnerStatus: + type: string + OwnerType: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SNic: + properties: + bandwidth: + format: int64 + type: integer + x-go-name: Bandwidth + bridge: + type: string + x-go-name: Bridge + dns: + type: string + x-go-name: Dns + domain: + type: string + x-go-name: Domain + gateway: + type: string + x-go-name: Gateway + gateway6: + type: string + x-go-name: Gateway6 + index: + format: int64 + type: integer + x-go-name: Index + interface: + type: string + x-go-name: Interface + ip_addr: + type: string + x-go-name: IpAddr + ip6_addr: + type: string + x-go-name: Ip6Addr + link_up: + type: boolean + x-go-name: LinkUp + mac: + type: string + x-go-name: Mac + masklen: + format: int8 + type: integer + x-go-name: Masklen + masklen6: + format: uint8 + type: integer + x-go-name: Masklen6 + mtu: + format: int16 + type: integer + x-go-name: Mtu + net: + type: string + x-go-name: Net + net_id: + type: string + x-go-name: NetId + nic_type: + $ref: '#/definitions/TNicType' + ntp: + type: string + x-go-name: Ntp + rate: + format: int64 + type: integer + x-go-name: Rate + routes: + items: + $ref: '#/definitions/SRoute' + type: array + x-go-name: Routes + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + wire: + type: string + x-go-name: Wire + wire_id: + type: string + x-go-name: WireId + type: object + x-go-package: yunion.io/x/onecloud/pkg/cloudcommon/types + SProjectMappingAccount: + 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/compute + SProjectQuotaDetail: + 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 + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + secgroup: + format: int64 + type: integer + x-go-name: Secgroup + 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/compute/models + SProxySetting: + 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 + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + http_proxy: + type: string + x-go-name: HTTPProxy + https_proxy: + type: string + x-go-name: HTTPSProxy + 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 + name: + description: 资源名称 + type: string + x-go-name: Name + no_proxy: + type: string + x-go-name: NoProxy + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + title: SProxySetting is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudcommon/db/proxy.SProxySetting. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudcommon/proxy + SQuotaDetail: + description: 主机配额详情 + properties: + Hypervisor: + description: 主机配额适用的主机类型，参考主机List的Hypervisor列表 + type: string + account: + description: 配额适用的云账号名称 + type: string + x-go-name: Account + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + count: + description: 主机数量配额 + format: int64 + type: integer + x-go-name: Count + cpu: + description: 主机CPU核数量配额 + format: int64 + type: integer + x-go-name: Cpu + 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: + description: 主机组配额 + format: int64 + type: integer + x-go-name: Group + isolated_device: + description: 直通设备(GPU)配额 + format: int64 + type: integer + x-go-name: IsolatedDevice + manager: + description: 配额适用的云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + memory: + description: 主机内存容量配额 + format: int64 + type: integer + x-go-name: Memory + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region: + description: 配额适用的区域名称 + type: string + x-go-name: Region + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + storage: + description: 主机存储容量配额 + format: int64 + type: integer + x-go-name: Storage + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone: + description: 配额适用的可用区名称 + type: string + x-go-name: Zone + zone_id: + description: 配额适用的可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SRegionQuotaDetail: + description: 区域配额详情 + properties: + account: + description: 配额适用的云账号名称 + type: string + x-go-name: Account + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + bucket: + format: int64 + type: integer + x-go-name: Bucket + cache: + format: int64 + type: integer + x-go-name: Cache + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + 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 + eip: + format: int64 + type: integer + x-go-name: Eip + eport: + format: int64 + type: integer + x-go-name: Eport + instance_snapshot: + format: int64 + type: integer + x-go-name: InstanceSnapshot + loadbalancer: + format: int64 + type: integer + x-go-name: Loadbalancer + manager: + description: 配额适用的云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + mongodb: + format: int64 + type: integer + x-go-name: Mongodb + object_cnt: + format: int64 + type: integer + x-go-name: ObjectCnt + object_gb: + format: int64 + type: integer + x-go-name: ObjectGB + port: + format: int64 + type: integer + x-go-name: Port + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + rds: + format: int64 + type: integer + x-go-name: Rds + region: + description: 配额适用的区域名称 + type: string + x-go-name: Region + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + snapshot: + format: int64 + type: integer + x-go-name: Snapshot + 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/compute/models + SRoute: + items: + type: string + type: array + x-go-package: yunion.io/x/onecloud/pkg/cloudcommon/types + SRoutes: + items: + $ref: '#/definitions/SRoute' + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSLCertificateCreateInput: + description: 资源创建参数, 目前仅占位 + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSLCertificateDetails: + description: 资源返回详情 + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSecgroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + 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 + globalvpc_id: + description: 'swagger: ignore' + type: string + x-go-name: GlobalvpcId + 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: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + rules: + description: 规则列表 + items: + $ref: '#/definitions/SSecgroupRuleCreateInput' + type: array + x-go-name: Rules + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSecgroupRuleCreateInput: + properties: + action: + description: |- + 行为 + deny: 拒绝 + allow: 允许 + enum: + - deny + - ' allow' + type: string + x-go-name: Action + cidr: + description: ip或cidr地址, 若指定peer_secgroup_id此参数不生效 + example: 192.168.222.121 + type: string + x-go-name: CIDR + description: + description: |- + 规则描述信息 + requried: false + example: test to create rule + type: string + x-go-name: Description + direction: + description: 方向 + enum: + - in + - ' out' + type: string + x-go-name: Direction + ports: + description: |- + 端口列表, 参数为空代表任意端口 + 此参数仅对protocol是tcp, udp时生效 + 支持格式: + 格式类型 | 举例 | + -------- | ---- | + 单端口 | 22 | + 端口范围 | 100-200 | + 不连续端口| 80,443 | + requried: false + type: string + x-go-name: Ports + priority: + description: 优先级, 数字越大优先级越高 + format: int64 + maximum: 100 + minimum: 1 + type: integer + x-go-name: Priority + protocol: + description: 协议 + enum: + - any + - ' tcp' + - ' udp' + - ' icmp' + type: string + x-go-name: Protocol + secgroup_id: + description: 安全组ID + type: string + x-go-name: SecgroupId + status: + description: 'swagger: ignore' + type: string + x-go-name: Status + required: + - priority + - protocol + - direction + - action + - secgroup_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSecgroupRuleUpdateInput: + properties: + action: + description: |- + 行为 + deny: 拒绝 + allow: 允许 + enum: + - deny + - ' allow' + type: string + x-go-name: Action + cidr: + description: ip或cidr地址, 若指定peer_secgroup_id此参数不生效 + example: 192.168.222.121 + type: string + x-go-name: CIDR + description: + description: |- + 规则描述信息 + requried: false + example: test to create rule + type: string + x-go-name: Description + ports: + type: string + x-go-name: Ports + priority: + format: int64 + type: integer + x-go-name: Priority + protocol: + description: 协议 + enum: + - any + - ' tcp' + - ' udp' + - ' icmp' + type: string + x-go-name: Protocol + required: + - protocol + - action + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSimpleBackup: + properties: + backup_storage_id: + description: 备份存储Id + type: string + x-go-name: BackupStorageId + created_at: + description: 创建时间 + format: date-time + type: string + x-go-name: CreatedAt + disk_size_mb: + description: 磁盘大小 + format: int64 + type: integer + x-go-name: DiskSizeMb + disk_type: + description: 磁盘类型 + type: string + x-go-name: DiskType + encrypt_key_id: + description: 密钥 + type: string + x-go-name: EncryptKeyId + id: + description: 备份Id + type: string + x-go-name: Id + name: + description: 备份名称 + type: string + x-go-name: Name + size_mb: + description: 备份大小 + format: int64 + type: integer + x-go-name: SizeMb + status: + description: 快照状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSimpleWire: + properties: + Wire: + type: string + WireId: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSnapshotPolicyCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + repeat_weekdays: + items: + format: int64 + type: integer + type: array + x-go-name: RepeatWeekdays + retention_days: + format: int64 + type: integer + x-go-name: RetentionDays + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + time_points: + items: + format: int64 + type: integer + type: array + x-go-name: TimePoints + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSnapshotPolicyUpdateInput: + properties: + RetentionDays: + format: int64 + type: integer + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + repeat_weekdays: + items: + format: int64 + type: integer + type: array + x-go-name: RepeatWeekdays + time_points: + items: + format: int64 + type: integer + type: array + x-go-name: TimePoints + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSubAccount: + properties: + account: + description: 输入必填，若为空，需要指定子账号名称 + type: string + x-go-name: Account + default_project_id: + description: 云端服务健康状态。例如欠费、项目冻结都属于不健康状态。 + type: string + x-go-name: DefaultProjectId + desc: + description: 描述信息 + type: string + x-go-name: Desc + health_status: + type: string + x-go-name: HealthStatus + id: + type: string + x-go-name: Id + name: + description: 若Account不为空，可不传 + type: string + x-go-name: Name + title: SSubAccount is an autogenerated struct via yunion.io/x/cloudmux/pkg/cloudprovider.SSubAccount. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudprovider + 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 + STapServiceConfig: + properties: + Mirrors: + items: + $ref: '#/definitions/SMirrorConfig' + type: array + ifname: + type: string + x-go-name: Ifname + mac_addr: + type: string + x-go-name: MacAddr + tap_host_ip: + type: string + x-go-name: TapHostIp + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SWafRule: + properties: + action: + $ref: '#/definitions/DefaultAction' + 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 + description: + description: 资源描述信息 + type: string + x-go-name: Description + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + name: + description: 资源名称 + type: string + x-go-name: Name + priority: + description: 规则优先级 + format: int64 + type: integer + x-go-name: Priority + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + statement_conditon: + description: 条件 + type: string + x-go-name: StatementConditon + status: + description: 资源状态 + type: string + x-go-name: Status + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + waf_instance_id: + description: 所属waf实例id + type: string + x-go-name: WafInstanceId + waf_rule_group_id: + description: 规则组的id + type: string + x-go-name: WafRuleGroupId + title: SWafRule is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SWafRule. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SWafStatement: + description: +onecloud:model-api-gen + properties: + ExcludeRules: + $ref: '#/definitions/SExcludeRules' + ForwardedIPHeader: + type: string + IPSetId: + type: string + ManagedRuleGroupName: + description: 管理规则组名称 + type: string + MatchField: + $ref: '#/definitions/TWafMatchField' + MatchFieldKey: + description: 匹配字段的key + type: string + MatchFieldValues: + $ref: '#/definitions/TWafMatchFieldValues' + Negation: + description: 是否取反操作, 仅对Azure生效 + type: boolean + Operator: + $ref: '#/definitions/TWafOperator' + RegexSetId: + description: 正则表达式Id, 目前只读 + type: string + RuleGroupId: + description: 自定义规则组Id, 目前只读 + type: string + SearchString: + description: 搜索字段, 仅Aws有用 + type: string + Transformations: + $ref: '#/definitions/TextTransformations' + Type: + $ref: '#/definitions/TWafStatementType' + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SZoneQuotaDetail: + description: 可用区配额详情 + properties: + account: + description: 配额适用的云账号名称 + type: string + x-go-name: Account + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + 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 + manager: + description: 配额适用的云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region: + description: 配额适用的区域名称 + type: string + x-go-name: Region + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone: + description: 配额适用的可用区名称 + type: string + x-go-name: Zone + zone_id: + description: 配额适用的可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + ScalingActivityDetails: + properties: + action_desc: + description: 行为描述 + type: string + x-go-name: ActionDesc + 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 + end_time: + format: date-time + type: string + x-go-name: EndTime + id: + description: 资源UUID + type: string + x-go-name: Id + instance_number: + format: int64 + type: integer + x-go-name: InstanceNumber + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + reason: + type: string + x-go-name: Reason + scaling_group: + description: 'description: 伸缩组名称' + example: sg-nihao + type: string + x-go-name: ScalingGroup + scaling_group_id: + description: ScalingGroupId + example: sg-1234 + type: string + x-go-name: ScalingGroupId + start_time: + format: date-time + type: string + x-go-name: StartTime + status: + description: 资源状态 + type: string + x-go-name: Status + trigger_desc: + description: 起因描述 + type: string + x-go-name: TriggerDesc + 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/compute + ScalingAlarmCreateInput: + properties: + cumulate: + description: 'description: 累计次数(报警次数达到此累计次数就会触发伸缩活动)' + example: 1 + format: int64 + type: integer + x-go-name: Cumulate + cycle: + description: 'description: 监控周期，单位s' + example: 300 + format: int64 + type: integer + x-go-name: Cycle + indicator: + description: 'description: 监控指标' + enum: + - cpu + - disk_read + - disk_write + - flow_into + - flow_out + example: cpu + type: string + x-go-name: Indicator + operator: + description: 'descripion: 监控指标的比较符' + enum: + - ge + - le + example: ge + type: string + x-go-name: Operator + value: + description: 'description: 监控指标的取值' + example: 3 + format: double + type: number + x-go-name: Value + wrapper: + description: 'description: 监控指标的取值方式(比如最大值，最小值，平均值)' + enum: + - max + - min + - average + example: max + type: string + x-go-name: Wrapper + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingAlarmDetails: + properties: + cumulate: + description: 'description: 累计次数，只有到达累计次数的报警才会触发伸缩活动' + format: int64 + type: integer + x-go-name: Cumulate + cycle: + description: 'description: 监控周期' + format: int64 + type: integer + x-go-name: Cycle + indicator: + description: 'description: 指标' + type: string + x-go-name: Indicator + operator: + description: 'description: 指标和阈值之间的比较关系，>=/<=' + type: string + x-go-name: Operator + value: + description: 'description: 阈值' + format: double + type: number + x-go-name: Value + wrapper: + description: 'description: 指标的取值方式，最大值/最小值/平均值' + type: string + x-go-name: Wrapper + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingGroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + backend_group_id: + description: 'swagger: ignore' + type: string + x-go-name: BackendGroupId + cloudregion: + description: 'description: cloud region id or name' + example: cr-test-one + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 'swagger: ignore' + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + desire_instance_number: + description: 'description: 期望实例数' + example: 1 + format: int64 + type: integer + x-go-name: DesireInstanceNumber + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + expansion_principle: + description: 'description: 扩容策略' + enum: + - balanced + example: balanced + type: string + x-go-name: ExpansionPrinciple + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + 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 + guest_template: + description: 'description: 主机模板 id or name' + example: gt-test-one + type: string + x-go-name: GuestTemplate + guest_template_id: + description: 'swagger: ignore' + type: string + x-go-name: GuestTemplateId + health_check_cycle: + description: 'description: 健康检查周期' + example: 300 + format: int64 + type: integer + x-go-name: HealthCheckCycle + health_check_gov: + description: 'description: 健康检查缓冲时间' + example: 180 + format: int64 + type: integer + x-go-name: HealthCheckGov + health_check_mode: + description: 'description: 检查健康模式' + enum: + - normal + - loadbalancer + example: normal + type: string + x-go-name: HealthCheckMode + hypervisor: + description: 'description: hypervisor' + example: kvm + type: string + x-go-name: Hypervisor + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + lb_backend_group: + description: 'description: 负载均衡后端服务器组' + example: lbg-nihao + type: string + x-go-name: LbBackendGroup + loadbalancer_backend_port: + description: 'description: 负载均衡后端服务器统一端口' + example: 8080 + format: int64 + type: integer + x-go-name: LoadbalancerBackendPort + loadbalancer_backend_weight: + description: 'description: 负载均衡后端服务器的weight' + example: 10 + format: int64 + type: integer + x-go-name: LoadbalancerBackendWeight + max_instance_number: + description: 'description: 最大实例数' + example: 10 + format: int64 + type: integer + x-go-name: MaxInstanceNumber + min_instance_number: + description: 'description: 最小实例数' + example: 0 + format: int64 + type: integer + x-go-name: MinInstanceNumber + 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 + networks: + description: 'description: 多个网络(ID或者Name),' + example: n-test-one + items: + type: string + type: array + x-go-name: Networks + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + shrink_principle: + description: 'description: 缩容策略' + enum: + - earliest + - latest + - config_earliest + - config_latest + example: latest + type: string + x-go-name: ShrinkPrinciple + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + required: + - name + - cloudregion + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingGroupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + backend_group: + description: 负载均衡后端组名称 + type: string + x-go-name: BackendGroup + backend_group_id: + description: 负载均衡后端组ID + type: string + x-go-name: BackendGroupId + brand: + description: 'description: 平台' + example: OneCloud + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + desire_instance_number: + description: |- + DesireInstanceNumber represent the number of instances that should exist in the scaling group. + Scaling controller will monitor and ensure this in real time. + Scaling activities triggered by various policies will also modify this value. + This value should between MinInstanceNumber and MaxInstanceNumber + format: int64 + type: integer + x-go-name: DesireInstanceNumber + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + expansion_principle: + description: ExpansionPrinciple represent the principle when creating new instance to join in. + type: string + x-go-name: ExpansionPrinciple + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + group: + description: 实例组名称 + type: string + x-go-name: Group + group_id: + description: 实例组ID + type: string + x-go-name: GroupId + guest_template: + description: 主机模板名称 + type: string + x-go-name: GuestTemplate + guest_template_id: + description: 主机模板ID + type: string + x-go-name: GuestTemplateId + health_check_cycle: + format: int64 + type: integer + x-go-name: HealthCheckCycle + health_check_gov: + format: int64 + type: integer + x-go-name: HealthCheckGov + health_check_mode: + type: string + x-go-name: HealthCheckMode + hypervisor: + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + instance_number: + description: 'description: 实例数' + example: 0 + format: int64 + type: integer + x-go-name: InstanceNumber + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_backend_port: + format: int64 + type: integer + x-go-name: LoadbalancerBackendPort + loadbalancer_backend_weight: + format: int64 + type: integer + x-go-name: LoadbalancerBackendWeight + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + max_instance_number: + format: int64 + type: integer + x-go-name: MaxInstanceNumber + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + min_instance_number: + format: int64 + type: integer + x-go-name: MinInstanceNumber + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + description: 'description: 网络信息' + items: + $ref: '#/definitions/ScalingGroupNetwork' + type: array + x-go-name: Networks + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + scaling_policy_number: + description: 'description: 伸缩策略的数量' + example: 3 + format: int64 + type: integer + x-go-name: ScalingPolicyNumber + shrink_principle: + description: ShrinkPrinciple represent the principle when removing instance from scaling group. + type: string + x-go-name: ShrinkPrinciple + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingGroupNetwork: + properties: + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_start: + type: string + x-go-name: GuestIpStart + 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/compute + ScalingPolicyCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + action: + description: 'desciption: 伸缩策略的行为(增加还是删除或者调整为)' + enum: + - add + - remove + - set + example: add + type: string + x-go-name: Action + alarm: + $ref: '#/definitions/ScalingAlarmCreateInput' + cooling_time: + description: 'desciption: Scaling activity triggered by alarms will be rejected during this period about CoolingTime' + example: 300 + format: int64 + type: integer + x-go-name: CoolingTime + cycle_timer: + $ref: '#/definitions/CycleTimerCreateInput' + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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 + number: + description: 'desciption: 实例的数量' + example: 2 + format: int64 + type: integer + x-go-name: Number + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + scaling_group: + description: 'description: scaling_group ID or Name' + example: sg-test-one + type: string + x-go-name: ScalingGroup + scaling_group_id: + description: 'swagger: ignore' + type: string + x-go-name: ScalingGroupId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + timer: + $ref: '#/definitions/TimerCreateInput' + trigger_type: + description: 'description: trigger type' + enum: + - timing + - cycle + - alarm + type: string + x-go-name: TriggerType + unit: + description: 'desciption: 实例数量的单位' + enum: + - s + - '%' + example: s + type: string + x-go-name: Unit + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingPolicyDetails: + properties: + action: + description: Action of scaling activity + type: string + x-go-name: Action + alarm: + $ref: '#/definitions/ScalingAlarmDetails' + 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 + cooling_time: + description: Scaling activity triggered by alarms will be rejected during this period about CoolingTime + format: int64 + type: integer + x-go-name: CoolingTime + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + cycle_timer: + $ref: '#/definitions/CycleTimerDetails' + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + 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 + number: + format: int64 + type: integer + x-go-name: Number + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + scaling_group: + description: 'description: 伸缩组名称' + example: sg-nihao + type: string + x-go-name: ScalingGroup + scaling_group_id: + description: ScalingGroupId + example: sg-1234 + type: string + x-go-name: ScalingGroupId + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + timer: + $ref: '#/definitions/TimerDetails' + trigger_id: + type: string + x-go-name: TriggerId + trigger_type: + type: string + x-go-name: TriggerType + unit: + description: Unit of Number + type: string + x-go-name: Unit + 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/compute + SchedpolicyDetails: + 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 + condition: + type: string + x-go-name: Condition + 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 + 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 + resource_type: + description: 调度标签管理的资源类型 + type: string + x-go-name: ResourceType + schedtag: + description: 调度标签名称 + type: string + x-go-name: Schedtag + schedtag_id: + description: 归属调度标签ID + type: string + x-go-name: SchedtagId + strategy: + type: string + x-go-name: Strategy + 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/compute + SchedtagConfig: + properties: + id: + description: 'swagger: ignore' + type: string + x-go-name: Id + resource_type: + description: |- + 资源类型 + hosts: 宿主机 + networks: 网络 + storages: 存储 + enmu: hosts, storages, networks + type: string + x-go-name: ResourceType + strategy: + description: |- + 调度策略 + required: 必须使用 + prefer: 尽量使用 + avoid: 避免使用 + exclude: 禁止使用 + enmu: required, prefer, avoid, exclude + type: string + x-go-name: Strategy + weight: + description: 'swagger: ignore' + format: int64 + type: integer + x-go-name: Weight + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SchedtagCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + default_strategy: + description: 动态标签策略 + enum: + - exclude + - ' prefer' + - ' avoid' + type: string + x-go-name: DefaultStrategy + 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 + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + resource_type: + default: hosts + description: 资源类型 + enum: + - servers + - ' hosts' + - ' .....' + type: string + x-go-name: ResourceType + scope: + type: string + x-go-name: Scope + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SchedtagDetails: + 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 + default_strategy: + type: string + x-go-name: DefaultStrategy + 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 + dynamic_schedtag_count: + format: int64 + type: integer + x-go-name: DynamicSchedtagCount + host_count: + format: int64 + type: integer + x-go-name: HostCount + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + join_model_keyword: + type: string + x-go-name: JoinModelKeyword + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + other_count: + format: int64 + type: integer + x-go-name: OtherCount + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + resource_count: + format: int64 + type: integer + x-go-name: ResourceCount + resource_type: + description: Column(VARCHAR(16, charset='ascii'), nullable=True, default=”) + type: string + x-go-name: ResourceType + schedpolicy_count: + format: int64 + type: integer + x-go-name: SchedpolicyCount + scope: + type: string + x-go-name: Scope + server_count: + format: int64 + type: integer + x-go-name: ServerCount + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + SchedtagSetResourceInput: + properties: + resource_ids: + items: + type: string + type: array + x-go-name: ResourceIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SchedtagShortDescDetails: + properties: + default: + type: string + x-go-name: Default + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + res_name: + type: string + x-go-name: ResName + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecgroupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + admin_guest_cnt: + description: admin_secgrp_id为此安全组的云主机数量, , 不包含回收站云主机 + format: int64 + type: integer + x-go-name: AdminGuestCnt + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + globalvpc: + description: 全局VPC名称 + type: string + x-go-name: Globalvpc + globalvpc_id: + type: string + x-go-name: GlobalvpcId + guest_cnt: + description: 关联云主机数量, 不包含回收站云主机 + format: int64 + type: integer + x-go-name: GuestCnt + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_dirty: + type: boolean + x-go-name: IsDirty + 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 + loadbalancer_cnt: + description: 关联LB数量 + format: int64 + type: integer + x-go-name: LoadbalancerCnt + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + rds_cnt: + description: 关联RDS数量 + format: int64 + type: integer + x-go-name: RdsCnt + redis_cnt: + description: 关联Redis数量 + format: int64 + type: integer + x-go-name: RedisCnt + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + system_guest_cnt: + description: 关联此安全组的云主机is_system为true数量, , 不包含回收站云主机 + format: int64 + type: integer + x-go-name: SystemGuestCnt + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + total_cnt: + description: 所有关联的资源数量 + format: int64 + type: integer + x-go-name: TotalCnt + 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 + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecgroupImportRulesInput: + properties: + rules: + items: + $ref: '#/definitions/SSecgroupRuleCreateInput' + type: array + x-go-name: Rules + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecgroupRuleDetails: + properties: + action: + type: string + x-go-name: Action + 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 + cidr: + type: string + x-go-name: CIDR + 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 + direction: + type: string + x-go-name: Direction + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + ports: + type: string + x-go-name: Ports + priority: + format: int64 + type: integer + x-go-name: Priority + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + protocol: + type: string + x-go-name: Protocol + secgroup: + description: 安全组名称 + type: string + x-go-name: Secgroup + secgroup_id: + description: 本地安全组ID + type: string + x-go-name: SecgroupId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + 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/compute + SecurityGroupCloneInput: + properties: + Description: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecurityGroupSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerAssociateEipInput: + properties: + eip_id: + description: 弹性公网IP的ID + type: string + x-go-name: EipId + ip_addr: + description: 弹性IP映射的内网IP地址，可选 + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerAttachDiskInput: + properties: + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + disk_id: + type: string + x-go-name: DiskId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCPUSetInput: + properties: + cpus: + description: Specifies the CPUs that tasks in this cgroup are permitted to access. + items: + format: int64 + type: integer + type: array + x-go-name: CPUS + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCPUSetRemoveInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCPUSetRemoveResp: + properties: + done: + type: boolean + x-go-name: Done + error: + type: string + x-go-name: Error + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerChangeBandwidthInput: + properties: + bandwidth: + format: int64 + type: integer + x-go-name: Bandwidth + index: + format: int64 + type: integer + x-go-name: Index + ip_addr: + type: string + x-go-name: IpAddr + ip6_addr: + type: string + x-go-name: Ip6Addr + mac: + type: string + x-go-name: Mac + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerChangeConfigInput: + properties: + ResetTrafficLimits: + items: + $ref: '#/definitions/ServerNicTrafficLimit' + type: array + SetTrafficLimits: + items: + $ref: '#/definitions/ServerNicTrafficLimit' + type: array + auto_start: + description: 调整完配置后是否自动启动 + type: boolean + x-go-name: AutoStart + cpu_sockets: + description: |- + cpu卡槽数 + vmware 若开机调整配置时,需要保证调整前及调整后 vcpu_count / cpu_sockets 保持不变 + vmware开机调整配置同样需要注意 https://kb.vmware.com/s/article/2008405 + format: int64 + type: integer + x-go-name: CpuSockets + disks: + description: disks start from index 1, i.e. cannot change size of system disk(1st disk) + items: + $ref: '#/definitions/DiskConfig' + type: array + x-go-name: Disks + flavor: + description: 'swagger: ignore' + type: string + x-go-name: Flavor + instance_type: + description: |- + 关机且停机不收费情况下不允许调整配置 + 实例类型, 优先级高于vcpu_count和vmem_size + type: string + x-go-name: InstanceType + sku: + description: 'swagger: ignore' + type: string + x-go-name: Sku + vcpu_count: + description: cpu大小 + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size: + description: 内存大小, 1024M, 1G + type: string + x-go-name: VmemSize + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerChangeDiskStorageInput: + properties: + disk_id: + type: string + x-go-name: DiskId + keep_origin_disk: + type: boolean + x-go-name: KeepOriginDisk + target_storage_id: + type: string + x-go-name: TargetStorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerChangeIpaddrInput: + properties: + index: + format: int64 + type: integer + x-go-name: Index + ip_addr: + type: string + x-go-name: IpAddr + ip6_addr: + type: string + x-go-name: Ip6Addr + mac: + type: string + x-go-name: Mac + net_conf: + $ref: '#/definitions/NetworkConfig' + net_desc: + type: string + x-go-name: NetDesc + reserve: + type: boolean + x-go-name: Reserve + restart_network: + type: boolean + x-go-name: RestartNetwork + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerChangeStorageInput: + properties: + keep_origin_disk: + type: boolean + x-go-name: KeepOriginDisk + target_storage_id: + type: string + x-go-name: TargetStorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCreateEipInput: + properties: + auto_dellocate: + description: auto_dellocate + type: boolean + x-go-name: AutoDellocate + bandwidth: + description: Bandwidth + format: int64 + type: integer + x-go-name: Bandwidth + bgp_type: + description: bgp_type + type: string + x-go-name: BgpType + charge_type: + description: 计费方式，traffic or bandwidth + type: string + x-go-name: ChargeType + ip_addr: + description: 弹性IP映射的内网IP地址，可选 + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + __parent_task_id: + description: Used to store BaremetalConvertHypervisorTaskId + type: string + x-go-name: ParentTaskId + auto_renew: + default: false + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + auto_start: + default: false + description: |- + 创建后自动启动 + 部分云创建后会自动启动例如: 腾讯云, AWS, OpenStack, ZStack, Ucloud, Huawei, Azure, 天翼云 + type: boolean + x-go-name: AutoStart + backup: + default: false + description: 虚拟机高可用(创建备机) + type: boolean + x-go-name: Backup + baremetal_disk_configs: + description: 裸金属磁盘配置列表 + items: + $ref: '#/definitions/BaremetalDiskConfig' + type: array + x-go-name: BaremetalDiskConfigs + bios: + description: |- + BIOS类型, 若镜像是Windows，并且支持UEFI,则自动会设置为UEFI + emulate: BIOS, UEFI + type: string + x-go-name: Bios + boot_order: + default: cdn + description: |- + 启动顺序 + c: cdrome + d: disk + n: network + example: cnd + type: string + x-go-name: BootOrder + cdrom: + description: 使用ISO光盘启动, 仅KVM平台支持 + type: string + x-go-name: Cdrom + cdrom_boot_index: + format: int8 + type: integer + x-go-name: CdromBootIndex + cpu_sockets: + default: 1 + description: |- + cpu卡槽数 + 目前仅vmware支持此参数 + format: int64 + type: integer + x-go-name: CpuSockets + deploy_configs: + items: + $ref: '#/definitions/DeployConfig' + type: array + x-go-name: DeployConfigs + deploy_telegraf: + type: boolean + x-go-name: DeployTelegraf + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + disks: + description: |- + 磁盘列表,第一块磁盘为系统盘,需要指定image_id + 若指定主机快照，此参数可以为空 + items: + $ref: '#/definitions/DiskConfig' + type: array + x-go-name: Disks + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: |- + 包年包月时长 + + + 平台 |是否支持 | + ---- |------- | + KVM |否 | + ESxi |否 | + OpenStack |否 | + ZStack |否 | + Google |否 | + Azure |否 | + AWS |否 | + 腾讯云 |是 | + Aliyun |是 | + Ucloud |是 | + Huawei |是 | + 天翼云 |是 | + type: string + x-go-name: Duration + eip: + description: |- + 弹性公网IP名称或ID + 绑定已有弹性公网IP, 此参数会限制虚拟机再谈下公网IP所在的区域创建 + type: string + x-go-name: Eip + eip_auto_dellocate: + description: 是否跟随主机删除而自动释放 + type: boolean + x-go-name: EipAutoDellocate + eip_bgp_type: + description: 弹性公网IP线路类型 + type: string + x-go-name: EipBgpType + eip_bw: + description: |- + 弹性公网IP带宽 + 指定此参数后会创建新的弹性公网IP并绑定到新建的虚拟机 + 此参数优先级低于public_ip + format: int64 + type: integer + x-go-name: EipBw + eip_charge_type: + description: 弹性公网IP计费类型 + type: string + x-go-name: EipChargeType + enable_cloud_init: + default: false + description: 启用cloud-init,需要镜像装有cloud-init服务 + type: boolean + x-go-name: EnableCloudInit + enable_memclean: + type: boolean + x-go-name: EnableMemclean + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + fake_create: + description: |- + swagger: ignore + 创建测试数据，不实际创建资源 + type: boolean + x-go-name: FakeCreate + 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 + groups: + description: 主机组列表, 参数可以是主机组名称或ID,建议使用ID + items: + type: string + type: array + x-go-name: InstanceGroupIds + guest_image_id: + description: 指定用于新建主机的主机镜像ID + type: string + x-go-name: GuestImageID + hostname: + description: |- + 主机名 + 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 + 字符长度2-60个字符 + Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 + 若输入为空，则会根据资源名称自动生成主机名 + 输入不为空则会自动剔除不符合规则的字符, 并进行校验 + 若长度大于允许的最大长度，会自动截取 + type: string + x-go-name: Hostname + hypervisor: + default: kvm + description: |- + 虚拟化技术或平台 + + + + hypervisor | 技术或平台 | + ------- | ---------- | + kvm | 本地私有云 | + esxi | VMWare | + baremetal | 裸金属 | + aliyun | 阿里云 | + aws | 亚马逊 | + qcloud | 腾讯云 | + azure | 微软云 | + huawei | 华为云 | + openstack | OpenStack | + ucloud | Ucloud | + zstack | ZStack | + google | 谷歌云 | + ctyun | 天翼云 | + type: string + x-go-name: Hypervisor + instance_backup_id: + description: |- + 使用主机备份创建虚拟机, 主机快照不会重置密码及秘钥信息 + 使用主机备份创建的虚拟机将沿用之前的密码秘钥及安全组信息 + type: string + x-go-name: InstanceBackupId + instance_snapshot_id: + description: |- + 使用主机快照创建虚拟机, 主机快照不会重置密码及秘钥信息 + 使用主机快照创建的虚拟机将沿用之前的密码秘钥及安全组信息 + type: string + x-go-name: InstanceSnapshotId + instance_type: + description: |- + 套餐名称, 此参数优先级高于vcpu_count和vmem_size + 套餐可以通过 serverskus 列表获取 + esxi, openstack, zstack等私有云都统一使用provider为OneCloud的套餐 + 公有云使用各自的套餐 + type: string + x-go-name: InstanceType + is_daemon: + description: 设置为 daemon 虚机 + type: boolean + x-go-name: IsDaemon + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + isolated_devices: + description: 透传设备列表 + items: + $ref: '#/definitions/IsolatedDeviceConfig' + type: array + x-go-name: IsolatedDevices + keypair_id: + description: 秘钥对Id + type: string + x-go-name: KeypairId + login_account: + description: 登录账户 + type: string + x-go-name: LoginAccount + machine: + description: |- + Machine类型 + emulate: pc, q35 + type: string + x-go-name: Machine + 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 + nets: + description: 指定主机网络 + items: + $ref: '#/definitions/NetworkConfig' + type: array + x-go-name: Networks + password: + description: |- + 密码 + 要求: 密码长度 >= 20, 至少包含一个数字一个小写字母一个大小字母及特殊字符~`!@#$%^&*()-_=+[]{}|:';\",./<>?中的一个 + requried: false + type: string + x-go-name: Password + pod: + $ref: '#/definitions/PodCreateInput' + prefer_backup_host: + description: 主机高可用时，将备机调度到指定宿主机, 此参数仅对KVM生效 + type: string + x-go-name: PreferBackupHost + prefer_host_id: + description: 调度使用指定宿主机 + type: string + x-go-name: PreferHost + prefer_manager_id: + description: 调度使用指定的云账号 + type: string + x-go-name: PreferManager + prefer_region_id: + description: 调度到指定区域,优先级低于prefer_zone_id + type: string + x-go-name: PreferRegion + prefer_wire_id: + description: 调度使用指定二层网络, 优先级低于prefer_host_id + type: string + x-go-name: PreferWire + prefer_zone_id: + description: 调度到指定可用区,优先级低于prefer_host_id + type: string + x-go-name: PreferZone + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_ip_bw: + description: |- + 公网IP带宽(单位MB) + 若指定此参数则忽略eip相关参数 + 私有云不支持此参数 + + + 平台 |支持范围 | + ---- |------- | + 腾讯云 |按量计费1-100, 包年包月1-200 | + format: int64 + type: integer + x-go-name: PublicIpBw + public_ip_charge_type: + description: |- + 公网IP计费类型 + 默认按流量计费 + + + 类别 |说明 | + ---- |------- | + traffic |按流量计费| + bandwidth |按带宽计费| + type: string + x-go-name: PublicIpChargeType + reset_password: + description: |- + 随机密码, 若指定password参数,此参数不生效 + 若值为false并且password为空,则表示保留镜像密码 + type: boolean + x-go-name: ResetPassword + schedtags: + description: 调度标签 + items: + $ref: '#/definitions/SchedtagConfig' + type: array + x-go-name: Schedtags + secgroups: + description: 安全组Id列表 + items: + type: string + type: array + x-go-name: Secgroups + secgrp_id: + description: 安全组Id, 此参数会和secgroups参数合并 + type: string + x-go-name: SecgroupId + shutdown_behavior: + default: stop + description: |- + 关机后执行的操作 + terminate: 关机后自动删除 + emum: stop, terminate + type: string + x-go-name: ShutdownBehavior + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + suggestion: + description: DEPRECATE + type: boolean + x-go-name: Suggestion + user_data: + description: |- + 用户自定义启动脚本 + 支持 #cloud-config yaml 格式及shell脚本 + 支持特殊user data平台: Aliyun, Qcloud, Azure, Apsara, Ucloud + type: string + x-go-name: UserData + vcpu_count: + default: 1 + description: 虚拟机Cpu大小,若未指定instance_type,此参数为必传项 + format: int64 + type: integer + x-go-name: VcpuCount + vdi: + default: vnc + description: 远程连接协议 + enum: + - vnc + - ' spice' + type: string + x-go-name: Vdi + vga: + default: std + enum: + - cirros + - ' vmware' + - ' qxl' + - ' std' + type: string + x-go-name: Vga + vmem_size: + description: 虚拟机内存大小,单位Mb,若未指定instance_type,此参数为必传项 + format: int64 + type: integer + x-go-name: VmemSize + required: + - name + - disks + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCreateInstanceBackupInput: + properties: + backup_storage_id: + description: 备份存储ID + type: string + x-go-name: BackupStorageId + generate_name: + description: 主机备份的生成名称 + type: string + x-go-name: GenerateName + name: + description: 主机备份名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDelExtraOptionInput: + properties: + key: + type: string + x-go-name: Key + value: + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDeployInput: + properties: + __delete_keypair__: + description: 解绑当前虚拟机秘钥, 并清理公钥信息 + type: boolean + x-go-name: DeleteKeypair + auto_start: + description: |- + 部署完成后是否自动启动 + 若虚拟机重置密码后需要重启生效，并且当前虚拟机状态为running, 此参数默认为true + 若虚拟机状态为ready, 指定此参数后，部署完成后，虚拟机会自动启动 + type: boolean + x-go-name: AutoStart + delete_public_key: + description: |- + 清理指定公钥 + 若指定的秘钥Id和虚拟机的秘钥Id不相同, 则清理旧的公钥 + type: string + x-go-name: DeletePublicKey + deploy_configs: + description: 'swagger: ignore' + items: + $ref: '#/definitions/DeployConfig' + type: array + x-go-name: DeployConfigs + deploy_telegraf: + description: 'swagger: ignore' + type: boolean + x-go-name: DeployTelegraf + keypair: + description: 'swagger: ignore' + type: string + x-go-name: Keypair + keypair_id: + description: 秘钥Id + type: string + x-go-name: KeypairId + password: + description: 重置指定密码 + type: string + x-go-name: Password + reset_password: + description: 生成随机密码, 优先级低于password + type: boolean + x-go-name: ResetPassword + restart: + description: 'swagger: ignore' + type: boolean + x-go-name: Restart + user_data: + description: |- + 用户自定义启动脚本 + 支持 #cloud-config yaml 格式及shell脚本 + 支持特殊user data平台: Aliyun, Qcloud, Azure, Apsara, Ucloud + type: string + x-go-name: UserData + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDetachDiskInput: + properties: + disk_id: + description: 磁盘Id，若磁盘未挂载在虚拟机上，不返回错误 + type: string + x-go-name: DiskId + keep_disk: + default: false + description: 是否保留磁盘 + type: boolean + x-go-name: KeepDisk + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDetachnetworkInput: + properties: + disable_sync_config: + description: 解绑后不立即同步配置 + type: boolean + x-go-name: DisableSyncConfig + force: + description: 强制卸载，无论虚拟机的状态，仅更新数据库 + type: boolean + x-go-name: Force + ip_addr: + description: 通过IP解绑网卡, 优先级高于mac + type: string + x-go-name: IpAddr + mac: + description: 通过Mac解绑网卡, 优先级低于ip_addr + type: string + x-go-name: Mac + net_id: + description: 通过IP子网地址, 优先级最高 + type: string + x-go-name: NetId + reserve: + description: 是否保留IP地址(ip地址会进入到预留ip) + type: boolean + x-go-name: Reserve + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + admin_secgrp_id: + description: 管理员可见安全组Id + type: string + x-go-name: AdminSecgrpId + admin_security_rules: + description: 系统管理员可见的安全组规则 + type: string + x-go-name: AdminSecurityRules + attach_time: + description: list + format: date-time + type: string + x-go-name: AttachTime + auto_delete_at: + description: 自动释放时间 + format: date-time + type: string + x-go-name: AutoDeleteAt + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + backup_guest_status: + type: string + x-go-name: BackupGuestStatus + backup_guest_sync_status: + description: 主备机同步状态 + type: string + x-go-name: BackupGuestSyncStatus + backup_host_id: + description: 备份机所在宿主机Id + type: string + x-go-name: BackupHostId + backup_host_name: + description: 备份主机所在宿主机名称 + type: string + x-go-name: BackupHostName + backup_host_status: + description: 备份主机所在宿主机状态 + type: string + x-go-name: BackupHostStatus + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + bios: + type: string + x-go-name: Bios + boot_order: + description: 启动顺序 + type: string + x-go-name: BootOrder + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_recycle: + description: 是否可以回收 + type: boolean + x-go-name: CanRecycle + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cdrom: + description: Cdrom信息 + items: + $ref: '#/definitions/Cdrom' + type: array + x-go-name: Cdrom + cdrom_support: + description: 是否支持ISO启动 + type: boolean + x-go-name: CdromSupport + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + cpu_sockets: + description: CPU插槽(socket)的数量 + format: int64 + type: integer + x-go-name: CpuSockets + 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 + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + disk: + description: 磁盘大小 + example: 30720 + format: int64 + type: integer + x-go-name: DiskSizeMb + disk_count: + description: 磁盘数量 + format: int64 + type: integer + x-go-name: DiskCount + disks: + description: 磁盘概要 + type: string + x-go-name: Disks + disks_info: + description: 磁盘详情 + items: + $ref: '#/definitions/GuestDiskInfo' + type: array + x-go-name: DisksInfo + domain_id: + description: 域Id + type: string + x-go-name: DomainId + eip: + description: 浮动IP + type: string + x-go-name: Eip + eip_mode: + description: 浮动IP类型 + type: string + x-go-name: EipMode + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + flavor_id: + type: string + x-go-name: FlavorId + floppy: + description: Floppy信息 + items: + $ref: '#/definitions/Floppy' + type: array + x-go-name: Floppy + floppy_support: + description: 是否支持Floppy启动 + type: boolean + x-go-name: FloppySupport + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + gpu_count: + type: string + x-go-name: GpuCount + gpu_model: + type: string + x-go-name: GpuModel + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_enabled: + description: 宿主是否启用 + type: boolean + x-go-name: HostEnabled + host_id: + type: string + x-go-name: HostId + host_service_status: + description: 宿主机服务状态` + type: string + x-go-name: HostServiceStatus + host_sn: + description: 宿主机序列号 + type: string + x-go-name: HostSN + host_status: + description: 宿主机状态 + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + hostname: + type: string + x-go-name: Hostname + hypervisor: + description: 虚拟化技术 + example: kvm + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + type: string + x-go-name: InstanceType + internet_max_bandwidth_out: + description: 最大内网带宽 + format: int64 + type: integer + x-go-name: InternetMaxBandwidthOut + ips: + description: IP地址列表字符串 + example: 10.165.2.1,172.16.8.1 + type: string + x-go-name: IPs + is_daemon: + type: boolean + x-go-name: IsDaemon + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_gpu: + description: 是否支持GPU + type: boolean + x-go-name: IsGpu + is_prepaid_recycle: + description: common + type: boolean + x-go-name: IsPrepaidRecycle + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + isolated_devices: + description: 直通设备（GPU）列表 + items: + $ref: '#/definitions/SIsolatedDevice' + type: array + x-go-name: IsolatedDevices + keypair: + description: 密钥对 + type: string + x-go-name: Keypair + keypair_id: + description: 秘钥对Id + type: string + x-go-name: KeypairId + machine: + type: string + x-go-name: Machine + macs: + description: mac地址信息 + type: string + x-go-name: Macs + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + monitor_url: + description: 监控上报URL + type: string + x-go-name: MonitorUrl + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + description: |- + details + 网络概要 + type: string + x-go-name: Networks + nics: + description: 网卡信息 + items: + $ref: '#/definitions/GuestnetworkShortDesc' + type: array + x-go-name: Nics + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + os_name: + description: 操作系统名称 + type: string + x-go-name: OsName + os_type: + description: 操作系统类型 + type: string + x-go-name: OsType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + power_states: + description: power_states limit in [on, off, unknown] + type: string + x-go-name: PowerStates + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + progress_mbps: + description: 迁移或克隆的速度 + format: double + type: number + x-go-name: ProgressMbps + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + qga_status: + type: string + x-go-name: QgaStatus + record_checksum: + type: string + x-go-name: RecordChecksum + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + rescue_mode: + description: Used for guest rescue + type: boolean + x-go-name: RescueMode + scaling_group_id: + description: 伸缩组id + type: string + x-go-name: ScalingGroupId + scaling_status: + description: 主机在伸缩组中的状态 + type: string + x-go-name: ScalingStatus + secgroup: + description: 关联主安全组 + type: string + x-go-name: Secgroup + secgroups: + description: 关联安全组列表 + items: + $ref: '#/definitions/StandaloneShortDesc' + type: array + x-go-name: Secgroups + secgrp_id: + description: 安全组Id + example: default + type: string + x-go-name: SecgrpId + security_rules: + description: 安全组规则 + type: string + x-go-name: SecurityRules + shutdown_behavior: + description: 关机操作类型 + example: stop + type: string + x-go-name: ShutdownBehavior + shutdown_mode: + description: 关机收费模式 + example: keep_charging, stop_charging + type: string + x-go-name: ShutdownMode + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + src_ip_check: + type: boolean + x-go-name: SrcIpCheck + src_mac_check: + type: boolean + x-go-name: SrcMacCheck + sshable_last_state: + type: boolean + x-go-name: SshableLastState + status: + description: 资源状态 + type: string + x-go-name: Status + sub_ips: + description: 附属IP + items: + type: string + type: array + x-go-name: SubIPs + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + throughput: + description: 磁盘吞吐量 + format: int64 + type: integer + x-go-name: Throughput + 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 + vcpu_count: + description: CPU核(core)的数量， VcpuCount = CpuSockets * (cores per socket)，例如 2颗CPU，每颗CPU8核，则 VcpuCount=2*8=16 + format: int64 + type: integer + x-go-name: VcpuCount + vdi: + type: string + x-go-name: Vdi + vga: + type: string + x-go-name: Vga + vip: + description: VIP + type: string + x-go-name: Vip + vip_eip: + description: VIP's eip + type: string + x-go-name: VipEip + virtual_ips: + description: 虚拟机Ip列表 + type: string + x-go-name: VirtualIps + vmem_size: + description: 内存大小, 单位MB + format: int64 + type: integer + x-go-name: VmemSize + vpc: + description: 归属VPC + type: string + x-go-name: Vpc + vpc_external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: VpcExternalAccessMode + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDissociateEipInput: + properties: + auto_delete: + description: 是否自动释放 + type: boolean + x-go-name: AudoDelete + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerEjectVfdInput: + properties: + floppy_ordinal: + format: int64 + type: integer + x-go-name: FloppyOrdinal + image_id: + type: string + x-go-name: ImageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerGetCPUSetCoresResp: + properties: + host_cores: + items: + format: int64 + type: integer + type: array + x-go-name: HostCores + host_used_cores: + items: + format: int64 + type: integer + type: array + x-go-name: HostUsedCores + pinned_cores: + items: + format: int64 + type: integer + type: array + x-go-name: PinnedCores + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerGetHardwareInfoResp: + properties: + cpu: + $ref: '#/definitions/ServerHardwareInfoCPU' + disk: + items: + $ref: '#/definitions/ServerHardwareInfoDisk' + type: array + x-go-name: Disks + gpu: + items: + $ref: '#/definitions/ServerHardwareInfoGPU' + type: array + x-go-name: GPUs + memory: + $ref: '#/definitions/ServerHardwareInfoMemory' + motherboard: + $ref: '#/definitions/ServerHardwareInfoMotherboard' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerHardwareInfoCPU: + properties: + count: + format: int64 + type: integer + x-go-name: Count + model: + type: string + x-go-name: Model + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerHardwareInfoDisk: + properties: + bandwidth: + description: Disk's backend bandwidth. The unit is MB/s + format: double + type: number + x-go-name: Bandwidth + id: + type: string + x-go-name: Id + model: + type: string + x-go-name: Model + size_mb: + format: int64 + type: integer + x-go-name: SizeMB + storage_id: + type: string + x-go-name: StorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerHardwareInfoGPU: + properties: + bandwidth: + description: GPU bandwidth. The unit is GB/s + format: double + type: number + x-go-name: Bandwidth + id: + description: isolate device id + type: string + x-go-name: Id + memory_mb: + description: GPU memory size + format: int64 + type: integer + x-go-name: MemoryMB + model: + description: GPU model name + type: string + x-go-name: Model + pcie_info: + $ref: '#/definitions/IsolatedDevicePCIEInfo' + tflops: + description: TFLOPS stands for number of floating point operations per second. + format: double + type: number + x-go-name: TFLOPS + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerHardwareInfoMemory: + properties: + size_mb: + format: int64 + type: integer + x-go-name: SizeMB + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerHardwareInfoMotherboard: + properties: + manufacturer: + type: string + x-go-name: Manufacturer + model: + type: string + x-go-name: Model + oem_name: + type: string + x-go-name: OemName + sn: + type: string + x-go-name: SN + version: + type: string + x-go-name: Version + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerInsertVfdInput: + properties: + floppy_ordinal: + format: int64 + type: integer + x-go-name: FloppyOrdinal + image_id: + type: string + x-go-name: ImageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerInstanceSnapshot: + properties: + generate_name: + type: string + x-go-name: GenerateName + name: + type: string + x-go-name: Name + with_memory: + type: boolean + x-go-name: WithMemory + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerLoginInfoInput: + properties: + private_key: + type: string + x-go-name: PrivateKey + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerLoginInfoOutput: + properties: + keypair: + type: string + x-go-name: Keypair + login_key: + type: string + x-go-name: LoginKey + password: + type: string + x-go-name: Password + updated: + type: string + x-go-name: Updated + username: + type: string + x-go-name: Username + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerMigrateForecastInput: + properties: + convert_to_kvm: + type: boolean + x-go-name: ConvertToKvm + is_rescue_mode: + type: boolean + x-go-name: IsRescueMode + live_migrate: + type: boolean + x-go-name: LiveMigrate + prefer_host: + description: Deprecated + type: string + x-go-name: PreferHost + prefer_host_id: + type: string + x-go-name: PreferHostId + skip_cpu_check: + type: boolean + x-go-name: SkipCpuCheck + skip_kernel_check: + type: boolean + x-go-name: SkipKernelCheck + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerMigrateNetworkInput: + properties: + dest: + description: Destination network Id + type: string + x-go-name: Dest + src: + description: Source network Id + type: string + x-go-name: Src + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerMonitorInput: + properties: + COMMAND: + type: string + QMP: + type: boolean + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerNicTrafficLimit: + properties: + mac: + type: string + x-go-name: Mac + rx_traffic_limit: + format: int64 + type: integer + x-go-name: RxTrafficLimit + tx_traffic_limit: + format: int64 + type: integer + x-go-name: TxTrafficLimit + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerQemuInfo: + properties: + cmdline: + type: string + x-go-name: Cmdline + version: + type: string + x-go-name: Version + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerQgaCommandInput: + properties: + Command: + type: string + Timeout: + description: qga execute timeout millisecond + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerQgaGetNetworkInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerQgaGuestInfoTaskInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerQgaSetPasswordInput: + properties: + Password: + type: string + Username: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerQgaTimeoutInput: + properties: + Timeout: + description: qga execute timeout millisecond + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerRebuildRootInput: + properties: + __delete_keypair__: + description: 解绑当前虚拟机秘钥, 并清理公钥信息 + type: boolean + x-go-name: DeleteKeypair + all_disks: + type: boolean + x-go-name: AllDisks + auto_start: + type: boolean + x-go-name: AutoStart + delete_public_key: + description: |- + 清理指定公钥 + 若指定的秘钥Id和虚拟机的秘钥Id不相同, 则清理旧的公钥 + type: string + x-go-name: DeletePublicKey + deploy_configs: + description: 'swagger: ignore' + items: + $ref: '#/definitions/DeployConfig' + type: array + x-go-name: DeployConfigs + deploy_telegraf: + description: 'swagger: ignore' + type: boolean + x-go-name: DeployTelegraf + image: + description: 'swagger: ignore' + type: string + x-go-name: Image + image_id: + description: |- + 关机且停机不收费情况下不允许重装系统 + 镜像 id + type: string + x-go-name: ImageId + keypair: + description: 'swagger: ignore' + type: string + x-go-name: Keypair + keypair_id: + description: 秘钥Id + type: string + x-go-name: KeypairId + password: + description: 重置指定密码 + type: string + x-go-name: Password + reset_password: + description: 生成随机密码, 优先级低于password + type: boolean + x-go-name: ResetPassword + restart: + description: 'swagger: ignore' + type: boolean + x-go-name: Restart + user_data: + description: |- + 用户自定义启动脚本 + 支持 #cloud-config yaml 格式及shell脚本 + 支持特殊user data平台: Aliyun, Qcloud, Azure, Apsara, Ucloud + type: string + x-go-name: UserData + required: + - image_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerResetInput: + properties: + auto_start: + description: 自动启动 + type: boolean + x-go-name: AutoStart + instance_snapshot: + type: string + x-go-name: InstanceSnapshot + with_memory: + description: 恢复内存 + type: boolean + x-go-name: WithMemory + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerResizeDiskInput: + properties: + disk: + description: 'swagger: ignore' + type: string + x-go-name: Disk + disk_id: + description: 磁盘Id + type: string + x-go-name: DiskId + size: + description: 'default unit: Mb' + example: 1024; 40G; 1024M + type: string + x-go-name: Size + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerResumeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSaveGuestImageInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + auto_start: + description: 保存镜像后是否自动启动 + type: boolean + x-go-name: AutoStart + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disk_format: + description: 镜像格式 + type: string + x-go-name: DiskFormat + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + 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: 'description: indicate the resource is a system resource, which is not visible to user' + 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 + notes: + description: 备注 + type: string + x-go-name: Notes + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + protected: + description: 是否有删除保护 + type: boolean + x-go-name: Protected + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSaveImageInput: + properties: + AutoStart: + default: false + description: |- + 保存镜像后是否自动启动,若实例状态为运行中,则会先关闭实例 + 公有云若支持开机保存镜像，此参数则不生效 + type: boolean + Format: + description: 镜像格式 + type: string + GenerateName: + type: string + ImageId: + description: 'swagger: ignore' + type: string + IsPublic: + type: boolean + Name: + description: 镜像名称 + type: string + Notes: + type: string + OsArch: + description: 'swagger: ignore' + type: string + OsType: + description: 'swagger: ignore' + type: string + Restart: + description: 'swagger: ignore' + type: boolean + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSetBootIndexInput: + properties: + cdroms: + additionalProperties: + format: int8 + type: integer + description: key ordinal, value boot_index + type: object + x-go-name: Cdroms + disks: + additionalProperties: + format: int8 + type: integer + description: key index, value boot_index + type: object + x-go-name: Disks + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSetDiskIoThrottleInput: + properties: + bps: + additionalProperties: + format: int64 + type: integer + description: key disk id, value bps + type: object + x-go-name: Bps + iops: + additionalProperties: + format: int64 + type: integer + description: key disk id, value iops + type: object + x-go-name: IOPS + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSetExtraOptionInput: + properties: + key: + type: string + x-go-name: Key + value: + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSetOSInfoInput: + properties: + arch: + type: string + x-go-name: Arch + distribution: + description: 'OS distribution, e.g.: CentOS, Ubuntu, Windows Server 2016 Datacenter' + type: string + x-go-name: Distribution + type: + description: 'OS type, e.g.: Linux, Windows' + type: string + x-go-name: Type + version: + description: 'OS version, e.g: 7.9, 22.04, 6.3' + type: string + x-go-name: Version + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSetPasswordInput: + properties: + AutoStart: + type: boolean + Password: + type: string + ResetPassword: + description: deploy params + type: boolean + Username: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSkuCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudregion_id: + default: default + description: 区域名称或Id,建议使用Id + type: string + x-go-name: CloudregionId + cpu_core_count: + description: Cpu核数 + format: int64 + maximum: 256 + minimum: 1 + type: integer + x-go-name: CpuCoreCount + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + instance_type_category: + default: general_purpose + description: |- + 套餐类型 + + + + instance_type_category | 说明 | + ----- | --- | + general_purpose |通用型 | + burstable |突发性能型 | + compute_optimized |计算优化型 | + memory_optimized |内存优化型 | + storage_optimized |存储IO优化型 | + hardware_accelerated |硬件加速型 | + high_storage |高存储型 | + high_memory |高内存型 | + type: string + x-go-name: InstanceTypeCategory + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + memory_size_mb: + description: 内存大小 + format: int64 + maximum: 524288 + minimum: 512 + type: integer + x-go-name: MemorySizeMB + 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 + postpaid_status: + default: available + description: 后付费状态 + type: string + x-go-name: PostpaidStatus + prepaid_status: + default: available + description: 预付费状态 + type: string + x-go-name: PrepaidStatus + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + zone_id: + description: 可用区名称或Id, 建议使用Id + type: string + x-go-name: ZoneId + required: + - name + - cpu_core_count + - memory_size_mb + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSkuDetails: + properties: + attached_disk_count: + format: int64 + type: integer + x-go-name: AttachedDiskCount + attached_disk_size_gb: + format: int64 + type: integer + x-go-name: AttachedDiskSizeGB + attached_disk_type: + type: string + x-go-name: AttachedDiskType + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + cpu_arch: + type: string + x-go-name: CpuArch + cpu_core_count: + description: CPU 架构 x86|xarm + format: int64 + type: integer + x-go-name: CpuCoreCount + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + data_disk_max_count: + format: int64 + type: integer + x-go-name: DataDiskMaxCount + data_disk_types: + type: string + x-go-name: DataDiskTypes + 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: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + gpu_attachable: + type: boolean + x-go-name: GpuAttachable + gpu_count: + type: string + x-go-name: GpuCount + gpu_max_count: + format: int64 + type: integer + x-go-name: GpuMaxCount + gpu_spec: + type: string + x-go-name: GpuSpec + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type_category: + description: x2 + type: string + x-go-name: InstanceTypeCategory + instance_type_family: + description: SkuId string `width:"64" charset:"ascii" nullable:"false" list:"user" create:"admin_required"` // x2.large + type: string + x-go-name: InstanceTypeFamily + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + local_category: + description: 通用型 + type: string + x-go-name: LocalCategory + md5: + type: string + x-go-name: Md5 + memory_size_mb: + format: int64 + type: integer + x-go-name: MemorySizeMB + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nic_max_count: + format: int64 + type: integer + x-go-name: NicMaxCount + nic_type: + type: string + x-go-name: NicType + os_name: + type: string + x-go-name: OsName + postpaid_status: + description: 预付费资源状态 available|soldout + type: string + x-go-name: PostpaidStatus + prepaid_status: + type: string + x-go-name: PrepaidStatus + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + sys_disk_max_size_gb: + description: not required。 windows比较新的版本都是50G左右。 + format: int64 + type: integer + x-go-name: SysDiskMaxSizeGB + sys_disk_min_size_gb: + format: int64 + type: integer + x-go-name: SysDiskMinSizeGB + sys_disk_resizable: + type: boolean + x-go-name: SysDiskResizable + sys_disk_type: + type: string + x-go-name: SysDiskType + total_guest_count: + description: 绑定云主机数量 + format: int64 + type: integer + x-go-name: TotalGuestCount + 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 + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSkuUpdateInput: + properties: + attached_disk_count: + format: int64 + type: integer + x-go-name: AttachedDiskCount + attached_disk_size_gb: + format: int64 + type: integer + x-go-name: AttachedDiskSizeGB + attached_disk_type: + type: string + x-go-name: AttachedDiskType + data_disk_max_count: + format: int64 + type: integer + x-go-name: DataDiskMaxCount + data_disk_types: + type: string + x-go-name: DataDiskTypes + description: + description: 资源描述 + type: string + x-go-name: Description + gpu_attachable: + type: boolean + x-go-name: GpuAttachable + gpu_count: + format: int64 + type: integer + x-go-name: GpuCount + gpu_max_count: + format: int64 + type: integer + x-go-name: GpuMaxCount + gpu_spec: + type: string + x-go-name: GpuSpec + instance_type_category: + type: string + x-go-name: InstanceTypeCategory + instance_type_family: + type: string + x-go-name: InstanceTypeFamily + local_category: + type: string + x-go-name: LocalCategory + name: + description: 资源名称 + type: string + x-go-name: Name + nic_max_count: + format: int64 + type: integer + x-go-name: NicMaxCount + nic_type: + type: string + x-go-name: NicType + os_name: + type: string + x-go-name: OsName + postpaid_status: + default: available + description: 后付费状态 + type: string + x-go-name: PostpaidStatus + prepaid_status: + default: available + description: 预付费状态 + type: string + x-go-name: PrepaidStatus + progress: + format: float + type: number + x-go-name: Progress + sys_disk_max_size_gb: + format: int64 + type: integer + x-go-name: SysDiskMaxSizeGB + sys_disk_min_size_gb: + format: int64 + type: integer + x-go-name: SysDiskMinSizeGB + sys_disk_resizable: + type: boolean + x-go-name: SysDiskResizable + sys_disk_type: + type: string + x-go-name: SysDiskType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSnapshotAndCloneInput: + properties: + auto_delete_instance_snapshot: + description: |- + Whether delete instance snapshot automatically + 是否自动删除主机快照 + type: boolean + x-go-name: AutoDeleteInstanceSnapshot + auto_start: + description: |- + Whether auto start the cloned server + 是否自动启动 + type: boolean + x-go-name: AutoStart + count: + description: |- + number of cloned servers + 数量 + format: int64 + type: integer + x-go-name: Count + generate_name: + type: string + x-go-name: GenerateName + instance_snapshot_id: + description: ignore + type: string + x-go-name: InstanceSnapshotId + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerStopInput: + properties: + is_force: + description: 是否强制关机 + type: boolean + x-go-name: IsForce + stop_charging: + description: |- + 是否关机停止计费, 若平台不支持停止计费，此参数无作用 + 目前仅阿里云，腾讯云此参数生效 + type: boolean + x-go-name: StopCharging + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerUpdateInput: + properties: + bios: + type: string + x-go-name: Bios + boot_order: + description: 启动顺序 + type: string + x-go-name: BootOrder + description: + description: 资源描述 + type: string + x-go-name: Description + disable_delete: + description: 删除保护开关 + type: boolean + x-go-name: DisableDelete + hostname: + description: |- + 主机名 + 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 + 字符长度2-60个字符 + Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 + 若输入为空，则会根据资源名称自动生成主机名 + 输入不为空则会自动剔除不符合规则的字符, 并进行校验 + 若长度大于允许的最大长度，会自动截取 + type: string + x-go-name: Hostname + machine: + type: string + x-go-name: Machine + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + progress_mbps: + description: 'swagger: ignore' + format: float + type: number + x-go-name: ProgressMbps + shutdown_behavior: + description: 关机执行操作 + type: string + x-go-name: ShutdownBehavior + src_ip_check: + type: boolean + x-go-name: SrcIpCheck + src_mac_check: + type: boolean + x-go-name: SrcMacCheck + ssh_port: + format: int64 + type: integer + x-go-name: SshPort + vdi: + type: string + x-go-name: Vdi + vga: + type: string + x-go-name: Vga + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerUserDataInput: + properties: + user_data: + type: string + x-go-name: UserData + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerVncOutput: + description: +onecloud:model-api-gen + properties: + api_server: + description: cloudpods + type: string + x-go-name: ApiServer + connect_params: + type: string + x-go-name: ConnectParams + host: + description: kvm host ip + type: string + x-go-name: Host + host_id: + description: baremetal + type: string + x-go-name: HostId + hypervisor: + type: string + x-go-name: Hypervisor + id: + type: string + x-go-name: Id + instance_id: + type: string + x-go-name: InstanceId + instance_name: + type: string + x-go-name: InstanceName + os_name: + type: string + x-go-name: OsName + password: + type: string + x-go-name: Password + port: + format: int64 + type: integer + x-go-name: Port + protocol: + type: string + x-go-name: Protocol + region: + description: volcengine + type: string + x-go-name: Region + session: + type: string + x-go-name: Session + url: + type: string + x-go-name: Url + vnc_password: + type: string + x-go-name: VncPassword + zone: + type: string + x-go-name: Zone + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + ServiceCatalogCreateInput: + 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 + guest_template: + description: 'description: the id or name of guest template' + example: good + type: string + x-go-name: GuestTemplate + icon_url: + description: 'description: service catalog icon url' + example: https://yunion.io/files/hello.png + type: string + x-go-name: IconUrl + 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: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - guest_template + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServiceCatalogDeploy: + properties: + count: + description: 'description: the count of the new vm' + example: 1 + format: int64 + type: integer + x-go-name: Count + generate_name: + description: 'description: generate name automatically if name is repeated, and only one of name and this shoudle be given' + example: hello + type: string + x-go-name: GenerateName + name: + description: 'description: name of the new vm' + example: hello + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServiceCatalogDetails: + 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 + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + guest_template_id: + type: string + x-go-name: GuestTemplateID + icon_url: + type: string + x-go-name: IconUrl + 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 + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + ServiceCatalogUpdateInput: + properties: + guest_template: + description: 'description: the id or name of guest template' + example: good + type: string + x-go-name: GuestTemplate + icon_url: + description: 'description: service catalog icon url' + example: https://yunion.io/files/hello.png + type: string + x-go-name: IconUrl + name: + description: 'description: resource name' + example: test-network + type: string + uniqueItems: true + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SetDomainQuotaInput: + description: 设置域配额输入参数 + properties: + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + cloudaccount: + format: int64 + type: integer + x-go-name: Cloudaccount + 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 + dns_zone: + format: int64 + type: integer + x-go-name: DnsZone + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + globalvpc: + format: int64 + type: integer + x-go-name: Globalvpc + 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/compute/models + SetInfrasQuotaInput: + description: 设置基础设施配额输入参数 + properties: + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + 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 + host: + format: int64 + type: integer + x-go-name: Host + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + format: int64 + type: integer + x-go-name: Vpc + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SetProjectQuotaInput: + 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 + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + secgroup: + format: int64 + type: integer + x-go-name: Secgroup + 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/compute/models + SetQuotaInput: + description: 设置主机配额输入参数 + properties: + Hypervisor: + description: 主机配额适用的主机类型，参考主机List的Hypervisor列表 + type: string + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + count: + description: 主机数量配额 + format: int64 + type: integer + x-go-name: Count + cpu: + description: 主机CPU核数量配额 + format: int64 + type: integer + x-go-name: Cpu + 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: + description: 主机组配额 + format: int64 + type: integer + x-go-name: Group + isolated_device: + description: 直通设备(GPU)配额 + format: int64 + type: integer + x-go-name: IsolatedDevice + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + memory: + description: 主机内存容量配额 + format: int64 + type: integer + x-go-name: Memory + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + storage: + description: 主机存储容量配额 + format: int64 + type: integer + x-go-name: Storage + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone_id: + description: 配额适用的可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SetRegionQuotaInput: + description: 设置区域配额输入参数 + properties: + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + bucket: + format: int64 + type: integer + x-go-name: Bucket + cache: + format: int64 + type: integer + x-go-name: Cache + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + 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 + eip: + format: int64 + type: integer + x-go-name: Eip + eport: + format: int64 + type: integer + x-go-name: Eport + instance_snapshot: + format: int64 + type: integer + x-go-name: InstanceSnapshot + loadbalancer: + format: int64 + type: integer + x-go-name: Loadbalancer + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + mongodb: + format: int64 + type: integer + x-go-name: Mongodb + object_cnt: + format: int64 + type: integer + x-go-name: ObjectCnt + object_gb: + format: int64 + type: integer + x-go-name: ObjectGB + port: + format: int64 + type: integer + x-go-name: Port + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + rds: + format: int64 + type: integer + x-go-name: Rds + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + snapshot: + format: int64 + type: integer + x-go-name: Snapshot + 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/compute/models + SetZoneQuotaInput: + description: 设置可用区配额输入参数 + properties: + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + 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 + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone_id: + description: 配额适用的可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SharableVirtualResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharableVirtualResourceCreateInput: + 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 + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + 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 + SimpleGuest: + properties: + cache_mode: + description: 缓存模式 + type: string + x-go-name: CacheMode + driver: + description: 磁盘驱动 + type: string + x-go-name: Driver + id: + description: 主机ID + type: string + x-go-name: Id + index: + description: 磁盘序号 + format: int64 + type: integer + x-go-name: Index + name: + description: 主机名称 + type: string + x-go-name: Name + status: + description: 主机状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SimpleHost: + properties: + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SimpleNetwork: + properties: + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_start: + type: string + x-go-name: GuestIpStart + guest_ip6_end: + type: string + x-go-name: GuestIp6End + guest_ip6_start: + type: string + x-go-name: GuestIp6Start + 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/compute + SimpleSecurityGroup: + 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/compute + SimpleSnapshot: + properties: + cloudregion_id: + description: 区域Id + type: string + x-go-name: CloudregionId + created_at: + description: 创建时间 + format: date-time + type: string + x-go-name: CreatedAt + disk_type: + description: 磁盘类型 + type: string + x-go-name: DiskType + encrypt_key_id: + description: 密钥 + type: string + x-go-name: EncryptKeyId + id: + description: 快照Id + type: string + x-go-name: Id + name: + description: 快照名称 + type: string + x-go-name: Name + size: + description: 快照大小 + format: int64 + type: integer + x-go-name: Size + status: + description: 快照状态 + type: string + x-go-name: Status + storage_id: + description: 存储Id + type: string + x-go-name: StorageId + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SimpleSnapshotPolicy: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + repeat_weekdays: + items: + format: int64 + type: integer + type: array + x-go-name: RepeatWeekdays + time_points: + items: + format: int64 + type: integer + type: array + x-go-name: TimePoints + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SkipSyncResources: + items: + type: string + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SkuSyncInput: + properties: + cloudregion_ids: + description: 区域ID + items: + type: string + type: array + x-go-name: CloudregionIds + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SnapshotCreateInput: + 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 + disk_id: + description: |- + 磁盘Id + 目前仅VMware平台不支持创建快照,其余平台磁盘均支持创建快照 + type: string + x-go-name: DiskId + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - disk_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SnapshotDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + backing_disk_id: + type: string + x-go-name: BackingDiskId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + created_by: + type: string + x-go-name: CreatedBy + 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 + disk_id: + description: 磁盘Id + type: string + x-go-name: DiskId + disk_name: + description: 磁盘名称 + type: string + x-go-name: DiskName + disk_status: + description: 磁盘状态 + type: string + x-go-name: DiskStatus + disk_type: + type: string + x-go-name: DiskType + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + fake_deleted: + type: boolean + x-go-name: FakeDeleted + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + description: 云主机Id + type: string + x-go-name: GuestId + guest_status: + description: 云主机状态 + type: string + x-go-name: GuestStatus + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_sub_snapshot: + description: 是否是子快照 + type: boolean + x-go-name: IsSubSnapshot + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + location: + type: string + x-go-name: Location + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + os_type: + description: 操作系统类型 + type: string + x-go-name: OsType + out_of_chain: + type: boolean + x-go-name: OutOfChain + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + ref_count: + description: create disk from snapshot, snapshot as disk backing file + format: int64 + type: integer + x-go-name: RefCount + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + size: + description: 快照大小,单位Mb + format: int64 + type: integer + x-go-name: Size + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_id: + description: Only onecloud has StorageId + type: string + x-go-name: StorageId + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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/compute + SnapshotPolicyDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + binding_disk_count: + format: int64 + type: integer + x-go-name: BindingDiskCount + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + repeat_weekdays: + description: 1~7, 1 is Monday + items: + format: int64 + type: integer + type: array + x-go-name: RepeatWeekdays + retention_days: + format: int64 + type: integer + x-go-name: RetentionDays + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + time_points: + description: 0~23 + items: + format: int64 + type: integer + type: array + x-go-name: TimePoints + 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/compute + SnapshotPolicyDisksInput: + properties: + disk: + items: + type: string + type: array + x-go-name: Disks + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SnapshotSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StandaloneAnonResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneAnonResourceDetails: + 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 + 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 + StandaloneShortDesc: + 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 + StatusInfrasResourceBaseCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusInfrasResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceDetails: + 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 + StorageCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + CLVMVgName: + description: CLVM VG Name + type: string + Lvmlockd: + type: boolean + MasterHost: + type: string + SLVMVgName: + description: SLVM VG Name + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + medium_type: + default: ssd + description: 存储介质类型 + enum: + - rotate + - ' ssd' + - ' hybird' + type: string + x-go-name: MediumType + 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 + nfs_host: + description: 网络文件系统主机, storage_type 为 nfs 时,此参数必传 + example: 192.168.222.2 + type: string + x-go-name: NfsHost + nfs_shared_dir: + description: 网络文件系统共享目录, storage_type 为 nfs 时, 此参数必传 + example: /nfs_root/ + type: string + x-go-name: NfsSharedDir + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + rbd_client_mount_timeout: + default: 120 + description: ceph CephFS挂载超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdClientMountTimeout + rbd_key: + description: |- + ceph集群密码,若ceph集群开启cephx认证,此参数必传 + 可在ceph集群主机的/etc/ceph/ceph.client.admin.keyring文件中找到 + example: AQDigB9dtnDAKhAAxS6X4zi4BPR/lIle4nf4Dw== + type: string + x-go-name: RbdKey + rbd_mon_host: + description: |- + ceph认证主机, storage_type为 rbd 时,此参数为必传项 + 单个ip或以逗号分隔的多个ip具体可查询 /etc/ceph/ceph.conf 文件 + example: 192.168.222.3,192.168.222.4,192.168.222.99 + type: string + x-go-name: RbdMonHost + rbd_pool: + description: ceph使用的pool, storage_type为 rbd 时,此参数为必传项 + example: rbd + type: string + x-go-name: RbdPool + rbd_rados_mon_op_timeout: + default: 3 + description: ceph集群连接超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdRadosMonOpTimeout + rbd_rados_osd_op_timeout: + default: 1200 + description: ceph osd 操作超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdRadosOsdOpTimeout + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_type: + description: |- + 存储类型 + + + + storage_type | 参数 |是否必传 | 默认值 | 说明 | + -------- | ------- | -------- | -------- | --------- | + rbd | rbd_mon_host | 是 | | ceph mon_host | + rbd | rbd_pool | 是 | | ceph pool | + rbd | rbd_key | 否 | |若cephx认证开启,此参数必传 | + rbd | rbd_rados_mon_op_timeout | 否 | 3 |单位: 秒 | + rbd | rbd_rados_osd_op_timeout | 否 | 1200 |单位: 秒 | + rbd | rbd_client_mount_timeout | 否 | 120 |单位: 秒 | + nfs | nfs_host | 是 | |网络文件系统主机 | + nfs | nfs_shared_dir | 是 | |网络文件系统共享目录 | + local: 本地存储 + rbd: ceph块存储, ceph存储创建时仅会检测是否重复创建，不会具体检测认证参数是否合法，只有挂载存储时 + 计算节点会验证参数，若挂载失败，宿主机和存储不会关联，可以通过查看存储日志查找挂载失败原因 + enum: + - local + - ' rbd' + - ' nfs' + - ' gpfs' + type: string + x-go-name: StorageType + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + - storage_type + - medium_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StorageDetails: + properties: + DiskCount: + format: int64 + type: integer + HostCount: + format: int64 + type: integer + SnapshotCount: + format: int64 + type: integer + Used: + format: int64 + type: integer + Wasted: + format: int64 + type: integer + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + actual_capacity_used: + description: |- + 实际容量大小，单位Mb + we always expect actual capacity great or equal than zero, otherwise something wrong + format: int64 + type: integer + x-go-name: ActualCapacityUsed + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capacity: + description: 容量大小,单位Mb + format: int64 + type: integer + x-go-name: Capacity + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + cmtbound: + description: 超售比 + format: float + type: number + x-go-name: Cmtbound + commit_bound: + description: 超分比 + format: float + type: number + x-go-name: CommitBound + commit_rate: + description: 超分率 + format: double + type: number + x-go-name: CommitRate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + free_capacity: + description: 可使用容量 + format: int64 + type: integer + x-go-name: FreeCapacity + hosts: + items: + $ref: '#/definitions/StorageHost' + type: array + x-go-name: Hosts + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_sys_disk_store: + description: |- + indicating whether system disk can be allocated in this storage + 是否可以用作系统盘存储 + example: true + type: boolean + x-go-name: IsSysDiskStore + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + master_host: + description: master host id + type: string + x-go-name: MasterHost + medium_type: + description: 介质类型 + example: ssd + type: string + x-go-name: MediumType + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + real_time_used_capacity: + format: int64 + type: integer + x-go-name: ActualUsed + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + reserved: + description: 预留容量大小 + format: int64 + type: integer + x-go-name: Reserved + schedtags: + items: + $ref: '#/definitions/SchedtagShortDescDetails' + type: array + x-go-name: Schedtags + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_conf: + description: 存储配置信息 + type: object + x-go-name: StorageConf + storage_type: + description: 存储类型 + example: local + type: string + x-go-name: StorageType + storagecache_id: + description: 存储缓存Id + type: string + x-go-name: StoragecacheId + 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 + used_capacity: + description: 已使用容量大小 + format: int64 + type: integer + x-go-name: UsedCapacity + virtual_capacity: + description: 虚拟容量大小 + format: int64 + type: integer + x-go-name: VCapacity + waste_capacity: + description: 浪费容量大小(异常磁盘大小总和) + format: int64 + type: integer + x-go-name: WasteCapacity + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StorageForceDetachHostInput: + properties: + host_id: + description: Host id or name + type: string + x-go-name: HostId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StorageHardwareInfo: + properties: + bandwidth: + format: double + type: number + x-go-name: Bandwidth + model: + type: string + x-go-name: Model + vendor: + type: string + x-go-name: Vendor + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StorageHost: + properties: + HostStatus: + type: string + Id: + type: string + Name: + type: string + Status: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StorageShortDesc: + properties: + capacity_mb: + format: int64 + type: integer + x-go-name: CapacityMb + enabled: + type: boolean + x-go-name: Enabled + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + status: + type: string + x-go-name: Status + storage_type: + type: string + x-go-name: StorageType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StorageUpdateInput: + properties: + MasterHost: + type: string + UpdateStorageConf: + type: boolean + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + rbd_client_mount_timeout: + default: 120 + description: ceph CephFS挂载超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdClientMountTimeout + rbd_key: + description: |- + ceph集群密码,若ceph集群开启cephx认证,此参数必传 + 可在ceph集群主机的/etc/ceph/ceph.client.admin.keyring文件中找到 + example: AQDigB9dtnDAKhAAxS6X4zi4BPR/lIle4nf4Dw== + type: string + x-go-name: RbdKey + rbd_rados_mon_op_timeout: + default: 3 + description: ceph集群连接超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdRadosMonOpTimeout + rbd_rados_osd_op_timeout: + default: 1200 + description: ceph osd 操作超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdRadosOsdOpTimeout + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StoragecacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + count: + description: 缓存镜像个数 + format: int64 + type: integer + x-go-name: Count + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + host: + description: 通过一致性哈希获取的一个管理宿主机信息 + type: object + x-go-name: Host + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + master_host: + description: master host id + type: string + x-go-name: MasterHost + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + path: + description: 镜像存储地址 + type: string + x-go-name: Path + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + size: + description: 缓存镜像总大小 + format: int64 + type: integer + x-go-name: Size + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + storages: + description: 存储列表 + items: + type: string + type: array + x-go-name: Storages + 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/compute + StoragecachedimageDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + cachedimage: + description: 缓存镜像名称 + type: string + x-go-name: Cachedimage + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + host: + description: 通过一致性哈希获取的一个宿主机详情 + type: object + x-go-name: Host + image: + description: 镜像名称 + type: string + x-go-name: Image + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + reference: + description: 引用次数 + format: int64 + type: integer + x-go-name: Reference + size: + description: 镜像大小 + format: int64 + type: integer + x-go-name: Size + storagecache: + description: 存储缓存名称 + type: string + x-go-name: Storagecache + storages: + description: 存储列表 + items: + type: string + type: array + x-go-name: Storages + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SubAccounts: + properties: + accounts: + description: 若输出则是全量子账号列表，若输入，代表允许同步的子账号 + items: + $ref: '#/definitions/SSubAccount' + type: array + x-go-name: Accounts + cloudregions: + description: 若输出是云账号查询到的区域列表，若输入，代表允许同步的区域 + items: + properties: + Id: + type: string + Name: + type: string + Status: + type: string + type: object + type: array + x-go-name: Cloudregions + title: SubAccounts is an autogenerated struct via yunion.io/x/cloudmux/pkg/cloudprovider.SubAccounts. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudprovider + SubscriptonCreateInput: + properties: + enrollment_account_id: + description: EA 账号id, 可通过 cloud-account-enrollment-accounts接口获取里面的id字段 + type: string + x-go-name: EnrollmentAccountId + name: + description: 订阅名称 + type: string + x-go-name: Name + offer_type: + description: '可选值: MS-AZR-0017P(生产用途), MS-AZR-0148P(开发测试)' + type: string + x-go-name: OfferType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SyncImagesInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SyncRangeInput: + properties: + deep_sync: + type: boolean + x-go-name: DeepSync + force: + type: boolean + x-go-name: Force + full_sync: + type: boolean + x-go-name: FullSync + host: + items: + type: string + type: array + x-go-name: Host + region: + items: + type: string + type: array + x-go-name: Region + resources: + description: |- + 按资源类型同步，可输入多个 + enmu: project, compute, network, eip, loadbalancer, objectstore, rds, cache, event, cloudid, dnszone, public_ip, intervpcnetwork, saml_auth, quota, nat, nas, waf, mongodb, es, kafka, app, cdn, container, ipv6_gateway, tablestore, modelarts, vpcpeer, misc + items: + type: string + type: array + x-go-name: Resources + skip_sync_resources: + description: 'swagger: ignore' + items: + type: string + type: array + x-go-name: SkipSyncResources + xor: + description: 极速模式(差量更新) + type: boolean + x-go-name: Xor + zone: + items: + type: string + type: array + x-go-name: Zone + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TBackupStorageType: type: string - x-go-name: Status - storages: - description: 可用区底下的块存储数量 - example: 1 - format: int64 - type: integer - x-go-name: Storages - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + TBucketACLType: type: string - x-go-name: UpdatedAt - wires: - description: 可用区底下的二层网络数量 - example: 3 - format: int64 - type: integer - x-go-name: Wires - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/compute + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TMongoDBBackupMethod: + description: 备份方法 + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TMongoDBBackupStatus: + description: 备份状态 + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TMongoDBBackupType: + description: 备份方式 + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TNicType: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/apis/compute + 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 + TWafAction: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafMatchField: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafMatchFieldValues: + items: + type: string + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafOperator: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafStatementType: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafTextTransformation: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafType: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TablestoreCreateInput: + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + TablestoreDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + TablestoreUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + TextTransformations: + items: + $ref: '#/definitions/TWafTextTransformation' + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TimerCreateInput: + properties: + ExecTime: + description: 'description: 执行时间' + format: date-time + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + TimerDetails: + properties: + exec_time: + description: 'description: 执行时间' + format: date-time + type: string + x-go-name: ExecTime + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VSwitch: + properties: + distributed: + type: boolean + x-go-name: Distributed + guest_networks: + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: GuestNetworks + host_networks: + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: HostNetworks + hosts: + items: + $ref: '#/definitions/SimpleHost' + type: array + x-go-name: Hosts + 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/compute + VirtualJointResourceBaseDetails: + 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 + VirtualJointResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualResourceCreateInput: + 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_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualResourceDetails: + 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 + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VpcCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cidr_block: + description: CIDR_BLOCK + type: string + x-go-name: CidrBlock + cidr_block6: + description: CIDR_BLOCK + type: string + x-go-name: CidrBlock6 + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + 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 + globalvpc_id: + description: |- + 仅对谷歌云有用，若谷歌云订阅只有一个全局VPC，此参数可不传 + 若有多个全局VPC，谷歌云需要指定其中一个全局VPC + type: string + x-go-name: GlobalvpcId + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + accpet_vpc_peer_count: + format: int64 + type: integer + x-go-name: AcceptVpcPeerCount + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cidr_block: + description: CIDR地址段 + example: 192.168.222.0/24 + type: string + x-go-name: CidrBlock + cidr_block6: + description: CIDR for IPv6 + type: string + x-go-name: CidrBlock6 + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + direct: + description: Can it be connected directly + type: boolean + x-go-name: Direct + dns_zone_count: + description: DnsZone个数 + example: 2 + format: int64 + type: integer + x-go-name: DnsZoneCount + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + globalvpc: + description: 全局VPC名称 + type: string + x-go-name: Globalvpc + globalvpc_id: + type: string + x-go-name: GlobalvpcId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default: + description: 是否是默认VPC + example: true + type: boolean + x-go-name: IsDefault + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + natgateway_count: + description: NAT网关个数 + example: 0 + format: int64 + type: integer + x-go-name: NatgatewayCount + network_count: + description: IP子网个数 + example: 2 + format: int64 + type: integer + x-go-name: NetworkCount + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + request_vpc_peer_count: + format: int64 + type: integer + x-go-name: RequestVpcPeerCount + routetable_count: + description: 路由表个数 + example: 0 + format: int64 + type: integer + x-go-name: RoutetableCount + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + wire_count: + description: 二层网络数量 + example: 1 + format: int64 + type: integer + x-go-name: WireCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcPeeringConnectionCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Bandwidth: + description: |- + 跨区域vpc对等连接带宽，仅对腾讯云有效 + 单位Mbps,可选值 10,20,50,100,200,500,1000 + format: int64 + type: integer + PeerVpcId: + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_id: + type: string + x-go-name: VpcId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcPeeringConnectionDetails: + properties: + PeerVpcName: + type: string + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + 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' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcPeeringConnectionUpdateInput: + 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/compute + VpcSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcTopologyOutput: + properties: + name: + type: string + x-go-name: Name + status: + type: string + x-go-name: Status + wires: + items: + $ref: '#/definitions/WireTopologyOutput' + type: array + x-go-name: Wires + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcUpdateInput: + properties: + cidr_block: + description: CIDR BLOCK of IPv4 + type: string + x-go-name: CidrBlock + cidr_block6: + description: CIDR BLOCK of IPv6 + type: string + x-go-name: CidrBlock6 + description: + description: 资源描述 + type: string + x-go-name: Description + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafAddresses: + items: + type: string + title: WafAddresses is an autogenerated struct via yunion.io/x/cloudmux/pkg/cloudprovider.WafAddresses. + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudprovider + WafIPSetCacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + 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 + waf_ip_set_id: + type: string + x-go-name: WafIPSetId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafIPSetDetails: + properties: + addresses: + $ref: '#/definitions/WafAddresses' + 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_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafInstanceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + CloudResources: + description: |- + 关联云资源列表 + 阿里云要求输入此参数或source_ips + items: + $ref: '#/definitions/SCloudResource' + type: array + DefaultAction: + $ref: '#/definitions/DefaultAction' + Type: + $ref: '#/definitions/TWafType' + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + 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 + source_ips: + $ref: '#/definitions/WafSourceIps' + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafInstanceDetails: + properties: + Rules: + items: + $ref: '#/definitions/SWafRule' + type: array + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + default_action: + $ref: '#/definitions/DefaultAction' + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + 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/compute + WafRegexPatterns: + items: + type: string + title: WafRegexPatterns is an autogenerated struct via yunion.io/x/cloudmux/pkg/cloudprovider.WafRegexPatterns. + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudprovider + WafRegexSetCacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + 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 + waf_regex_set_id: + type: string + x-go-name: WafRegexSetId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRegexSetDetails: + 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 + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + regex_patterns: + $ref: '#/definitions/WafRegexPatterns' + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Statements: + description: 条件表达式 + items: + $ref: '#/definitions/SWafStatement' + type: array + action: + $ref: '#/definitions/DefaultAction' + 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 + priority: + description: |- + 优先级,不可重复 + Azure优先级范围1-100 + format: int64 + type: integer + x-go-name: Priority + statement_condition: + description: 'enmu: and, or, not' + type: string + x-go-name: StatementCondition + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + waf_instance_id: + description: WAF实例Id + type: string + x-go-name: WafInstanceId + waf_rule_group_id: + description: |- + swagger: ignore + WAF规则组Id + type: string + x-go-name: WafRuleGroupId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleDetails: + properties: + Statements: + items: + $ref: '#/definitions/SWafStatement' + type: array + action: + $ref: '#/definitions/DefaultAction' + 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 + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + priority: + description: 规则优先级 + format: int64 + type: integer + x-go-name: Priority + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + statement_conditon: + description: 条件 + type: string + x-go-name: StatementConditon + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + waf_instance_id: + description: 所属waf实例id + type: string + x-go-name: WafInstanceId + waf_rule_group_id: + description: 规则组的id + type: string + x-go-name: WafRuleGroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleGroupCacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + 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 + waf_rule_group_id: + type: string + x-go-name: WafRuleGroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleGroupDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + 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 + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + waf_type: + description: 支持的WAF类型,仅is_system=true时有效 + type: string + x-go-name: WafType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleUpdateInput: + properties: + Statements: + description: 条件表达式 + items: + $ref: '#/definitions/SWafStatement' + type: array + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafSourceIps: + items: + type: string + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + WafSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + bandwidth: + default: 0 + description: '带宽大小,单位: Mbps' + format: int64 + type: integer + x-go-name: Bandwidth + bw: + description: Deprecated + format: int64 + type: integer + x-go-name: Bw + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + 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 + mtu: + default: 0 + description: mtu + format: int64 + maximum: 1000000 + minimum: 0 + type: integer + x-go-name: Mtu + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + bandwidth: + description: 带宽大小, 单位Mbps + example: 1000 + format: int64 + type: integer + x-go-name: Bandwidth + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + host_count: + description: Host数量 + example: 1 + format: int64 + type: integer + x-go-name: HostCount + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default_vpc: + description: 是否为经典网络 + type: boolean + x-go-name: IsDefaultVpc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + mtu: + description: MTU + example: 1500 + format: int64 + type: integer + x-go-name: Mtu + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + description: IP子网数量 + example: 1 + format: int64 + type: integer + x-go-name: Networks + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireMergeFromInput: + properties: + merge_network: + description: 'description: if merge networks under wire' + type: boolean + x-go-name: MergeNetwork + sources: + description: 'description: wire ids or names to be merged from' + items: + type: string + type: array + x-go-name: Sources + required: + - sources + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireMergeInput: + properties: + merge_network: + description: 'description: if merge networks under wire' + type: boolean + x-go-name: MergeNetwork + target: + description: 'description: wire id or name to be merged' + example: test-wire + type: string + x-go-name: Target + required: + - target + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireMergeNetworkInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireTopologyOutput: + properties: + bandwidth: + format: int64 + type: integer + x-go-name: Bandwidth + hosts: + items: + $ref: '#/definitions/HostTopologyOutput' + type: array + x-go-name: Hosts + name: + type: string + x-go-name: Name + networks: + items: + $ref: '#/definitions/NetworkTopologyOutput' + type: array + x-go-name: Networks + status: + type: string + x-go-name: Status + zone: + type: string + x-go-name: Zone + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireUpdateInput: + properties: + bandwidth: + description: bandwidth in MB + format: int64 + type: integer + x-go-name: Bandwidth + description: + description: 资源描述 + type: string + x-go-name: Description + mtu: + description: MTU + example: 1500 + format: int64 + type: integer + x-go-name: Mtu + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ZoneCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Cloudregion: + description: 区域名称或Id,建议使用Id + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ZoneDetails: + properties: + baremetals: + description: 可用区底下的裸金属服务器数量 + example: 1 + format: int64 + type: integer + x-go-name: Baremetals + baremetals_enabled: + description: 可用区底下启用的裸金属服务器数量 + example: 1 + format: int64 + type: integer + x-go-name: BaremetalsEnabled + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + contacts: + type: string + x-go-name: Contacts + 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 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + hosts: + description: 可用区底下的宿主机数量 + example: 3 + format: int64 + type: integer + x-go-name: Hosts + hosts_enabled: + description: 可用区底下启用的宿主机数量 + example: 2 + format: int64 + type: integer + x-go-name: HostsEnabled + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + location: + type: string + x-go-name: Location + manager_uri: + type: string + x-go-name: ManagerUri + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + name_cn: + type: string + x-go-name: NameCn + networks: + description: 可用区底下的子网数量 + example: 1 + format: int64 + type: integer + x-go-name: Networks + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storages: + description: 可用区底下的块存储数量 + example: 1 + format: int64 + type: integer + x-go-name: Storages + 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 + wires: + description: 可用区底下的二层网络数量 + example: 3 + format: int64 + type: integer + x-go-name: Wires + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ZonePurgeInput: + properties: + manager_id: + description: 云订阅Id, 若zone底下不存在任何资源,会删除当前zone + type: string + x-go-name: ManagerId + required: + - manager_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute host: '"127.0.0.1:8889"' info: - contact: - email: lizexi@yunion.cn - name: Zexi Li - description: Compute API - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html - version: "1.0" + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Cloudprovider API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" paths: - /access_group_caches: - get: - description: 列表 - operationId: access_group_cache_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 权限组Id - in: query - name: access_group_id - type: string - x-go-name: AccessGroupId - - description: 以权限组排序 - in: query - name: order_by_access_group - type: string - x-go-name: OrderByAccessGroup - responses: - "200": - $ref: '#/responses/access_group_cache_ListItemFilterOutput' - summary: 列表 - tags: - - access_group_cache - post: - description: 新建 - operationId: access_group_cache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - access_group_cache: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_cache_ValidateCreateDataOutput' - summary: 新建 - tags: - - access_group_cache - /access_group_caches/{id}: - delete: - description: 删除 - operationId: access_group_cache_CustomizeDelete - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_cache_CustomizeDeleteOutput' - summary: 删除 - tags: - - access_group_cache - get: - description: 获取详情 - operationId: access_group_cache_FetchCustomizeColumns - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_cache_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - access_group_cache - put: - description: 更新 - operationId: access_group_cache_ValidateUpdateData - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group_cache: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_cache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - access_group_cache - /access_group_caches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: access_group_cache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_cache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - access_group_cache - post: - description: 执行操作ClassMetadata - operationId: access_group_cache_PerformClassMetadata - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_cache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - access_group_cache - /access_group_caches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: access_group_cache_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 access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_cache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - access_group_cache - /access_group_caches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: access_group_cache_PerformSetClassMetadata - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_cache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - access_group_cache - /access_group_caches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: access_group_cache_PerformSetUserMetadata - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_cache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - access_group_cache - /access_group_caches/{id}/status: - get: - description: 获取指定信息Status - operationId: access_group_cache_GetDetailsStatus - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_cache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - access_group_cache - post: - description: 执行操作Status - operationId: access_group_cache_PerformStatus - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group_cache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_cache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - access_group_cache - /access_group_caches/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: access_group_cache_PerformSyncstatus - parameters: - - description: The Id or Name of access_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group_cache: - $ref: '#/definitions/MountTargetSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_cache_PerformSyncstatusOutput' - summary: 同步权限组缓存状态 - tags: - - access_group_cache - /access_group_caches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: access_group_cache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/access_group_cache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - access_group_cache - /access_group_caches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: access_group_cache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - access_group_cache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_cache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - access_group_cache - /access_group_caches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: access_group_cache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/access_group_cache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - access_group_cache - /access_group_caches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: access_group_cache_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/access_group_cache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - access_group_cache - /access_group_caches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: access_group_cache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/access_group_cache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - access_group_cache - /access_group_caches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: access_group_cache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/access_group_cache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - access_group_cache - /access_group_caches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: access_group_cache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/access_group_cache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - access_group_cache - /access_group_rules: - get: - description: 列表 - operationId: access_group_rule_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 权限组Id - in: query - name: access_group_id - type: string - x-go-name: AccessGroupId - - description: 以权限组排序 - in: query - name: order_by_access_group - type: string - x-go-name: OrderByAccessGroup - responses: - "200": - $ref: '#/responses/access_group_rule_ListItemFilterOutput' - summary: 权限组规则列表 - tags: - - access_group_rule - post: - description: 新建 - operationId: access_group_rule_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - access_group_rule: - $ref: '#/definitions/AccessGroupRuleCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_rule_ValidateCreateDataOutput' - summary: 创建权限组规则 - tags: - - access_group_rule - /access_group_rules/{id}: - delete: - description: 删除 - operationId: access_group_rule_CustomizeDelete - parameters: - - description: The Id or Name of access_group_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_rule_CustomizeDeleteOutput' - summary: 删除 - tags: - - access_group_rule - get: - description: 获取详情 - operationId: access_group_rule_FetchCustomizeColumns - parameters: - - description: The Id or Name of access_group_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_rule_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - access_group_rule - put: - description: 更新 - operationId: access_group_rule_ValidateUpdateData - parameters: - - description: The Id or Name of access_group_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group_rule: - $ref: '#/definitions/AccessGroupRuleUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_rule_ValidateUpdateDataOutput' - summary: 更新 - tags: - - access_group_rule - /access_group_rules/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: access_group_rule_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/access_group_rule_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - access_group_rule - /access_group_rules/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: access_group_rule_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - access_group_rule: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_rule_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - access_group_rule - /access_group_rules/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: access_group_rule_GetPropertySplitable - responses: - "200": - $ref: '#/responses/access_group_rule_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - access_group_rule - /access_group_rules/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: access_group_rule_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/access_group_rule_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - access_group_rule - /access_groups: - get: - description: 列表 - operationId: access_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 - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - responses: - "200": - $ref: '#/responses/access_group_ListItemFilterOutput' - summary: 列表 - tags: - - access_group - post: - description: 新建 - operationId: access_group_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - access_group: - $ref: '#/definitions/AccessGroupCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_ValidateCreateDataOutput' - summary: 新建 - tags: - - access_group - /access_groups/{id}: - delete: - description: 删除 - operationId: access_group_CustomizeDelete - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_CustomizeDeleteOutput' - summary: 删除 - tags: - - access_group - get: - description: 获取详情 - operationId: access_group_FetchCustomizeColumns - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - access_group - put: - description: 更新 - operationId: access_group_ValidateUpdateData - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_ValidateUpdateDataOutput' - summary: 更新 - tags: - - access_group - /access_groups/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: access_group_PerformChangeOwner - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - access_group - /access_groups/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: access_group_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - access_group - /access_groups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: access_group_GetDetailsClassMetadata - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - access_group - post: - description: 执行操作ClassMetadata - operationId: access_group_PerformClassMetadata - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - access_group - /access_groups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: access_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 access_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - access_group - /access_groups/{id}/private: - post: - description: 执行操作Private - operationId: access_group_PerformPrivate - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_PerformPrivateOutput' - summary: 执行操作Private - tags: - - access_group - /access_groups/{id}/public: - post: - description: 执行操作Public - operationId: access_group_PerformPublic - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_PerformPublicOutput' - summary: 执行操作Public - tags: - - access_group - /access_groups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: access_group_PerformSetClassMetadata - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - access_group - /access_groups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: access_group_PerformSetUserMetadata - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - access_group - /access_groups/{id}/status: - get: - description: 获取指定信息Status - operationId: access_group_GetDetailsStatus - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/access_group_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - access_group - post: - description: 执行操作Status - operationId: access_group_PerformStatus - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_PerformStatusOutput' - summary: 更新资源状态 - tags: - - access_group - /access_groups/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: access_group_PerformSyncstatus - parameters: - - description: The Id or Name of access_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - access_group: - $ref: '#/definitions/MountTargetSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_PerformSyncstatusOutput' - summary: 同步权限组状态 - tags: - - access_group - /access_groups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: access_group_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/access_group_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - access_group - /access_groups/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: access_group_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/access_group_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - access_group - /access_groups/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: access_group_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/access_group_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - access_group - /access_groups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: access_group_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - access_group: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/access_group_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - access_group - /access_groups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: access_group_GetPropertySplitable - responses: - "200": - $ref: '#/responses/access_group_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - access_group - /access_groups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: access_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/access_group_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - access_group - /access_groups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: access_group_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/access_group_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - access_group - /access_groups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: access_group_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/access_group_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - access_group - /access_groups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: access_group_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/access_group_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - access_group - /app_environments: - get: - description: 列表 - operationId: app_environment_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - in: query - name: AppId - type: string - - in: query - name: InstanceType - type: string - responses: - "200": - $ref: '#/responses/app_environment_ListItemFilterOutput' - summary: 列表 - tags: - - app_environment - post: - description: 新建 - operationId: app_environment_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - app_environment: - $ref: '#/definitions/VirtualResourceCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_ValidateCreateDataOutput' - summary: 新建 - tags: - - app_environment - /app_environments/{id}: - delete: - description: 删除 - operationId: app_environment_CustomizeDelete - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_environment_CustomizeDeleteOutput' - summary: 删除 - tags: - - app_environment - get: - description: 获取详情 - operationId: app_environment_FetchCustomizeColumns - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_environment_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - app_environment - put: - description: 更新 - operationId: app_environment_ValidateUpdateData - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app_environment: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_ValidateUpdateDataOutput' - summary: 更新 - tags: - - app_environment - /app_environments/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: app_environment_PerformCancelDelete - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_environment_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - app_environment - /app_environments/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: app_environment_PerformChangeOwner - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app_environment: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - app_environment - /app_environments/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: app_environment_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_environment_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - app_environment - /app_environments/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: app_environment_GetDetailsClassMetadata - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_environment_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - app_environment - post: - description: 执行操作ClassMetadata - operationId: app_environment_PerformClassMetadata - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app_environment: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - app_environment - /app_environments/{id}/freeze: - post: - description: 执行操作Freeze - operationId: app_environment_PerformFreeze - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app_environment: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - app_environment - /app_environments/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: app_environment_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 app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_environment_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - app_environment - /app_environments/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: app_environment_PerformSetClassMetadata - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app_environment: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - app_environment - /app_environments/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: app_environment_PerformSetUserMetadata - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app_environment: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - app_environment - /app_environments/{id}/status: - get: - description: 获取指定信息Status - operationId: app_environment_GetDetailsStatus - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_environment_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - app_environment - post: - description: 执行操作Status - operationId: app_environment_PerformStatus - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app_environment: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_PerformStatusOutput' - summary: 更新资源状态 - tags: - - app_environment - /app_environments/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: app_environment_PerformUnfreeze - parameters: - - description: The Id or Name of app_environment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app_environment: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - app_environment - /app_environments/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: app_environment_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/app_environment_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - app_environment - /app_environments/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: app_environment_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/app_environment_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - app_environment - /app_environments/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: app_environment_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/app_environment_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - app_environment - /app_environments/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: app_environment_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/app_environment_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - app_environment - /app_environments/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: app_environment_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/app_environment_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - app_environment - /app_environments/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: app_environment_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - app_environment: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_environment_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - app_environment - /app_environments/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: app_environment_GetPropertySplitable - responses: - "200": - $ref: '#/responses/app_environment_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - app_environment - /app_environments/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: app_environment_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/app_environment_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - app_environment - /app_environments/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: app_environment_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/app_environment_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - app_environment - /app_environments/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: app_environment_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/app_environment_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - app_environment - /app_environments/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: app_environment_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/app_environment_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - app_environment - /apps: - get: - description: 列表 - operationId: app_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - in: query - name: tech_stack - type: string - x-go-name: TechStack - responses: - "200": - $ref: '#/responses/app_ListItemFilterOutput' - summary: 列表 - tags: - - app - post: - description: 新建 - operationId: app_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - app: - $ref: '#/definitions/VirtualResourceCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_ValidateCreateDataOutput' - summary: 新建 - tags: - - app - /apps/{id}: - delete: - description: 删除 - operationId: app_CustomizeDelete - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_CustomizeDeleteOutput' - summary: 删除 - tags: - - app - get: - description: 获取详情 - operationId: app_FetchCustomizeColumns - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - app - put: - description: 更新 - operationId: app_ValidateUpdateData - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_ValidateUpdateDataOutput' - summary: 更新 - tags: - - app - /apps/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: app_PerformCancelDelete - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - app - /apps/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: app_PerformChangeOwner - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - app - /apps/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: app_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - app - /apps/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: app_GetDetailsClassMetadata - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - app - post: - description: 执行操作ClassMetadata - operationId: app_PerformClassMetadata - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - app - /apps/{id}/freeze: - post: - description: 执行操作Freeze - operationId: app_PerformFreeze - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - app - /apps/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: app_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 app - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - app - /apps/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: app_PerformRemoteUpdate - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app: - $ref: '#/definitions/MongoDBRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - app - /apps/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: app_PerformSetClassMetadata - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - app - /apps/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: app_PerformSetUserMetadata - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - app - /apps/{id}/status: - get: - description: 获取指定信息Status - operationId: app_GetDetailsStatus - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - app - post: - description: 执行操作Status - operationId: app_PerformStatus - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_PerformStatusOutput' - summary: 更新资源状态 - tags: - - app - /apps/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: app_PerformSyncstatus - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/app_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - app - /apps/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: app_PerformUnfreeze - parameters: - - description: The Id or Name of app - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - app: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - app - /apps/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: app_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/app_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - app - /apps/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: app_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/app_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - app - /apps/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: app_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/app_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - app - /apps/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: app_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/app_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - app - /apps/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: app_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/app_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - app - /apps/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: app_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - app: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/app_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - app - /apps/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: app_GetPropertySplitable - responses: - "200": - $ref: '#/responses/app_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - app - /apps/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: app_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/app_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - app - /apps/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: app_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/app_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - app - /apps/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: app_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/app_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - app - /apps/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: app_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/app_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - app - /backup_storages: - get: - description: 列表 - operationId: backup_storage_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - responses: - "200": - $ref: '#/responses/backup_storage_ListItemFilterOutput' - summary: 列表 - tags: - - backup_storage - post: - description: 新建 - operationId: backup_storage_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/BackupStorageCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_ValidateCreateDataOutput' - summary: 新建 - tags: - - backup_storage - /backup_storages/{id}: - delete: - description: 删除 - operationId: backup_storage_CustomizeDelete - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/backup_storage_CustomizeDeleteOutput' - summary: 删除 - tags: - - backup_storage - get: - description: 获取详情 - operationId: backup_storage_FetchCustomizeColumns - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/backup_storage_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - backup_storage - put: - description: 更新 - operationId: backup_storage_ValidateUpdateData - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_ValidateUpdateDataOutput' - summary: 更新 - tags: - - backup_storage - /backup_storages/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: backup_storage_PerformChangeOwner - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - backup_storage - /backup_storages/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: backup_storage_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/backup_storage_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - backup_storage - /backup_storages/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: backup_storage_GetDetailsClassMetadata - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/backup_storage_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - backup_storage - post: - description: 执行操作ClassMetadata - operationId: backup_storage_PerformClassMetadata - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - backup_storage - /backup_storages/{id}/disable: - post: - description: 执行操作Disable - operationId: backup_storage_PerformDisable - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformDisableOutput' - summary: 禁用资源 - tags: - - backup_storage - /backup_storages/{id}/enable: - post: - description: 执行操作Enable - operationId: backup_storage_PerformEnable - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformEnableOutput' - summary: 启用资源 - tags: - - backup_storage - /backup_storages/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: backup_storage_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 backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/backup_storage_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - backup_storage - /backup_storages/{id}/private: - post: - description: 执行操作Private - operationId: backup_storage_PerformPrivate - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformPrivateOutput' - summary: 执行操作Private - tags: - - backup_storage - /backup_storages/{id}/public: - post: - description: 执行操作Public - operationId: backup_storage_PerformPublic - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformPublicOutput' - summary: 执行操作Public - tags: - - backup_storage - /backup_storages/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: backup_storage_PerformSetClassMetadata - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - backup_storage - /backup_storages/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: backup_storage_PerformSetUserMetadata - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - backup_storage - /backup_storages/{id}/status: - get: - description: 获取指定信息Status - operationId: backup_storage_GetDetailsStatus - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/backup_storage_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - backup_storage - post: - description: 执行操作Status - operationId: backup_storage_PerformStatus - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformStatusOutput' - summary: 更新资源状态 - tags: - - backup_storage - /backup_storages/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: backup_storage_PerformSyncstatus - parameters: - - description: The Id or Name of backup_storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/DiskBackupSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - backup_storage - /backup_storages/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: backup_storage_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/backup_storage_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - backup_storage - /backup_storages/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: backup_storage_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/backup_storage_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - backup_storage - /backup_storages/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: backup_storage_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/backup_storage_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - backup_storage - /backup_storages/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: backup_storage_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - backup_storage: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/backup_storage_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - backup_storage - /backup_storages/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: backup_storage_GetPropertySplitable - responses: - "200": - $ref: '#/responses/backup_storage_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - backup_storage - /backup_storages/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: backup_storage_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/backup_storage_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - backup_storage - /backup_storages/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: backup_storage_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/backup_storage_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - backup_storage - /backup_storages/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: backup_storage_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/backup_storage_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - backup_storage - /backup_storages/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: backup_storage_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/backup_storage_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - backup_storage - /baremetalagents: - get: - description: 列表 - operationId: baremetalagent_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: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 以状态过滤 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以IP地址过滤 - in: query - items: - type: string - name: access_ip - type: array - x-go-name: AccessIp - - description: 以AgentType过滤 - in: query - items: - type: string - name: agent_type - type: array - x-go-name: AgentType - responses: - "200": - $ref: '#/responses/baremetalagent_ListItemFilterOutput' - summary: 管理代理服务列表 - tags: - - baremetalagent - post: - description: 新建 - operationId: baremetalagent_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - baremetalagent: - $ref: '#/definitions/BaremetalagentCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/baremetalagent_ValidateCreateDataOutput' - summary: 新建 - tags: - - baremetalagent - /baremetalagents/{id}: - delete: - description: 删除 - operationId: baremetalagent_CustomizeDelete - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_CustomizeDeleteOutput' - summary: 删除 - tags: - - baremetalagent - get: - description: 获取详情 - operationId: baremetalagent_FetchCustomizeColumns - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - baremetalagent - put: - description: 更新 - operationId: baremetalagent_ValidateUpdateData - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - baremetalagent: - $ref: '#/definitions/BaremetalagentUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/baremetalagent_ValidateUpdateDataOutput' - summary: 更新 - tags: - - baremetalagent - /baremetalagents/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: baremetalagent_GetDetailsClassMetadata - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - baremetalagent - post: - description: 执行操作ClassMetadata - operationId: baremetalagent_PerformClassMetadata - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - baremetalagent: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/baremetalagent_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - baremetalagent - /baremetalagents/{id}/disable: - post: - description: 执行操作Disable - operationId: baremetalagent_PerformDisable - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_PerformDisableOutput' - summary: 执行操作Disable - tags: - - baremetalagent - /baremetalagents/{id}/disable-image-cache: - post: - description: 执行操作DisableImageCache - operationId: baremetalagent_PerformDisableImageCache - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_PerformDisableImageCacheOutput' - summary: 执行操作DisableImageCache - tags: - - baremetalagent - /baremetalagents/{id}/enable: - post: - description: 执行操作Enable - operationId: baremetalagent_PerformEnable - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_PerformEnableOutput' - summary: 执行操作Enable - tags: - - baremetalagent - /baremetalagents/{id}/enable-image-cache: - post: - description: 执行操作EnableImageCache - operationId: baremetalagent_PerformEnableImageCache - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_PerformEnableImageCacheOutput' - summary: 执行操作EnableImageCache - tags: - - baremetalagent - /baremetalagents/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: baremetalagent_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 baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - baremetalagent - /baremetalagents/{id}/offline: - post: - description: 执行操作Offline - operationId: baremetalagent_PerformOffline - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_PerformOfflineOutput' - summary: 执行操作Offline - tags: - - baremetalagent - /baremetalagents/{id}/online: - post: - description: 执行操作Online - operationId: baremetalagent_PerformOnline - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/baremetalagent_PerformOnlineOutput' - summary: 执行操作Online - tags: - - baremetalagent - /baremetalagents/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: baremetalagent_PerformSetClassMetadata - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - baremetalagent: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/baremetalagent_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - baremetalagent - /baremetalagents/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: baremetalagent_PerformSetUserMetadata - parameters: - - description: The Id or Name of baremetalagent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - baremetalagent: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/baremetalagent_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - baremetalagent - /baremetalagents/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: baremetalagent_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/baremetalagent_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - baremetalagent - /baremetalagents/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: baremetalagent_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - baremetalagent: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/baremetalagent_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - baremetalagent - /baremetalagents/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: baremetalagent_GetPropertySplitable - responses: - "200": - $ref: '#/responses/baremetalagent_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - baremetalagent - /baremetalagents/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: baremetalagent_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/baremetalagent_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - baremetalagent - /baremetalagents/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: baremetalagent_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/baremetalagent_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - baremetalagent - /baremetalagents/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: baremetalagent_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/baremetalagent_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - baremetalagent - /billing_resource_checks: - get: - description: 列表 - operationId: billing_resource_check_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/billing_resource_check_ListItemFilterOutput' - summary: 列表 - tags: - - billing_resource_check - post: - description: 新建 - operationId: billing_resource_check_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - billing_resource_check: - $ref: '#/definitions/ResourceBaseCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/billing_resource_check_ValidateCreateDataOutput' - summary: 新建 - tags: - - billing_resource_check - /billing_resource_checks/{id}: - delete: - description: 删除 - operationId: billing_resource_check_CustomizeDelete - parameters: - - description: The Id or Name of billing_resource_check - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/billing_resource_check_CustomizeDeleteOutput' - summary: 删除 - tags: - - billing_resource_check - get: - description: 获取详情 - operationId: billing_resource_check_FetchCustomizeColumns - parameters: - - description: The Id or Name of billing_resource_check - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/billing_resource_check_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - billing_resource_check - put: - description: 更新 - operationId: billing_resource_check_ValidateUpdateData - parameters: - - description: The Id or Name of billing_resource_check - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - billing_resource_check: - $ref: '#/definitions/ResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/billing_resource_check_ValidateUpdateDataOutput' - summary: 更新 - tags: - - billing_resource_check - /billing_resource_checks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: billing_resource_check_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/billing_resource_check_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - billing_resource_check - /billing_resource_checks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: billing_resource_check_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - billing_resource_check: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/billing_resource_check_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - billing_resource_check - /billing_resource_checks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: billing_resource_check_GetPropertySplitable - responses: - "200": - $ref: '#/responses/billing_resource_check_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - billing_resource_check - /billing_resource_checks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: billing_resource_check_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/billing_resource_check_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - billing_resource_check - /buckets: - get: - description: 列表 - operationId: bucket_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: STORAGE_CLASS - in: query - items: - type: string - name: storage_class - type: array - x-go-name: StorageClass - - description: 位置 - in: query - items: - type: string - name: location - type: array - x-go-name: Location - - description: ACL - in: query - items: - type: string - name: acl - type: array - x-go-name: Acl - responses: - "200": - $ref: '#/responses/bucket_ListItemFilterOutput' - summary: 对象存储的存储桶列表 - tags: - - bucket - post: - description: 新建 - operationId: bucket_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_ValidateCreateDataOutput' - summary: 新建 - tags: - - bucket - /buckets/{id}: - delete: - description: 删除 - operationId: bucket_CustomizeDelete - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_CustomizeDeleteOutput' - summary: 删除 - tags: - - bucket - get: - description: 获取详情 - operationId: bucket_FetchCustomizeColumns - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - bucket - put: - description: 更新 - operationId: bucket_ValidateUpdateData - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_ValidateUpdateDataOutput' - summary: 更新 - tags: - - bucket - /buckets/{id}/access-info: - get: - description: 获取指定信息AccessInfo - operationId: bucket_GetDetailsAccessInfo - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsAccessInfoOutput' - summary: 获取指定信息AccessInfo - tags: - - bucket - /buckets/{id}/acl: - get: - description: |2- - - 获取对象或bucket的ACL - operationId: bucket_GetDetailsAcl - parameters: - - description: 对象KEY - in: query - name: key - type: string - x-go-name: Key - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsAclOutput' - summary: 获取对象或bucket的ACL - tags: - - bucket - post: - description: |2- - - 设置对象和bucket的ACL - operationId: bucket_PerformAcl - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketAclInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformAclOutput' - summary: 设置对象和bucket的ACL - tags: - - bucket - /buckets/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: bucket_PerformCancelDelete - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - bucket - /buckets/{id}/cdn-domain: - get: - description: 获取指定信息CdnDomain - operationId: bucket_GetDetailsCdnDomain - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsCdnDomainOutput' - summary: 获取指定信息CdnDomain - tags: - - bucket - /buckets/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: bucket_PerformChangeOwner - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - bucket - /buckets/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: bucket_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - bucket - /buckets/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: bucket_GetDetailsClassMetadata - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - bucket - post: - description: 执行操作ClassMetadata - operationId: bucket_PerformClassMetadata - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - bucket - /buckets/{id}/cors: - get: - description: 获取指定信息Cors - operationId: bucket_GetDetailsCors - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsCorsOutput' - summary: 获取指定信息Cors - tags: - - bucket - /buckets/{id}/delete: - post: - description: |2- - - 删除对象 - operationId: bucket_PerformDelete - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketPerformDeleteInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformDeleteOutput' - summary: 删除对象 - tags: - - bucket - /buckets/{id}/delete-cors: - post: - description: 执行操作DeleteCors - operationId: bucket_PerformDeleteCors - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketCORSRuleDeleteInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformDeleteCorsOutput' - summary: 执行操作DeleteCors - tags: - - bucket - /buckets/{id}/delete-policy: - post: - description: 执行操作DeletePolicy - operationId: bucket_PerformDeletePolicy - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketPolicyDeleteInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformDeletePolicyOutput' - summary: 执行操作DeletePolicy - tags: - - bucket - /buckets/{id}/delete-website: - post: - description: 执行操作DeleteWebsite - operationId: bucket_PerformDeleteWebsite - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_PerformDeleteWebsiteOutput' - summary: 执行操作DeleteWebsite - tags: - - bucket - /buckets/{id}/freeze: - post: - description: 执行操作Freeze - operationId: bucket_PerformFreeze - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - bucket - /buckets/{id}/limit: - post: - description: 执行操作Limit - operationId: bucket_PerformLimit - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_PerformLimitOutput' - summary: 执行操作Limit - tags: - - bucket - /buckets/{id}/makedir: - post: - description: |2- - - 新建对象目录 - operationId: bucket_PerformMakedir - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketPerformMakedirInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformMakedirOutput' - summary: 新建对象目录 - tags: - - bucket - /buckets/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: bucket_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 bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - bucket - post: - description: 执行操作Metadata - operationId: bucket_PerformMetadata - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketMetadataInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformMetadataOutput' - summary: 执行操作Metadata - tags: - - bucket - /buckets/{id}/objects: - get: - description: |2- - - 获取bucket的对象列表 - operationId: bucket_GetDetailsObjects - parameters: - - description: Prefix - in: query - name: prefix - type: string - x-go-name: Prefix - - description: 是否模拟列举目录模式 - in: query - name: recursive - type: boolean - x-go-name: Recursive - - description: 分页标识 - in: query - name: paging_marker - type: string - x-go-name: PagingMarker - - description: 最大输出条目数 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsObjectsOutput' - summary: 获取bucket的对象列表 - tags: - - bucket - /buckets/{id}/policy: - get: - description: 获取指定信息Policy - operationId: bucket_GetDetailsPolicy - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsPolicyOutput' - summary: 获取指定信息Policy - tags: - - bucket - /buckets/{id}/private: - post: - description: 执行操作Private - operationId: bucket_PerformPrivate - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformPrivateOutput' - summary: 执行操作Private - tags: - - bucket - /buckets/{id}/public: - post: - description: 执行操作Public - operationId: bucket_PerformPublic - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformPublicOutput' - summary: 执行操作Public - tags: - - bucket - /buckets/{id}/referer: - get: - description: 获取指定信息Referer - operationId: bucket_GetDetailsReferer - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsRefererOutput' - summary: 获取指定信息Referer - tags: - - bucket - /buckets/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: bucket_PerformSetClassMetadata - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - bucket - /buckets/{id}/set-cors: - post: - description: 执行操作SetCors - operationId: bucket_PerformSetCors - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketCORSRules' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformSetCorsOutput' - summary: 执行操作SetCors - tags: - - bucket - /buckets/{id}/set-policy: - post: - description: 执行操作SetPolicy - operationId: bucket_PerformSetPolicy - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketPolicyStatementInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformSetPolicyOutput' - summary: 执行操作SetPolicy - tags: - - bucket - /buckets/{id}/set-referer: - post: - description: 执行操作SetReferer - operationId: bucket_PerformSetReferer - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketRefererConf' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformSetRefererOutput' - summary: 执行操作SetReferer - tags: - - bucket - /buckets/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: bucket_PerformSetUserMetadata - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - bucket - /buckets/{id}/set-website: - post: - description: 执行操作SetWebsite - operationId: bucket_PerformSetWebsite - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketWebsiteConf' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformSetWebsiteOutput' - summary: 执行操作SetWebsite - tags: - - bucket - /buckets/{id}/status: - get: - description: 获取指定信息Status - operationId: bucket_GetDetailsStatus - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - bucket - post: - description: 执行操作Status - operationId: bucket_PerformStatus - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformStatusOutput' - summary: 更新资源状态 - tags: - - bucket - /buckets/{id}/sync: - post: - description: 执行操作Sync - operationId: bucket_PerformSync - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_PerformSyncOutput' - summary: 执行操作Sync - tags: - - bucket - /buckets/{id}/syncstatus: - post: - description: |2- - - 同步存储桶状态 - operationId: bucket_PerformSyncstatus - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformSyncstatusOutput' - summary: 同步存储桶状态 - tags: - - bucket - /buckets/{id}/temp-url: - post: - description: |2- - - 获取访问对象的临时URL - operationId: bucket_PerformTempUrl - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/BucketPerformTempUrlInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformTempUrlOutput' - summary: 获取访问对象的临时URL - tags: - - bucket - /buckets/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: bucket_PerformUnfreeze - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - bucket - /buckets/{id}/upload: - post: - description: |2- - - 上传对象 - operationId: bucket_PerformUpload - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_PerformUploadOutput' - summary: 上传对象 - tags: - - bucket - /buckets/{id}/website: - get: - description: 获取指定信息Website - operationId: bucket_GetDetailsWebsite - parameters: - - description: The Id or Name of bucket - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/bucket_GetDetailsWebsiteOutput' - summary: 获取指定信息Website - tags: - - bucket - /buckets/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: bucket_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/bucket_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - bucket - /buckets/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: bucket_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/bucket_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - bucket - /buckets/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: bucket_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/bucket_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - bucket - /buckets/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: bucket_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/bucket_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - bucket - /buckets/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: bucket_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/bucket_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - bucket - /buckets/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: bucket_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - bucket: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/bucket_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - bucket - /buckets/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: bucket_GetPropertySplitable - responses: - "200": - $ref: '#/responses/bucket_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - bucket - /buckets/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: bucket_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/bucket_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - bucket - /buckets/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: bucket_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/bucket_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - bucket - /buckets/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: bucket_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/bucket_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - bucket - /buckets/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: bucket_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/bucket_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - bucket - /cachedimages: - get: - description: 列表 - operationId: cachedimage_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: '镜像类型，可能值为: system(公有云公共镜像), customized(自定义镜像)' - example: system - in: query - items: - type: string - name: image_type - type: array - x-go-name: ImageType - - description: filter by host schedtag - in: query - name: host_schedtag_id - type: string - x-go-name: HostSchedtagId - - description: valid cachedimage - in: query - name: valid - type: boolean - x-go-name: Valid - responses: - "200": - $ref: '#/responses/cachedimage_ListItemFilterOutput' - summary: 缓存镜像列表 - tags: - - cachedimage - post: - description: 新建 - operationId: cachedimage_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/SharableVirtualResourceCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_ValidateCreateDataOutput' - summary: 新建 - tags: - - cachedimage - /cachedimages/{id}: - delete: - description: 删除 - operationId: cachedimage_CustomizeDelete - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cachedimage_CustomizeDeleteOutput' - summary: 删除 - tags: - - cachedimage - get: - description: 获取详情 - operationId: cachedimage_FetchCustomizeColumns - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cachedimage_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - cachedimage - put: - description: 更新 - operationId: cachedimage_ValidateUpdateData - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cachedimage - /cachedimages/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: cachedimage_PerformCancelDelete - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cachedimage_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - cachedimage - /cachedimages/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: cachedimage_PerformChangeOwner - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - cachedimage - /cachedimages/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: cachedimage_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cachedimage_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - cachedimage - /cachedimages/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cachedimage_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cachedimage_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cachedimage - post: - description: 执行操作ClassMetadata - operationId: cachedimage_PerformClassMetadata - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cachedimage - /cachedimages/{id}/freeze: - post: - description: 执行操作Freeze - operationId: cachedimage_PerformFreeze - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - cachedimage - /cachedimages/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cachedimage_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 cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cachedimage_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cachedimage - /cachedimages/{id}/private: - post: - description: 执行操作Private - operationId: cachedimage_PerformPrivate - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformPrivateOutput' - summary: 执行操作Private - tags: - - cachedimage - /cachedimages/{id}/public: - post: - description: 执行操作Public - operationId: cachedimage_PerformPublic - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformPublicOutput' - summary: 执行操作Public - tags: - - cachedimage - /cachedimages/{id}/refresh: - post: - description: 执行操作Refresh - operationId: cachedimage_PerformRefresh - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cachedimage_PerformRefreshOutput' - summary: 执行操作Refresh - tags: - - cachedimage - /cachedimages/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cachedimage_PerformSetClassMetadata - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cachedimage - /cachedimages/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cachedimage_PerformSetUserMetadata - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cachedimage - /cachedimages/{id}/status: - get: - description: 获取指定信息Status - operationId: cachedimage_GetDetailsStatus - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cachedimage_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cachedimage - post: - description: 执行操作Status - operationId: cachedimage_PerformStatus - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cachedimage - /cachedimages/{id}/uncache-image: - post: - description: 执行操作UncacheImage - operationId: cachedimage_PerformUncacheImage - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/CachedImageUncacheImageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformUncacheImageOutput' - summary: 清除镜像缓存 - tags: - - cachedimage - /cachedimages/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: cachedimage_PerformUnfreeze - parameters: - - description: The Id or Name of cachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - cachedimage - /cachedimages/cache-image: - post: - description: 执行操作CacheImage - operationId: cachedimage_PerformCacheImage - parameters: - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/CachedImageManagerCacheImageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformCacheImageOutput' - summary: 执行操作CacheImage - tags: - - cachedimage - /cachedimages/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cachedimage_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cachedimage_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cachedimage - /cachedimages/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: cachedimage_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/cachedimage_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - cachedimage - /cachedimages/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: cachedimage_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/cachedimage_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - cachedimage - /cachedimages/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: cachedimage_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/cachedimage_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - cachedimage - /cachedimages/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: cachedimage_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/cachedimage_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - cachedimage - /cachedimages/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cachedimage_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cachedimage: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cachedimage_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cachedimage - /cachedimages/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cachedimage_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cachedimage_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cachedimage - /cachedimages/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cachedimage_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/cachedimage_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cachedimage - /cachedimages/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cachedimage_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cachedimage_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cachedimage - /cachedimages/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cachedimage_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cachedimage_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cachedimage - /cachedimages/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cachedimage_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cachedimage_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cachedimage - /cdn_domains: - get: - description: 列表 - operationId: cdn_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 - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/cdn_domain_ListItemFilterOutput' - summary: 列出CDN域名 - tags: - - cdn_domain - post: - description: 新建 - operationId: cdn_domain_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/CDNDomainCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_ValidateCreateDataOutput' - summary: 新建 - tags: - - cdn_domain - /cdn_domains/{id}: - delete: - description: 删除 - operationId: cdn_domain_CustomizeDelete - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cdn_domain_CustomizeDeleteOutput' - summary: 删除 - tags: - - cdn_domain - get: - description: 获取详情 - operationId: cdn_domain_FetchCustomizeColumns - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cdn_domain_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - cdn_domain - put: - description: 更新 - operationId: cdn_domain_ValidateUpdateData - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cdn_domain - /cdn_domains/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: cdn_domain_PerformCancelDelete - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cdn_domain_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - cdn_domain - /cdn_domains/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: cdn_domain_PerformChangeOwner - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - cdn_domain - /cdn_domains/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: cdn_domain_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cdn_domain_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - cdn_domain - /cdn_domains/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cdn_domain_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cdn_domain_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cdn_domain - post: - description: 执行操作ClassMetadata - operationId: cdn_domain_PerformClassMetadata - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cdn_domain - /cdn_domains/{id}/disable: - post: - description: 执行操作Disable - operationId: cdn_domain_PerformDisable - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformDisableOutput' - summary: 禁用资源 - tags: - - cdn_domain - /cdn_domains/{id}/enable: - post: - description: 执行操作Enable - operationId: cdn_domain_PerformEnable - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformEnableOutput' - summary: 启用资源 - tags: - - cdn_domain - /cdn_domains/{id}/freeze: - post: - description: 执行操作Freeze - operationId: cdn_domain_PerformFreeze - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - cdn_domain - /cdn_domains/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cdn_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 cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cdn_domain_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cdn_domain - /cdn_domains/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: cdn_domain_PerformRemoteUpdate - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/MongoDBRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - cdn_domain - /cdn_domains/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cdn_domain_PerformSetClassMetadata - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cdn_domain - /cdn_domains/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cdn_domain_PerformSetUserMetadata - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cdn_domain - /cdn_domains/{id}/status: - get: - description: 获取指定信息Status - operationId: cdn_domain_GetDetailsStatus - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cdn_domain_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cdn_domain - post: - description: 执行操作Status - operationId: cdn_domain_PerformStatus - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cdn_domain - /cdn_domains/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: cdn_domain_PerformSyncstatus - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/NatGatewaySyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformSyncstatusOutput' - summary: 同步域名状态 - tags: - - cdn_domain - /cdn_domains/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: cdn_domain_PerformUnfreeze - parameters: - - description: The Id or Name of cdn_domain - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - cdn_domain - /cdn_domains/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cdn_domain_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cdn_domain_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cdn_domain - /cdn_domains/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: cdn_domain_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/cdn_domain_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - cdn_domain - /cdn_domains/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: cdn_domain_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/cdn_domain_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - cdn_domain - /cdn_domains/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: cdn_domain_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/cdn_domain_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - cdn_domain - /cdn_domains/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: cdn_domain_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/cdn_domain_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - cdn_domain - /cdn_domains/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cdn_domain_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cdn_domain: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cdn_domain_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cdn_domain - /cdn_domains/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cdn_domain_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cdn_domain_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cdn_domain - /cdn_domains/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cdn_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/cdn_domain_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cdn_domain - /cdn_domains/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cdn_domain_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cdn_domain_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cdn_domain - /cdn_domains/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cdn_domain_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cdn_domain_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cdn_domain - /cdn_domains/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cdn_domain_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cdn_domain_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cdn_domain - /cloudaccounts: - get: - description: 列表 - operationId: cloudaccount_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 根据该云平台的功能对云账号或云订阅进行过滤 - in: query - items: - type: string - name: capability - type: array - x-go-name: Capability - - description: 同步状态 - in: query - items: - type: string - name: sync_status - type: array - x-go-name: SyncStatus - - description: 账号健康状态 - in: query - items: - type: string - name: health_status - type: array - x-go-name: HealthStatus - - description: 共享模式 - in: query - items: - type: string - name: share_mode - type: array - x-go-name: ShareMode - - description: 代理 - in: query - name: proxy_setting - type: string - x-go-name: ProxySetting - - description: 按宿主机数量排序 - in: query - name: order_by_host_count - pattern: asc|desc - type: string - x-go-name: OrderByHostCount - - description: 按虚拟机数量排序 - in: query - name: order_by_guest_count - pattern: asc|desc - type: string - x-go-name: OrderByGuestCount - responses: - "200": - $ref: '#/responses/cloudaccount_ListItemFilterOutput' - summary: 云账号列表 - tags: - - cloudaccount - post: - description: 新建 - operationId: cloudaccount_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_ValidateCreateDataOutput' - summary: 新建 - tags: - - cloudaccount - /cloudaccounts/{id}: - delete: - description: 删除 - operationId: cloudaccount_CustomizeDelete - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_CustomizeDeleteOutput' - summary: 删除 - tags: - - cloudaccount - get: - description: 获取详情 - operationId: cloudaccount_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - cloudaccount - put: - description: 更新 - operationId: cloudaccount_ValidateUpdateData - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cloudaccount - /cloudaccounts/{id}/balance: - get: - description: 获取指定信息Balance - operationId: cloudaccount_GetDetailsBalance - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_GetDetailsBalanceOutput' - summary: 获取指定信息Balance - tags: - - cloudaccount - /cloudaccounts/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: cloudaccount_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - cloudaccount - /cloudaccounts/{id}/change-project: - post: - description: 执行操作ChangeProject - operationId: cloudaccount_PerformChangeProject - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformChangeProjectOutput' - summary: 执行操作ChangeProject - tags: - - cloudaccount - /cloudaccounts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudaccount_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudaccount - post: - description: 执行操作ClassMetadata - operationId: cloudaccount_PerformClassMetadata - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudaccount - /cloudaccounts/{id}/create-subscription: - post: - description: 执行操作CreateSubscription - operationId: cloudaccount_PerformCreateSubscription - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/SubscriptonCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformCreateSubscriptionOutput' - summary: 创建Azure订阅 - tags: - - cloudaccount - /cloudaccounts/{id}/disable: - post: - description: 执行操作Disable - operationId: cloudaccount_PerformDisable - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformDisableOutput' - summary: 执行操作Disable - tags: - - cloudaccount - /cloudaccounts/{id}/enable: - post: - description: 执行操作Enable - operationId: cloudaccount_PerformEnable - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformEnableOutput' - summary: 执行操作Enable - tags: - - cloudaccount - /cloudaccounts/{id}/enrollment-accounts: - get: - description: 获取指定信息EnrollmentAccounts - operationId: cloudaccount_GetDetailsEnrollmentAccounts - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_GetDetailsEnrollmentAccountsOutput' - summary: 获取Azure Enrollment Accounts - tags: - - cloudaccount - /cloudaccounts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudaccount_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 cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudaccount - /cloudaccounts/{id}/private: - post: - description: 执行操作Private - operationId: cloudaccount_PerformPrivate - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformPrivateOutput' - summary: 执行操作Private - tags: - - cloudaccount - /cloudaccounts/{id}/project-mapping: - post: - description: 执行操作ProjectMapping - operationId: cloudaccount_PerformProjectMapping - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountProjectMappingInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformProjectMappingOutput' - summary: 绑定同步策略 - tags: - - cloudaccount - /cloudaccounts/{id}/public: - post: - description: 执行操作Public - operationId: cloudaccount_PerformPublic - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountPerformPublicInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformPublicOutput' - summary: 执行操作Public - tags: - - cloudaccount - /cloudaccounts/{id}/saml: - get: - description: 获取指定信息Saml - operationId: cloudaccount_GetDetailsSaml - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_GetDetailsSamlOutput' - summary: 获取指定信息Saml - tags: - - cloudaccount - /cloudaccounts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudaccount_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudaccount - /cloudaccounts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudaccount_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudaccount - /cloudaccounts/{id}/share-mode: - post: - description: 执行操作ShareMode - operationId: cloudaccount_PerformShareMode - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountShareModeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformShareModeOutput' - summary: Deprecated - tags: - - cloudaccount - /cloudaccounts/{id}/status: - get: - description: 获取指定信息Status - operationId: cloudaccount_GetDetailsStatus - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cloudaccount - post: - description: 执行操作Status - operationId: cloudaccount_PerformStatus - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cloudaccount - /cloudaccounts/{id}/sync: - post: - description: 执行操作Sync - operationId: cloudaccount_PerformSync - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/SyncRangeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformSyncOutput' - summary: 执行操作Sync - tags: - - cloudaccount - /cloudaccounts/{id}/sync-skus: - post: - description: 执行操作SyncSkus - operationId: cloudaccount_PerformSyncSkus - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountSyncSkusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformSyncSkusOutput' - summary: 执行操作SyncSkus - tags: - - cloudaccount - /cloudaccounts/{id}/test-connectivity: - post: - description: 执行操作TestConnectivity - operationId: cloudaccount_PerformTestConnectivity - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/SCloudaccountCredential' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformTestConnectivityOutput' - summary: 测试账号连通性(更新秘钥信息时) - tags: - - cloudaccount - /cloudaccounts/{id}/update-credential: - post: - description: 执行操作UpdateCredential - operationId: cloudaccount_PerformUpdateCredential - parameters: - - description: The Id or Name of cloudaccount - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudaccount_PerformUpdateCredentialOutput' - summary: 执行操作UpdateCredential - tags: - - cloudaccount - /cloudaccounts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudaccount_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudaccount_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudaccount - /cloudaccounts/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: cloudaccount_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/cloudaccount_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - cloudaccount - /cloudaccounts/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: cloudaccount_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/cloudaccount_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - cloudaccount - /cloudaccounts/prepare-nets: - post: - description: 执行操作PrepareNets - operationId: cloudaccount_PerformPrepareNets - parameters: - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountPerformPrepareNetsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformPrepareNetsOutput' - summary: Performpreparenets searches for suitable network facilities for physical - and virtual machines under the cloud account or provides configuration recommendations - for network facilities before importing a cloud account. - tags: - - cloudaccount - /cloudaccounts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudaccount_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudaccount: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudaccount_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudaccount - /cloudaccounts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudaccount_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudaccount_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudaccount - /cloudaccounts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudaccount_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/cloudaccount_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudaccount - /cloudaccounts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cloudaccount_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cloudaccount_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cloudaccount - /cloudaccounts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudaccount_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudaccount_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudaccount - /cloudaccounts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudaccount_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudaccount_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudaccount - /cloudimages: - get: - description: 列表 - operationId: cloudimage_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/cloudimage_ListItemFilterOutput' - summary: 列表 - tags: - - cloudimage - post: - description: 新建 - operationId: cloudimage_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudimage: - $ref: '#/definitions/StandaloneResourceCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudimage_ValidateCreateDataOutput' - summary: 新建 - tags: - - cloudimage - /cloudimages/{id}: - delete: - description: 删除 - operationId: cloudimage_CustomizeDelete - parameters: - - description: The Id or Name of cloudimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudimage_CustomizeDeleteOutput' - summary: 删除 - tags: - - cloudimage - get: - description: 获取详情 - operationId: cloudimage_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudimage_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - cloudimage - put: - description: 更新 - operationId: cloudimage_ValidateUpdateData - parameters: - - description: The Id or Name of cloudimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudimage: - $ref: '#/definitions/StandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudimage_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cloudimage - /cloudimages/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudimage_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudimage_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudimage - post: - description: 执行操作ClassMetadata - operationId: cloudimage_PerformClassMetadata - parameters: - - description: The Id or Name of cloudimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudimage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudimage_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudimage - /cloudimages/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudimage_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 cloudimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudimage_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudimage - /cloudimages/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudimage_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudimage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudimage_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudimage - /cloudimages/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudimage_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudimage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudimage_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudimage - /cloudimages/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudimage_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudimage_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudimage - /cloudimages/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudimage_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudimage: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudimage_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudimage - /cloudimages/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudimage_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudimage_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudimage - /cloudimages/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudimage_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/cloudimage_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudimage - /cloudimages/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudimage_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudimage_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudimage - /cloudimages/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudimage_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudimage_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudimage - /cloudproviderregions: - get: - description: 列表 - operationId: cloudproviderregion_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 同步状态 - in: query - items: - type: string - name: sync_status - type: array - x-go-name: SyncStatus - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 根据该云平台的功能对云账号或云订阅进行过滤 - in: query - items: - type: string - name: capability - type: array - x-go-name: Capability - - description: 是否启用 - in: query - name: enabled - type: boolean - x-go-name: Enabled - responses: - "200": - $ref: '#/responses/cloudproviderregion_ListItemFilterOutput' - summary: 列表 - tags: - - cloudproviderregion - post: - description: 新建 - operationId: cloudproviderregion_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudproviderregion: - $ref: '#/definitions/JoinResourceBaseCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudproviderregion_ValidateCreateDataOutput' - summary: 新建 - tags: - - cloudproviderregion - /cloudproviderregions/{id}: - delete: - description: 删除 - operationId: cloudproviderregion_CustomizeDelete - parameters: - - description: The Id or Name of cloudproviderregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudproviderregion_CustomizeDeleteOutput' - summary: 删除 - tags: - - cloudproviderregion - get: - description: 获取详情 - operationId: cloudproviderregion_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudproviderregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudproviderregion_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - cloudproviderregion - put: - description: 更新 - operationId: cloudproviderregion_ValidateUpdateData - parameters: - - description: The Id or Name of cloudproviderregion - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudproviderregion: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudproviderregion_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cloudproviderregion - /cloudproviderregions/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudproviderregion_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudproviderregion_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudproviderregion - /cloudproviderregions/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudproviderregion_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudproviderregion: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudproviderregion_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudproviderregion - /cloudproviderregions/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudproviderregion_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudproviderregion_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudproviderregion - /cloudproviderregions/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudproviderregion_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/cloudproviderregion_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudproviderregion - /cloudproviders: - get: - description: 列表 - operationId: cloudprovider_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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 根据该云平台的功能对云账号或云订阅进行过滤 - in: query - items: - type: string - name: capability - type: array - x-go-name: Capability - - description: 同步状态 - in: query - items: - type: string - name: sync_status - type: array - x-go-name: SyncStatus - - description: 账号健康状态 - in: query - items: - type: string - name: health_status - type: array - x-go-name: HealthStatus - - description: filter by host schedtag - in: query - name: host_schedtag_id - type: string - x-go-name: HostSchedtagId - responses: - "200": - $ref: '#/responses/cloudprovider_ListItemFilterOutput' - summary: 云订阅列表 - tags: - - cloudprovider - /cloudproviders/{id}: - delete: - description: 删除 - operationId: cloudprovider_CustomizeDelete - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_CustomizeDeleteOutput' - summary: 删除 - tags: - - cloudprovider - get: - description: 获取详情 - operationId: cloudprovider_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - cloudprovider - put: - description: 更新 - operationId: cloudprovider_ValidateUpdateData - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/CloudproviderUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cloudprovider - /cloudproviders/{id}/canned-acls: - get: - description: 获取指定信息CannedAcls - operationId: cloudprovider_GetDetailsCannedAcls - parameters: - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsCannedAclsOutput' - summary: 获取指定信息CannedAcls - tags: - - cloudprovider - /cloudproviders/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: cloudprovider_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - cloudprovider - /cloudproviders/{id}/change-project: - post: - description: 执行操作ChangeProject - operationId: cloudprovider_PerformChangeProject - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformChangeProjectOutput' - summary: 执行操作ChangeProject - tags: - - cloudprovider - /cloudproviders/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudprovider_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudprovider - post: - description: 执行操作ClassMetadata - operationId: cloudprovider_PerformClassMetadata - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudprovider - /cloudproviders/{id}/clirc: - get: - description: 获取指定信息Clirc - operationId: cloudprovider_GetDetailsClirc - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsClircOutput' - summary: 获取指定信息Clirc - tags: - - cloudprovider - /cloudproviders/{id}/disable: - post: - description: 执行操作Disable - operationId: cloudprovider_PerformDisable - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformDisableOutput' - summary: 执行操作Disable - tags: - - cloudprovider - /cloudproviders/{id}/enable: - post: - description: 执行操作Enable - operationId: cloudprovider_PerformEnable - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformEnableOutput' - summary: 执行操作Enable - tags: - - cloudprovider - /cloudproviders/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudprovider_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 cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudprovider - /cloudproviders/{id}/project-mapping: - post: - description: 执行操作ProjectMapping - operationId: cloudprovider_PerformProjectMapping - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/CloudaccountProjectMappingInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformProjectMappingOutput' - summary: 绑定同步策略 - tags: - - cloudprovider - /cloudproviders/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudprovider_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudprovider - /cloudproviders/{id}/set-schedtag: - post: - description: 执行操作SetSchedtag - operationId: cloudprovider_PerformSetSchedtag - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_PerformSetSchedtagOutput' - summary: 执行操作SetSchedtag - tags: - - cloudprovider - /cloudproviders/{id}/set-syncing: - post: - description: 执行操作SetSyncing - operationId: cloudprovider_PerformSetSyncing - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/CloudproviderSync' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformSetSyncingOutput' - summary: 执行操作SetSyncing - tags: - - cloudprovider - /cloudproviders/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudprovider_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudprovider - /cloudproviders/{id}/status: - get: - description: 获取指定信息Status - operationId: cloudprovider_GetDetailsStatus - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cloudprovider - post: - description: 执行操作Status - operationId: cloudprovider_PerformStatus - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cloudprovider - /cloudproviders/{id}/storage-classes: - get: - description: 获取指定信息StorageClasses - operationId: cloudprovider_GetDetailsStorageClasses - parameters: - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudprovider_GetDetailsStorageClassesOutput' - summary: 获取指定信息StorageClasses - tags: - - cloudprovider - /cloudproviders/{id}/sync: - post: - description: 执行操作Sync - operationId: cloudprovider_PerformSync - parameters: - - description: The Id or Name of cloudprovider - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/SyncRangeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformSyncOutput' - summary: 执行操作Sync - tags: - - cloudprovider - /cloudproviders/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudprovider_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudprovider - /cloudproviders/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudprovider_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudprovider: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudprovider_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudprovider - /cloudproviders/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudprovider_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudprovider - /cloudproviders/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudprovider_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/cloudprovider_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudprovider - /cloudproviders/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cloudprovider_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cloudprovider - /cloudproviders/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudprovider_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudprovider - /cloudproviders/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudprovider_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudprovider_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudprovider - /cloudregions: - get: - description: 列表 - operationId: cloudregion_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: filter by Vpc usability of the resource - in: query - name: usable_vpc - type: boolean - x-go-name: UsableVpc - - description: 根据该云平台的功能对云账号或云订阅进行过滤 - in: query - items: - type: string - name: capability - type: array - x-go-name: Capability - - description: 过滤位于指定城市的区域 - in: query - name: city - type: string - x-go-name: City - - description: 过滤提供特定服务的区域 - in: query - name: service - type: string - x-go-name: Service - - description: 云环境 - in: query - items: - type: string - name: environment - type: array - x-go-name: Environment - - description: 按可用区数量排序 - in: query - name: order_by_zone_count - pattern: asc|desc - type: string - x-go-name: OrderByZoneCount - - description: 按vpc数量排序 - in: query - name: order_by_vpc_count - pattern: asc|desc - type: string - x-go-name: OrderByVpcCount - - description: 按虚拟机数量排序 - in: query - name: order_by_guest_count - pattern: asc|desc - type: string - x-go-name: OrderByGuestCount - responses: - "200": - $ref: '#/responses/cloudregion_ListItemFilterOutput' - summary: 云平台区域列表 - tags: - - cloudregion - post: - description: 新建 - operationId: cloudregion_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - cloudregion: - $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_ValidateCreateDataOutput' - summary: 新建 - tags: - - cloudregion - /cloudregions/{id}: - delete: - description: 删除 - operationId: cloudregion_CustomizeDelete - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudregion_CustomizeDeleteOutput' - summary: 删除 - tags: - - cloudregion - get: - description: 获取详情 - operationId: cloudregion_FetchCustomizeColumns - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudregion_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - cloudregion - put: - description: 更新 - operationId: cloudregion_ValidateUpdateData - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudregion: - $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_ValidateUpdateDataOutput' - summary: 更新 - tags: - - cloudregion - /cloudregions/{id}/capability: - get: - description: 获取指定信息Capability - operationId: cloudregion_GetDetailsCapability - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudregion_GetDetailsCapabilityOutput' - summary: 获取指定信息Capability - tags: - - cloudregion - /cloudregions/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: cloudregion_GetDetailsClassMetadata - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudregion_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - cloudregion - post: - description: 执行操作ClassMetadata - operationId: cloudregion_PerformClassMetadata - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudregion: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - cloudregion - /cloudregions/{id}/default-vpc: - post: - description: 执行操作DefaultVpc - operationId: cloudregion_PerformDefaultVpc - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudregion_PerformDefaultVpcOutput' - summary: 执行操作DefaultVpc - tags: - - cloudregion - /cloudregions/{id}/disable: - post: - description: 执行操作Disable - operationId: cloudregion_PerformDisable - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudregion: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_PerformDisableOutput' - summary: 禁用资源 - tags: - - cloudregion - /cloudregions/{id}/disk-capability: - get: - description: 获取指定信息DiskCapability - operationId: cloudregion_GetDetailsDiskCapability - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudregion_GetDetailsDiskCapabilityOutput' - summary: 获取指定信息DiskCapability - tags: - - cloudregion - /cloudregions/{id}/enable: - post: - description: 执行操作Enable - operationId: cloudregion_PerformEnable - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudregion: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_PerformEnableOutput' - summary: 启用资源 - tags: - - cloudregion - /cloudregions/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: cloudregion_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 cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudregion_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - cloudregion - /cloudregions/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: cloudregion_PerformSetClassMetadata - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudregion: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - cloudregion - /cloudregions/{id}/set-schedtag: - post: - description: 执行操作SetSchedtag - operationId: cloudregion_PerformSetSchedtag - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudregion_PerformSetSchedtagOutput' - summary: 执行操作SetSchedtag - tags: - - cloudregion - /cloudregions/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: cloudregion_PerformSetUserMetadata - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudregion: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - cloudregion - /cloudregions/{id}/status: - get: - description: 获取指定信息Status - operationId: cloudregion_GetDetailsStatus - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/cloudregion_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - cloudregion - post: - description: 执行操作Status - operationId: cloudregion_PerformStatus - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudregion: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_PerformStatusOutput' - summary: 更新资源状态 - tags: - - cloudregion - /cloudregions/{id}/sync-images: - post: - description: 执行操作SyncImages - operationId: cloudregion_PerformSyncImages - parameters: - - description: The Id or Name of cloudregion - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - cloudregion: - $ref: '#/definitions/SyncImagesInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_PerformSyncImagesOutput' - summary: 执行操作SyncImages - tags: - - cloudregion - /cloudregions/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: cloudregion_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/cloudregion_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - cloudregion - /cloudregions/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: cloudregion_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - cloudregion: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - cloudregion - /cloudregions/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: cloudregion_GetPropertySplitable - responses: - "200": - $ref: '#/responses/cloudregion_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - cloudregion - /cloudregions/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: cloudregion_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/cloudregion_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - cloudregion - /cloudregions/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: cloudregion_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/cloudregion_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - cloudregion - /cloudregions/sync-skus: - post: - description: 执行操作SyncSkus - operationId: cloudregion_PerformSyncSkus - parameters: - - in: body - name: body - schema: - properties: - cloudregion: - $ref: '#/definitions/CloudregionSkuSyncInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/cloudregion_PerformSyncSkusOutput' - summary: 执行操作SyncSkus - tags: - - cloudregion - /cloudregions/sync-tasks: - get: - description: 获取指定资源类的信息SyncTasks - operationId: cloudregion_GetPropertySyncTasks - parameters: - - description: 异步任务ID - in: query - items: - type: string - name: task_ids - type: array - x-go-name: TaskIds - responses: - "200": - $ref: '#/responses/cloudregion_GetPropertySyncTasksOutput' - summary: 获取指定资源类的信息SyncTasks - tags: - - cloudregion - /cloudregions/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: cloudregion_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/cloudregion_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - cloudregion - /cloudregions/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: cloudregion_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/cloudregion_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - cloudregion - /db_instance_accounts: - get: - description: 列表 - operationId: db_instance_account_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: RDS实例(ID or Name) - in: query - name: dbinstance_id - type: string - x-go-name: DBInstanceId - - description: 以RDS实例名字排序 - in: query - name: order_by_dbinstance - type: string - x-go-name: OrderByDBInstance - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/db_instance_account_ListItemFilterOutput' - summary: RDS账号列表 - tags: - - db_instance_account - post: - description: 新建 - operationId: db_instance_account_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - db_instance_account: - $ref: '#/definitions/DBInstanceAccountCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_account_ValidateCreateDataOutput' - summary: 新建 - tags: - - db_instance_account - /db_instance_accounts/{id}: - delete: - description: 删除 - operationId: db_instance_account_CustomizeDelete - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_account_CustomizeDeleteOutput' - summary: 删除 - tags: - - db_instance_account - get: - description: 获取详情 - operationId: db_instance_account_FetchCustomizeColumns - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_account_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - db_instance_account - put: - description: 更新 - operationId: db_instance_account_ValidateUpdateData - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_account: - $ref: '#/definitions/DBInstanceAccountUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_account_ValidateUpdateDataOutput' - summary: 更新 - tags: - - db_instance_account - /db_instance_accounts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: db_instance_account_GetDetailsClassMetadata - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_account_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - db_instance_account - post: - description: 执行操作ClassMetadata - operationId: db_instance_account_PerformClassMetadata - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_account: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_account_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - db_instance_account - /db_instance_accounts/{id}/grant-privilege: - post: - description: 执行操作GrantPrivilege - operationId: db_instance_account_PerformGrantPrivilege - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_account_PerformGrantPrivilegeOutput' - summary: 执行操作GrantPrivilege - tags: - - db_instance_account - /db_instance_accounts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: db_instance_account_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 db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_account_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - db_instance_account - /db_instance_accounts/{id}/reset-password: - post: - description: 执行操作ResetPassword - operationId: db_instance_account_PerformResetPassword - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_account_PerformResetPasswordOutput' - summary: 执行操作ResetPassword - tags: - - db_instance_account - /db_instance_accounts/{id}/revoke-privilege: - post: - description: 执行操作RevokePrivilege - operationId: db_instance_account_PerformRevokePrivilege - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_account_PerformRevokePrivilegeOutput' - summary: 执行操作RevokePrivilege - tags: - - db_instance_account - /db_instance_accounts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: db_instance_account_PerformSetClassMetadata - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_account: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_account_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - db_instance_account - /db_instance_accounts/{id}/set-privileges: - post: - description: 执行操作SetPrivileges - operationId: db_instance_account_PerformSetPrivileges - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_account_PerformSetPrivilegesOutput' - summary: 执行操作SetPrivileges - tags: - - db_instance_account - /db_instance_accounts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: db_instance_account_PerformSetUserMetadata - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_account: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_account_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - db_instance_account - /db_instance_accounts/{id}/status: - get: - description: 获取指定信息Status - operationId: db_instance_account_GetDetailsStatus - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_account_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - db_instance_account - post: - description: 执行操作Status - operationId: db_instance_account_PerformStatus - parameters: - - description: The Id or Name of db_instance_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_account: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_account_PerformStatusOutput' - summary: 更新资源状态 - tags: - - db_instance_account - /db_instance_accounts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: db_instance_account_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/db_instance_account_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - db_instance_account - /db_instance_accounts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: db_instance_account_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - db_instance_account: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_account_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - db_instance_account - /db_instance_accounts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: db_instance_account_GetPropertySplitable - responses: - "200": - $ref: '#/responses/db_instance_account_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - db_instance_account - /db_instance_accounts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: db_instance_account_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/db_instance_account_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - db_instance_account - /db_instance_accounts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: db_instance_account_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/db_instance_account_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - db_instance_account - /db_instance_accounts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: db_instance_account_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/db_instance_account_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - db_instance_account - /db_instance_accounts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: db_instance_account_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/db_instance_account_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - db_instance_account - /db_instance_backups: - get: - description: 列表 - operationId: db_instance_backup_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: RDS实例(ID or Name) - in: query - name: dbinstance_id - type: string - x-go-name: DBInstanceId - - description: 以RDS实例名字排序 - in: query - name: order_by_dbinstance - type: string - x-go-name: OrderByDBInstance - - description: RDS引擎 - example: MySQL - in: query - items: - type: string - name: engine - type: array - x-go-name: Engine - - description: RDS引擎版本 - example: "5.7" - in: query - items: - type: string - name: engine_version - type: array - x-go-name: EngineVersion - - description: 备份模式 - in: query - items: - type: string - name: backup_mode - type: array - x-go-name: BackupMode - - description: 数据库名称 - in: query - name: db_names - type: string - x-go-name: DBNames - responses: - "200": - $ref: '#/responses/db_instance_backup_ListItemFilterOutput' - summary: RDS备份列表 - tags: - - db_instance_backup - post: - description: 新建 - operationId: db_instance_backup_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - db_instance_backup: - $ref: '#/definitions/DBInstanceBackupCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_ValidateCreateDataOutput' - summary: 新建 - tags: - - db_instance_backup - /db_instance_backups/{id}: - delete: - description: 删除 - operationId: db_instance_backup_CustomizeDelete - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_backup_CustomizeDeleteOutput' - summary: 删除 - tags: - - db_instance_backup - get: - description: 获取详情 - operationId: db_instance_backup_FetchCustomizeColumns - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_backup_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - db_instance_backup - put: - description: 更新 - operationId: db_instance_backup_ValidateUpdateData - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_backup: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_ValidateUpdateDataOutput' - summary: 更新 - tags: - - db_instance_backup - /db_instance_backups/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: db_instance_backup_PerformCancelDelete - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - db_instance_backup - /db_instance_backups/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: db_instance_backup_PerformChangeOwner - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_backup: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - db_instance_backup - /db_instance_backups/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: db_instance_backup_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - db_instance_backup - /db_instance_backups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: db_instance_backup_GetDetailsClassMetadata - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_backup_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - db_instance_backup - post: - description: 执行操作ClassMetadata - operationId: db_instance_backup_PerformClassMetadata - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - db_instance_backup - /db_instance_backups/{id}/freeze: - post: - description: 执行操作Freeze - operationId: db_instance_backup_PerformFreeze - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_backup: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - db_instance_backup - /db_instance_backups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: db_instance_backup_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 db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_backup_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - db_instance_backup - /db_instance_backups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: db_instance_backup_PerformSetClassMetadata - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - db_instance_backup - /db_instance_backups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: db_instance_backup_PerformSetUserMetadata - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - db_instance_backup - /db_instance_backups/{id}/status: - get: - description: 获取指定信息Status - operationId: db_instance_backup_GetDetailsStatus - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_backup_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - db_instance_backup - post: - description: 执行操作Status - operationId: db_instance_backup_PerformStatus - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_backup: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformStatusOutput' - summary: 更新资源状态 - tags: - - db_instance_backup - /db_instance_backups/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: db_instance_backup_PerformSyncstatus - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_backup: - $ref: '#/definitions/DiskSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformSyncstatusOutput' - summary: 同步RDS备份状态 - tags: - - db_instance_backup - /db_instance_backups/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: db_instance_backup_PerformUnfreeze - parameters: - - description: The Id or Name of db_instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_backup: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - db_instance_backup - /db_instance_backups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: db_instance_backup_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/db_instance_backup_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - db_instance_backup - /db_instance_backups/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: db_instance_backup_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/db_instance_backup_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - db_instance_backup - /db_instance_backups/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: db_instance_backup_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/db_instance_backup_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - db_instance_backup - /db_instance_backups/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: db_instance_backup_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/db_instance_backup_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - db_instance_backup - /db_instance_backups/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: db_instance_backup_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/db_instance_backup_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - db_instance_backup - /db_instance_backups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: db_instance_backup_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - db_instance_backup: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_backup_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - db_instance_backup - /db_instance_backups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: db_instance_backup_GetPropertySplitable - responses: - "200": - $ref: '#/responses/db_instance_backup_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - db_instance_backup - /db_instance_backups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: db_instance_backup_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/db_instance_backup_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - db_instance_backup - /db_instance_backups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: db_instance_backup_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/db_instance_backup_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - db_instance_backup - /db_instance_backups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: db_instance_backup_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/db_instance_backup_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - db_instance_backup - /db_instance_backups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: db_instance_backup_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/db_instance_backup_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - db_instance_backup - /db_instance_databases: - get: - description: 列表 - operationId: db_instance_database_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: RDS实例(ID or Name) - in: query - name: dbinstance_id - type: string - x-go-name: DBInstanceId - - description: 以RDS实例名字排序 - in: query - name: order_by_dbinstance - type: string - x-go-name: OrderByDBInstance - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 数据库字符集 - in: query - items: - type: string - name: character_set - type: array - x-go-name: CharacterSet - responses: - "200": - $ref: '#/responses/db_instance_database_ListItemFilterOutput' - summary: RDS数据库列表 - tags: - - db_instance_database - post: - description: 新建 - operationId: db_instance_database_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - db_instance_database: - $ref: '#/definitions/DBInstanceDatabaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_database_ValidateCreateDataOutput' - summary: 新建 - tags: - - db_instance_database - /db_instance_databases/{id}: - delete: - description: 删除 - operationId: db_instance_database_CustomizeDelete - parameters: - - description: The Id or Name of db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_database_CustomizeDeleteOutput' - summary: 删除 - tags: - - db_instance_database - get: - description: 获取详情 - operationId: db_instance_database_FetchCustomizeColumns - parameters: - - description: The Id or Name of db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_database_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - db_instance_database - put: - description: 更新 - operationId: db_instance_database_ValidateUpdateData - parameters: - - description: The Id or Name of db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_database: - $ref: '#/definitions/DBInstanceDatabaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_database_ValidateUpdateDataOutput' - summary: 更新 - tags: - - db_instance_database - /db_instance_databases/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: db_instance_database_GetDetailsClassMetadata - parameters: - - description: The Id or Name of db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_database_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - db_instance_database - post: - description: 执行操作ClassMetadata - operationId: db_instance_database_PerformClassMetadata - parameters: - - description: The Id or Name of db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_database: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_database_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - db_instance_database - /db_instance_databases/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: db_instance_database_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 db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_database_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - db_instance_database - /db_instance_databases/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: db_instance_database_PerformSetClassMetadata - parameters: - - description: The Id or Name of db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_database: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_database_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - db_instance_database - /db_instance_databases/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: db_instance_database_PerformSetUserMetadata - parameters: - - description: The Id or Name of db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_database: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_database_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - db_instance_database - /db_instance_databases/{id}/status: - get: - description: 获取指定信息Status - operationId: db_instance_database_GetDetailsStatus - parameters: - - description: The Id or Name of db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_database_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - db_instance_database - post: - description: 执行操作Status - operationId: db_instance_database_PerformStatus - parameters: - - description: The Id or Name of db_instance_database - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_database: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_database_PerformStatusOutput' - summary: 更新资源状态 - tags: - - db_instance_database - /db_instance_databases/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: db_instance_database_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/db_instance_database_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - db_instance_database - /db_instance_databases/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: db_instance_database_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - db_instance_database: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_database_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - db_instance_database - /db_instance_databases/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: db_instance_database_GetPropertySplitable - responses: - "200": - $ref: '#/responses/db_instance_database_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - db_instance_database - /db_instance_databases/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: db_instance_database_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/db_instance_database_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - db_instance_database - /db_instance_databases/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: db_instance_database_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/db_instance_database_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - db_instance_database - /db_instance_databases/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: db_instance_database_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/db_instance_database_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - db_instance_database - /db_instance_databases/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: db_instance_database_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/db_instance_database_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - db_instance_database - /db_instance_networks: - get: - description: 列表 - operationId: db_instance_network_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: RDS实例(ID or Name) - in: query - name: dbinstance_id - type: string - x-go-name: DBInstanceId - - description: 以RDS实例名字排序 - in: query - name: order_by_dbinstance - type: string - x-go-name: OrderByDBInstance - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - responses: - "200": - $ref: '#/responses/db_instance_network_ListItemFilterOutput' - summary: RDS网络列表 - tags: - - db_instance_network - post: - description: 新建 - operationId: db_instance_network_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - db_instance_network: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_network_ValidateCreateDataOutput' - summary: 新建 - tags: - - db_instance_network - /db_instance_networks/{id}: - delete: - description: 删除 - operationId: db_instance_network_CustomizeDelete - parameters: - - description: The Id or Name of db_instance_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_network_CustomizeDeleteOutput' - summary: 删除 - tags: - - db_instance_network - get: - description: 获取详情 - operationId: db_instance_network_FetchCustomizeColumns - parameters: - - description: The Id or Name of db_instance_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_network_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - db_instance_network - put: - description: 更新 - operationId: db_instance_network_ValidateUpdateData - parameters: - - description: The Id or Name of db_instance_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_network: - $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_network_ValidateUpdateDataOutput' - summary: 更新 - tags: - - db_instance_network - /db_instance_networks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: db_instance_network_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/db_instance_network_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - db_instance_network - /db_instance_networks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: db_instance_network_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - db_instance_network: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_network_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - db_instance_network - /db_instance_networks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: db_instance_network_GetPropertySplitable - responses: - "200": - $ref: '#/responses/db_instance_network_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - db_instance_network - /db_instance_networks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: db_instance_network_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/db_instance_network_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - db_instance_network - /db_instance_parameters: - get: - description: 列表 - operationId: db_instance_parameter_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: RDS实例(ID or Name) - in: query - name: dbinstance_id - type: string - x-go-name: DBInstanceId - - description: 以RDS实例名字排序 - in: query - name: order_by_dbinstance - type: string - x-go-name: OrderByDBInstance - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 参数名称 - in: query - items: - type: string - name: key - type: array - x-go-name: Key - - description: 参数值 - in: query - items: - type: string - name: value - type: array - x-go-name: Value - responses: - "200": - $ref: '#/responses/db_instance_parameter_ListItemFilterOutput' - summary: 列出数据参数 - tags: - - db_instance_parameter - post: - description: 新建 - operationId: db_instance_parameter_ValidateCreateData - responses: - "200": - $ref: '#/responses/db_instance_parameter_ValidateCreateDataOutput' - summary: 新建 - tags: - - db_instance_parameter - /db_instance_parameters/{id}: - delete: - description: 删除 - operationId: db_instance_parameter_CustomizeDelete - parameters: - - description: The Id or Name of db_instance_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_parameter_CustomizeDeleteOutput' - summary: 删除 - tags: - - db_instance_parameter - get: - description: 获取详情 - operationId: db_instance_parameter_FetchCustomizeColumns - parameters: - - description: The Id or Name of db_instance_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_parameter_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - db_instance_parameter - put: - description: 更新 - operationId: db_instance_parameter_ValidateUpdateData - parameters: - - description: The Id or Name of db_instance_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_parameter: - $ref: '#/definitions/StandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_parameter_ValidateUpdateDataOutput' - summary: 更新 - tags: - - db_instance_parameter - /db_instance_parameters/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: db_instance_parameter_GetDetailsClassMetadata - parameters: - - description: The Id or Name of db_instance_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_parameter_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - db_instance_parameter - post: - description: 执行操作ClassMetadata - operationId: db_instance_parameter_PerformClassMetadata - parameters: - - description: The Id or Name of db_instance_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_parameter: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_parameter_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - db_instance_parameter - /db_instance_parameters/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: db_instance_parameter_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 db_instance_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_parameter_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - db_instance_parameter - /db_instance_parameters/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: db_instance_parameter_PerformSetClassMetadata - parameters: - - description: The Id or Name of db_instance_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_parameter: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_parameter_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - db_instance_parameter - /db_instance_parameters/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: db_instance_parameter_PerformSetUserMetadata - parameters: - - description: The Id or Name of db_instance_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_parameter: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_parameter_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - db_instance_parameter - /db_instance_parameters/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: db_instance_parameter_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/db_instance_parameter_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - db_instance_parameter - /db_instance_parameters/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: db_instance_parameter_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - db_instance_parameter: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_parameter_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - db_instance_parameter - /db_instance_parameters/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: db_instance_parameter_GetPropertySplitable - responses: - "200": - $ref: '#/responses/db_instance_parameter_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - db_instance_parameter - /db_instance_parameters/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: db_instance_parameter_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/db_instance_parameter_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - db_instance_parameter - /db_instance_parameters/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: db_instance_parameter_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/db_instance_parameter_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - db_instance_parameter - /db_instance_parameters/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: db_instance_parameter_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/db_instance_parameter_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - db_instance_parameter - /db_instance_privileges: - get: - description: 列表 - operationId: db_instance_privilege_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: filter by dbinstanceaccount - in: query - name: dbinstanceaccount - type: string - x-go-name: Dbinstanceaccount - - description: filter by dbinstancedatabase - in: query - name: dbinstancedatabase - type: string - x-go-name: Dbinstancedatabase - - description: 权限 - in: query - items: - type: string - name: privilege - type: array - x-go-name: Privilege - responses: - "200": - $ref: '#/responses/db_instance_privilege_ListItemFilterOutput' - summary: 列表 - tags: - - db_instance_privilege - post: - description: 新建 - operationId: db_instance_privilege_ValidateCreateData - responses: - "200": - $ref: '#/responses/db_instance_privilege_ValidateCreateDataOutput' - summary: 新建 - tags: - - db_instance_privilege - /db_instance_privileges/{id}: - delete: - description: 删除 - operationId: db_instance_privilege_CustomizeDelete - parameters: - - description: The Id or Name of db_instance_privilege - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_privilege_CustomizeDeleteOutput' - summary: 删除 - tags: - - db_instance_privilege - get: - description: 获取详情 - operationId: db_instance_privilege_FetchCustomizeColumns - parameters: - - description: The Id or Name of db_instance_privilege - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_privilege_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - db_instance_privilege - put: - description: 更新 - operationId: db_instance_privilege_ValidateUpdateData - parameters: - - description: The Id or Name of db_instance_privilege - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_privilege: - $ref: '#/definitions/ResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_privilege_ValidateUpdateDataOutput' - summary: 更新 - tags: - - db_instance_privilege - /db_instance_privileges/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: db_instance_privilege_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/db_instance_privilege_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - db_instance_privilege - /db_instance_privileges/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: db_instance_privilege_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - db_instance_privilege: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_privilege_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - db_instance_privilege - /db_instance_privileges/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: db_instance_privilege_GetPropertySplitable - responses: - "200": - $ref: '#/responses/db_instance_privilege_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - db_instance_privilege - /db_instance_privileges/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: db_instance_privilege_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/db_instance_privilege_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - db_instance_privilege - /db_instance_secgroups: - get: - description: 列表 - operationId: db_instance_secgroup_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: RDS实例(ID or Name) - in: query - name: dbinstance_id - type: string - x-go-name: DBInstanceId - - description: 以RDS实例名字排序 - in: query - name: order_by_dbinstance - type: string - x-go-name: OrderByDBInstance - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 过滤关联指定安全组（ID或Name）的列表结果 - in: query - name: secgroup_id - type: string - x-go-name: SecgroupId - - description: 模糊匹配安全组规则名称 - in: query - name: secgroup_name - type: string - x-go-name: SecgroupName - - description: 以安全组排序 - in: query - name: order_by_secgroup - type: string - x-go-name: OrderBySecgroup - responses: - "200": - $ref: '#/responses/db_instance_secgroup_ListItemFilterOutput' - summary: 列表 - tags: - - db_instance_secgroup - post: - description: 新建 - operationId: db_instance_secgroup_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - db_instance_secgroup: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_secgroup_ValidateCreateDataOutput' - summary: 新建 - tags: - - db_instance_secgroup - /db_instance_secgroups/{id}: - delete: - description: 删除 - operationId: db_instance_secgroup_CustomizeDelete - parameters: - - description: The Id or Name of db_instance_secgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_secgroup_CustomizeDeleteOutput' - summary: 删除 - tags: - - db_instance_secgroup - get: - description: 获取详情 - operationId: db_instance_secgroup_FetchCustomizeColumns - parameters: - - description: The Id or Name of db_instance_secgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_secgroup_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - db_instance_secgroup - put: - description: 更新 - operationId: db_instance_secgroup_ValidateUpdateData - parameters: - - description: The Id or Name of db_instance_secgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_secgroup: - $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_secgroup_ValidateUpdateDataOutput' - summary: 更新 - tags: - - db_instance_secgroup - /db_instance_secgroups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: db_instance_secgroup_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/db_instance_secgroup_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - db_instance_secgroup - /db_instance_secgroups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: db_instance_secgroup_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - db_instance_secgroup: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_secgroup_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - db_instance_secgroup - /db_instance_secgroups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: db_instance_secgroup_GetPropertySplitable - responses: - "200": - $ref: '#/responses/db_instance_secgroup_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - db_instance_secgroup - /db_instance_secgroups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: db_instance_secgroup_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/db_instance_secgroup_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - db_instance_secgroup - /db_instance_skus: - get: - description: 列表 - operationId: db_instance_sku_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 计费类型，按需计费和预付费 - in: query - name: billing_type - pattern: prepaid|postpaid - type: string - x-go-name: BillingType - - description: 计费过期时间的查询起始时间 - format: date-time - in: query - name: billing_expire_since - type: string - x-go-name: BillingExpireSince - - description: 计费过期时间的查询终止时间 - format: date-time - in: query - name: billing_expire_before - type: string - x-go-name: BillingExpireBefore - - description: 计费周期 - example: 7d - in: query - name: billing_cycle - type: string - x-go-name: BillingCycle - - description: StorageType - in: query - items: - type: string - name: storage_type - type: array - x-go-name: StorageType - - in: query - items: - format: int64 - type: integer - name: vcpu_count - type: array - x-go-name: VcpuCount - - in: query - items: - format: int64 - type: integer - name: vmem_size_mb - type: array - x-go-name: VmemSizeMb - - in: query - items: - type: string - name: category - type: array - x-go-name: Category - - in: query - items: - type: string - name: engine - type: array - x-go-name: Engine - - in: query - items: - type: string - name: engine_version - type: array - x-go-name: EngineVersion - - in: query - items: - type: string - name: zone1 - type: array - x-go-name: Zone1 - - in: query - items: - type: string - name: zone2 - type: array - x-go-name: Zone2 - - in: query - items: - type: string - name: zone3 - type: array - x-go-name: Zone3 - responses: - "200": - $ref: '#/responses/db_instance_sku_ListItemFilterOutput' - summary: RDS套餐类型列表 - tags: - - db_instance_sku - post: - description: 新建 - operationId: db_instance_sku_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - db_instance_sku: - $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_ValidateCreateDataOutput' - summary: 新建 - tags: - - db_instance_sku - /db_instance_skus/{id}: - delete: - description: 删除 - operationId: db_instance_sku_CustomizeDelete - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_sku_CustomizeDeleteOutput' - summary: 删除 - tags: - - db_instance_sku - get: - description: 获取详情 - operationId: db_instance_sku_FetchCustomizeColumns - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_sku_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - db_instance_sku - put: - description: 更新 - operationId: db_instance_sku_ValidateUpdateData - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_sku: - $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_ValidateUpdateDataOutput' - summary: 更新 - tags: - - db_instance_sku - /db_instance_skus/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: db_instance_sku_GetDetailsClassMetadata - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_sku_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - db_instance_sku - post: - description: 执行操作ClassMetadata - operationId: db_instance_sku_PerformClassMetadata - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - db_instance_sku - /db_instance_skus/{id}/disable: - post: - description: 执行操作Disable - operationId: db_instance_sku_PerformDisable - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_sku: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_PerformDisableOutput' - summary: 禁用资源 - tags: - - db_instance_sku - /db_instance_skus/{id}/enable: - post: - description: 执行操作Enable - operationId: db_instance_sku_PerformEnable - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_sku: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_PerformEnableOutput' - summary: 启用资源 - tags: - - db_instance_sku - /db_instance_skus/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: db_instance_sku_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 db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_sku_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - db_instance_sku - /db_instance_skus/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: db_instance_sku_PerformSetClassMetadata - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - db_instance_sku - /db_instance_skus/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: db_instance_sku_PerformSetUserMetadata - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - db_instance_sku - /db_instance_skus/{id}/status: - get: - description: 获取指定信息Status - operationId: db_instance_sku_GetDetailsStatus - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_sku_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - db_instance_sku - post: - description: 执行操作Status - operationId: db_instance_sku_PerformStatus - parameters: - - description: The Id or Name of db_instance_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance_sku: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_PerformStatusOutput' - summary: 更新资源状态 - tags: - - db_instance_sku - /db_instance_skus/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: db_instance_sku_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/db_instance_sku_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - db_instance_sku - /db_instance_skus/instance-specs: - get: - description: 获取指定资源类的信息InstanceSpecs - operationId: db_instance_sku_GetPropertyInstanceSpecs - responses: - "200": - $ref: '#/responses/db_instance_sku_GetPropertyInstanceSpecsOutput' - summary: 获取指定资源类的信息InstanceSpecs - tags: - - db_instance_sku - /db_instance_skus/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: db_instance_sku_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - db_instance_sku: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - db_instance_sku - /db_instance_skus/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: db_instance_sku_GetPropertySplitable - responses: - "200": - $ref: '#/responses/db_instance_sku_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - db_instance_sku - /db_instance_skus/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: db_instance_sku_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/db_instance_sku_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - db_instance_sku - /db_instance_skus/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: db_instance_sku_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/db_instance_sku_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - db_instance_sku - /db_instance_skus/sync-skus: - post: - description: 执行操作SyncSkus - operationId: db_instance_sku_PerformSyncSkus - parameters: - - in: body - name: body - schema: - properties: - db_instance_sku: - $ref: '#/definitions/SkuSyncInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_sku_PerformSyncSkusOutput' - summary: 执行操作SyncSkus - tags: - - db_instance_sku - /db_instance_skus/sync-tasks: - get: - description: 获取指定资源类的信息SyncTasks - operationId: db_instance_sku_GetPropertySyncTasks - parameters: - - description: 异步任务ID - in: query - items: - type: string - name: task_ids - type: array - x-go-name: TaskIds - responses: - "200": - $ref: '#/responses/db_instance_sku_GetPropertySyncTasksOutput' - summary: 获取指定资源类的信息SyncTasks - tags: - - db_instance_sku - /db_instance_skus/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: db_instance_sku_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/db_instance_sku_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - db_instance_sku - /db_instance_skus/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: db_instance_sku_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/db_instance_sku_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - db_instance_sku - /db_instances: - get: - description: 列表 - operationId: db_instance_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 是否禁止删除 - in: query - name: disable_delete - type: boolean - x-go-name: DisableDelete - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - in: query - name: master_instance - type: string - x-go-name: MasterInstance - - format: int64 - in: query - name: vcpu_count - type: integer - x-go-name: VcpuCount - - format: int64 - in: query - name: vmem_size_mb - type: integer - x-go-name: VmemSizeMb - - in: query - name: storage_type - type: string - x-go-name: StorageType - - in: query - name: category - type: string - x-go-name: Category - - in: query - name: engine - type: string - x-go-name: Engine - - in: query - name: engine_version - type: string - x-go-name: EngineVersion - - in: query - name: instance_type - type: string - x-go-name: InstanceType - - description: 通过IP搜索RDS实例 - in: query - name: ip_addr - type: string - x-go-name: IpAddr - responses: - "200": - $ref: '#/responses/db_instance_ListItemFilterOutput' - summary: RDS实例列表 - tags: - - db_instance - post: - description: 新建 - operationId: db_instance_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - db_instance: - $ref: '#/definitions/DBInstanceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_ValidateCreateDataOutput' - summary: 新建 - tags: - - db_instance - /db_instances/{id}: - delete: - description: 删除 - operationId: db_instance_CustomizeDelete - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_CustomizeDeleteOutput' - summary: 删除 - tags: - - db_instance - get: - description: 获取详情 - operationId: db_instance_FetchCustomizeColumns - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - db_instance - put: - description: 更新 - operationId: db_instance_ValidateUpdateData - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_ValidateUpdateDataOutput' - summary: 更新 - tags: - - db_instance - /db_instances/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: db_instance_PerformCancelDelete - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - db_instance - /db_instances/{id}/cancel-expire: - post: - description: 执行操作CancelExpire - operationId: db_instance_PerformCancelExpire - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_PerformCancelExpireOutput' - summary: 执行操作CancelExpire - tags: - - db_instance - /db_instances/{id}/change-config: - post: - description: 执行操作ChangeConfig - operationId: db_instance_PerformChangeConfig - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/SDBInstanceChangeConfigInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformChangeConfigOutput' - summary: 执行操作ChangeConfig - tags: - - db_instance - /db_instances/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: db_instance_PerformChangeOwner - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - db_instance - /db_instances/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: db_instance_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - db_instance - /db_instances/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: db_instance_GetDetailsClassMetadata - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - db_instance - post: - description: 执行操作ClassMetadata - operationId: db_instance_PerformClassMetadata - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - db_instance - /db_instances/{id}/freeze: - post: - description: 执行操作Freeze - operationId: db_instance_PerformFreeze - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - db_instance - /db_instances/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: db_instance_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 db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - db_instance - /db_instances/{id}/postpaid-expire: - post: - description: 执行操作PostpaidExpire - operationId: db_instance_PerformPostpaidExpire - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/PostpaidExpireInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformPostpaidExpireOutput' - summary: 执行操作PostpaidExpire - tags: - - db_instance - /db_instances/{id}/public-connection: - post: - description: 执行操作PublicConnection - operationId: db_instance_PerformPublicConnection - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_PerformPublicConnectionOutput' - summary: 执行操作PublicConnection - tags: - - db_instance - /db_instances/{id}/purge: - post: - description: 执行操作Purge - operationId: db_instance_PerformPurge - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - db_instance - /db_instances/{id}/reboot: - post: - description: 执行操作Reboot - operationId: db_instance_PerformReboot - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_PerformRebootOutput' - summary: 执行操作Reboot - tags: - - db_instance - /db_instances/{id}/recovery: - post: - description: 执行操作Recovery - operationId: db_instance_PerformRecovery - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/SDBInstanceRecoveryConfigInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformRecoveryOutput' - summary: 执行操作Recovery - tags: - - db_instance - /db_instances/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: db_instance_PerformRemoteUpdate - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/DBInstanceRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - db_instance - /db_instances/{id}/renew: - post: - description: 执行操作Renew - operationId: db_instance_PerformRenew - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_PerformRenewOutput' - summary: 执行操作Renew - tags: - - db_instance - /db_instances/{id}/set-auto-renew: - post: - description: |- - 要求RDS状态为running - 要求RDS计费类型为包年包月(预付费) - operationId: db_instance_PerformSetAutoRenew - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/DBInstanceAutoRenewInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformSetAutoRenewOutput' - summary: 设置自动续费 - tags: - - db_instance - /db_instances/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: db_instance_PerformSetClassMetadata - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - db_instance - /db_instances/{id}/set-secgroup: - post: - description: 执行操作SetSecgroup - operationId: db_instance_PerformSetSecgroup - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/DBInstanceSetSecgroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformSetSecgroupOutput' - summary: 执行操作SetSecgroup - tags: - - db_instance - /db_instances/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: db_instance_PerformSetUserMetadata - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - db_instance - /db_instances/{id}/status: - get: - description: 获取指定信息Status - operationId: db_instance_GetDetailsStatus - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - db_instance - post: - description: 执行操作Status - operationId: db_instance_PerformStatus - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformStatusOutput' - summary: 更新资源状态 - tags: - - db_instance - /db_instances/{id}/sync: - post: - description: 执行操作Sync - operationId: db_instance_PerformSync - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_PerformSyncOutput' - summary: 同步RDS信息 - tags: - - db_instance - /db_instances/{id}/sync-status: - post: - description: 执行操作SyncStatus - operationId: db_instance_PerformSyncStatus - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_PerformSyncStatusOutput' - summary: 同步RDS状态(弃用) - tags: - - db_instance - /db_instances/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: db_instance_PerformSyncstatus - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/db_instance_PerformSyncstatusOutput' - summary: 同步RDS实例状态 - tags: - - db_instance - /db_instances/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: db_instance_PerformUnfreeze - parameters: - - description: The Id or Name of db_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - db_instance - /db_instances/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: db_instance_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/db_instance_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - db_instance - /db_instances/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: db_instance_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/db_instance_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - db_instance - /db_instances/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: db_instance_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/db_instance_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - db_instance - /db_instances/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: db_instance_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/db_instance_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - db_instance - /db_instances/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: db_instance_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/db_instance_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - db_instance - /db_instances/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: db_instance_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - db_instance: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/db_instance_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - db_instance - /db_instances/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: db_instance_GetPropertySplitable - responses: - "200": - $ref: '#/responses/db_instance_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - db_instance - /db_instances/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: db_instance_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/db_instance_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - db_instance - /db_instances/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: db_instance_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/db_instance_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - db_instance - /db_instances/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: db_instance_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/db_instance_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - db_instance - /db_instances/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: db_instance_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/db_instance_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - db_instance - /disk_backups: - get: - description: 列表 - operationId: disk_backup_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: |- - 通过操作系统架构过滤 - x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 - arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 - 其他的输入会过滤出以输入字符开头的资源 - enmu: x86, arm - in: query - name: os_arch - type: string - x-go-name: OsArch - - description: 'description: disk id' - in: query - name: disk_id - type: string - x-go-name: DiskId - - description: 'description: backup storage id' - in: query - name: backup_storage_id - type: string - x-go-name: BackupStorageId - - description: 'description: 是否为主机备份的一部分' - in: query - name: is_instance_backup - type: boolean - x-go-name: IsInstanceBackup - - description: 按硬盘名称排序 - in: query - name: order_by_disk_name - type: string - x-go-name: OrderByDiskName - responses: - "200": - $ref: '#/responses/disk_backup_ListItemFilterOutput' - summary: 列表 - tags: - - disk_backup - post: - description: 新建 - operationId: disk_backup_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - disk_backup: - $ref: '#/definitions/DiskBackupCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_ValidateCreateDataOutput' - summary: 新建 - tags: - - disk_backup - /disk_backups/{id}: - delete: - description: 删除 - operationId: disk_backup_CustomizeDelete - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_backup_CustomizeDeleteOutput' - summary: 删除 - tags: - - disk_backup - get: - description: 获取详情 - operationId: disk_backup_FetchCustomizeColumns - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_backup_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - disk_backup - put: - description: 更新 - operationId: disk_backup_ValidateUpdateData - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_ValidateUpdateDataOutput' - summary: 更新 - tags: - - disk_backup - /disk_backups/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: disk_backup_PerformCancelDelete - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_backup_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - disk_backup - /disk_backups/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: disk_backup_PerformChangeOwner - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - disk_backup - /disk_backups/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: disk_backup_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_backup_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - disk_backup - /disk_backups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: disk_backup_GetDetailsClassMetadata - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_backup_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - disk_backup - post: - description: 执行操作ClassMetadata - operationId: disk_backup_PerformClassMetadata - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - disk_backup - /disk_backups/{id}/freeze: - post: - description: 执行操作Freeze - operationId: disk_backup_PerformFreeze - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - disk_backup - /disk_backups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: disk_backup_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 disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_backup_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - disk_backup - /disk_backups/{id}/recovery: - post: - description: 执行操作Recovery - operationId: disk_backup_PerformRecovery - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - $ref: '#/definitions/DiskBackupRecoveryInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformRecoveryOutput' - summary: 执行操作Recovery - tags: - - disk_backup - /disk_backups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: disk_backup_PerformSetClassMetadata - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - disk_backup - /disk_backups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: disk_backup_PerformSetUserMetadata - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - disk_backup - /disk_backups/{id}/status: - get: - description: 获取指定信息Status - operationId: disk_backup_GetDetailsStatus - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_backup_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - disk_backup - post: - description: 执行操作Status - operationId: disk_backup_PerformStatus - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformStatusOutput' - summary: 更新资源状态 - tags: - - disk_backup - /disk_backups/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: disk_backup_PerformSyncstatus - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - $ref: '#/definitions/DiskBackupSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - disk_backup - /disk_backups/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: disk_backup_PerformUnfreeze - parameters: - - description: The Id or Name of disk_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk_backup: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - disk_backup - /disk_backups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: disk_backup_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/disk_backup_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - disk_backup - /disk_backups/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: disk_backup_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/disk_backup_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - disk_backup - /disk_backups/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: disk_backup_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/disk_backup_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - disk_backup - /disk_backups/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: disk_backup_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/disk_backup_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - disk_backup - /disk_backups/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: disk_backup_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/disk_backup_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - disk_backup - /disk_backups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: disk_backup_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - disk_backup: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_backup_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - disk_backup - /disk_backups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: disk_backup_GetPropertySplitable - responses: - "200": - $ref: '#/responses/disk_backup_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - disk_backup - /disk_backups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: disk_backup_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/disk_backup_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - disk_backup - /disk_backups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: disk_backup_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/disk_backup_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - disk_backup - /disk_backups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: disk_backup_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/disk_backup_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - disk_backup - /disk_backups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: disk_backup_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/disk_backup_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - disk_backup - /disks: - get: - description: 列表 - operationId: disk_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: |- - 通过操作系统架构过滤 - x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 - arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 - 其他的输入会过滤出以输入字符开头的资源 - enmu: x86, arm - in: query - name: os_arch - type: string - x-go-name: OsArch - - in: query - name: AutoDelete - type: boolean - - description: 计费类型，按需计费和预付费 - in: query - name: billing_type - pattern: prepaid|postpaid - type: string - x-go-name: BillingType - - description: 计费过期时间的查询起始时间 - format: date-time - in: query - name: billing_expire_since - type: string - x-go-name: BillingExpireSince - - description: 计费过期时间的查询终止时间 - format: date-time - in: query - name: billing_expire_before - type: string - x-go-name: BillingExpireBefore - - description: 计费周期 - example: 7d - in: query - name: billing_cycle - type: string - x-go-name: BillingCycle - - description: 存储（ID或Name） - in: query - name: storage_id - type: string - x-go-name: StorageId - - description: 以存储名称排序 - in: query - name: order_by_storage - pattern: asc|desc - type: string - x-go-name: OrderByStorage - - description: filter shared storage - in: query - name: share - type: boolean - x-go-name: Share - - description: filter local storage - in: query - name: local - type: boolean - x-go-name: Local - - description: filter disk by snapshotpolicy - in: query - name: snapshotpolicy_id - type: string - x-go-name: SnapshotpolicyId - - description: 以快照策略名称排序 - in: query - name: order_by_snapshotpolicy - type: string - x-go-name: OrderBySnapshotpolicy - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: filter disk by whether it is being used - in: query - name: unused - type: boolean - x-go-name: Unused - - description: |- - 过滤指定disk_type的磁盘列表，可能的值为：sys, data, swap. volume - - disk_type值 | 说明 | - -------------|----------| - sys | 虚拟机系统盘 | - data | 虚拟机数据盘 | - swap | 虚拟机内存交换盘 | - volume | 容器volumn盘 | - in: query - name: disk_type - type: string - x-go-name: DiskType - - in: query - name: disk_format - type: string - x-go-name: DiskFormat - - format: int64 - in: query - name: disk_size - type: integer - x-go-name: DiskSize - - in: query - name: fs_format - type: string - x-go-name: FsFormat - - description: 以主机名称排序 - in: query - name: order_by_server - type: string - x-go-name: OrderByServer - - in: query - name: order_by_guest_count - type: string - x-go-name: OrderByGuestCount - - description: 镜像 - in: query - name: image_id - type: string - x-go-name: ImageId - - description: 快照 - in: query - name: snapshot_id - type: string - x-go-name: SnapshotId - responses: - "200": - $ref: '#/responses/disk_ListItemFilterOutput' - summary: 磁盘列表 - tags: - - disk - post: - description: 新建 - operationId: disk_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - disk: - $ref: '#/definitions/DiskCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_ValidateCreateDataOutput' - summary: 新建 - tags: - - disk - /disks/{id}: - delete: - description: 删除 - operationId: disk_CustomizeDelete - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_CustomizeDeleteOutput' - summary: 删除 - tags: - - disk - get: - description: 获取详情 - operationId: disk_FetchCustomizeColumns - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - disk - put: - description: 更新 - operationId: disk_ValidateUpdateData - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/DiskUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_ValidateUpdateDataOutput' - summary: 更新 - tags: - - disk - /disks/{id}/bind-snapshotpolicy: - post: - description: 执行操作BindSnapshotpolicy - operationId: disk_PerformBindSnapshotpolicy - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_PerformBindSnapshotpolicyOutput' - summary: 执行操作BindSnapshotpolicy - tags: - - disk - /disks/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: disk_PerformCancelDelete - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - disk - /disks/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: disk_PerformChangeOwner - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - disk - /disks/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: disk_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - disk - /disks/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: disk_GetDetailsClassMetadata - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - disk - post: - description: 执行操作ClassMetadata - operationId: disk_PerformClassMetadata - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - disk - /disks/{id}/convert-snapshot: - get: - description: 获取指定信息ConvertSnapshot - operationId: disk_GetDetailsConvertSnapshot - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_GetDetailsConvertSnapshotOutput' - summary: 获取指定信息ConvertSnapshot - tags: - - disk - /disks/{id}/disk-reset: - post: - description: 执行操作DiskReset - operationId: disk_PerformDiskReset - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/DiskResetInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformDiskResetOutput' - summary: 执行操作DiskReset - tags: - - disk - /disks/{id}/freeze: - post: - description: 执行操作Freeze - operationId: disk_PerformFreeze - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - disk - /disks/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: disk_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 disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - disk - /disks/{id}/purge: - post: - description: 执行操作Purge - operationId: disk_PerformPurge - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - disk - /disks/{id}/resize: - post: - description: 执行操作Resize - operationId: disk_PerformResize - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/DiskResizeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformResizeOutput' - summary: 执行操作Resize - tags: - - disk - /disks/{id}/save: - post: - description: 执行操作Save - operationId: disk_PerformSave - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/DiskSaveInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformSaveOutput' - summary: 执行操作Save - tags: - - disk - /disks/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: disk_PerformSetClassMetadata - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - disk - /disks/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: disk_PerformSetUserMetadata - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - disk - /disks/{id}/status: - get: - description: 获取指定信息Status - operationId: disk_GetDetailsStatus - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - disk - post: - description: 执行操作Status - operationId: disk_PerformStatus - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformStatusOutput' - summary: 更新资源状态 - tags: - - disk - /disks/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: disk_PerformSyncstatus - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/DiskSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformSyncstatusOutput' - summary: 同步磁盘状态 - tags: - - disk - /disks/{id}/unbind-snapshotpolicy: - post: - description: 执行操作UnbindSnapshotpolicy - operationId: disk_PerformUnbindSnapshotpolicy - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/disk_PerformUnbindSnapshotpolicyOutput' - summary: 执行操作UnbindSnapshotpolicy - tags: - - disk - /disks/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: disk_PerformUnfreeze - parameters: - - description: The Id or Name of disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - disk - /disks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: disk_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/disk_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - disk - /disks/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: disk_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/disk_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - disk - /disks/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: disk_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/disk_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - disk - /disks/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: disk_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/disk_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - disk - /disks/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: disk_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/disk_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - disk - /disks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: disk_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - disk: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/disk_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - disk - /disks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: disk_GetPropertySplitable - responses: - "200": - $ref: '#/responses/disk_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - disk - /disks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: disk_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/disk_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - disk - /disks/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: disk_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/disk_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - disk - /disks/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: disk_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/disk_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - disk - /disks/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: disk_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/disk_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - disk - /dns_record_set_traffic_policies: - get: - description: 列表 - operationId: dns_record_set_traffic_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 - responses: - "200": - $ref: '#/responses/dns_record_set_traffic_policy_ListItemFilterOutput' - summary: 列表 - tags: - - dns_record_set_traffic_policy - post: - description: 新建 - operationId: dns_record_set_traffic_policy_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - dns_record_set_traffic_policy: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_set_traffic_policy_ValidateCreateDataOutput' - summary: 新建 - tags: - - dns_record_set_traffic_policy - /dns_record_set_traffic_policies/{id}: - delete: - description: 删除 - operationId: dns_record_set_traffic_policy_CustomizeDelete - parameters: - - description: The Id or Name of dns_record_set_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_set_traffic_policy_CustomizeDeleteOutput' - summary: 删除 - tags: - - dns_record_set_traffic_policy - get: - description: 获取详情 - operationId: dns_record_set_traffic_policy_FetchCustomizeColumns - parameters: - - description: The Id or Name of dns_record_set_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_set_traffic_policy_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - dns_record_set_traffic_policy - put: - description: 更新 - operationId: dns_record_set_traffic_policy_ValidateUpdateData - parameters: - - description: The Id or Name of dns_record_set_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record_set_traffic_policy: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_set_traffic_policy_ValidateUpdateDataOutput' - summary: 更新 - tags: - - dns_record_set_traffic_policy - /dns_record_set_traffic_policies/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: dns_record_set_traffic_policy_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/dns_record_set_traffic_policy_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - dns_record_set_traffic_policy - /dns_record_set_traffic_policies/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: dns_record_set_traffic_policy_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - dns_record_set_traffic_policy: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_set_traffic_policy_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - dns_record_set_traffic_policy - /dns_record_set_traffic_policies/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: dns_record_set_traffic_policy_GetPropertySplitable - responses: - "200": - $ref: '#/responses/dns_record_set_traffic_policy_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - dns_record_set_traffic_policy - /dns_record_set_traffic_policies/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: dns_record_set_traffic_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/dns_record_set_traffic_policy_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - dns_record_set_traffic_policy - /dns_records: - get: - description: 列表 - operationId: dns_record_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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 - responses: - "200": - $ref: '#/responses/dns_record_ListItemFilterOutput' - summary: 域名记录列表 - tags: - - dns_record - post: - description: 新建 - operationId: dns_record_ValidateCreateData - responses: - "200": - $ref: '#/responses/dns_record_ValidateCreateDataOutput' - summary: 新建 - tags: - - dns_record - /dns_records/{id}: - delete: - description: 删除 - operationId: dns_record_CustomizeDelete - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_CustomizeDeleteOutput' - summary: 删除 - tags: - - dns_record - get: - description: 获取详情 - operationId: dns_record_FetchCustomizeColumns - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - dns_record - put: - description: 更新 - operationId: dns_record_ValidateUpdateData - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_ValidateUpdateDataOutput' - summary: 更新 - tags: - - dns_record - /dns_records/{id}/add-records: - post: - description: 执行操作AddRecords - operationId: dns_record_PerformAddRecords - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_PerformAddRecordsOutput' - summary: 执行操作AddRecords - tags: - - dns_record - /dns_records/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: dns_record_PerformCancelDelete - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - dns_record - /dns_records/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: dns_record_PerformChangeOwner - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - dns_record - /dns_records/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: dns_record_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - dns_record - /dns_records/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: dns_record_GetDetailsClassMetadata - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - dns_record - post: - description: 执行操作ClassMetadata - operationId: dns_record_PerformClassMetadata - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - dns_record - /dns_records/{id}/disable: - post: - description: 执行操作Disable - operationId: dns_record_PerformDisable - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformDisableOutput' - summary: 执行操作Disable - tags: - - dns_record - /dns_records/{id}/enable: - post: - description: 执行操作Enable - operationId: dns_record_PerformEnable - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformEnableOutput' - summary: 执行操作Enable - tags: - - dns_record - /dns_records/{id}/freeze: - post: - description: 执行操作Freeze - operationId: dns_record_PerformFreeze - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - dns_record - /dns_records/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: dns_record_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 dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - dns_record - /dns_records/{id}/private: - post: - description: 执行操作Private - operationId: dns_record_PerformPrivate - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformPrivateOutput' - summary: 执行操作Private - tags: - - dns_record - /dns_records/{id}/public: - post: - description: 执行操作Public - operationId: dns_record_PerformPublic - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformPublicOutput' - summary: 执行操作Public - tags: - - dns_record - /dns_records/{id}/remove-records: - post: - description: 执行操作RemoveRecords - operationId: dns_record_PerformRemoveRecords - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_PerformRemoveRecordsOutput' - summary: 执行操作RemoveRecords - tags: - - dns_record - /dns_records/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: dns_record_PerformSetClassMetadata - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - dns_record - /dns_records/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: dns_record_PerformSetUserMetadata - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - dns_record - /dns_records/{id}/status: - get: - description: 获取指定信息Status - operationId: dns_record_GetDetailsStatus - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_record_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - dns_record - post: - description: 执行操作Status - operationId: dns_record_PerformStatus - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformStatusOutput' - summary: 更新资源状态 - tags: - - dns_record - /dns_records/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: dns_record_PerformUnfreeze - parameters: - - description: The Id or Name of dns_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_record: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - dns_record - /dns_records/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: dns_record_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/dns_record_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - dns_record - /dns_records/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: dns_record_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/dns_record_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - dns_record - /dns_records/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: dns_record_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/dns_record_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - dns_record - /dns_records/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: dns_record_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/dns_record_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - dns_record - /dns_records/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: dns_record_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/dns_record_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - dns_record - /dns_records/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: dns_record_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - dns_record: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_record_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - dns_record - /dns_records/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: dns_record_GetPropertySplitable - responses: - "200": - $ref: '#/responses/dns_record_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - dns_record - /dns_records/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: dns_record_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/dns_record_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - dns_record - /dns_records/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: dns_record_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/dns_record_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - dns_record - /dns_records/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: dns_record_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/dns_record_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - dns_record - /dns_records/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: dns_record_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/dns_record_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - dns_record - /dns_recordsets: - get: - description: 列表 - operationId: dns_recordset_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 - - in: query - name: dns_zone_id - type: string - x-go-name: DnsZoneId - responses: - "200": - $ref: '#/responses/dns_recordset_ListItemFilterOutput' - summary: DNS记录列表 - tags: - - dns_recordset - post: - description: 新建 - operationId: dns_recordset_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - dns_recordset: - $ref: '#/definitions/DnsRecordSetCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_ValidateCreateDataOutput' - summary: 创建 - tags: - - dns_recordset - /dns_recordsets/{id}: - delete: - description: 删除 - operationId: dns_recordset_CustomizeDelete - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_recordset_CustomizeDeleteOutput' - summary: 删除 - tags: - - dns_recordset - get: - description: 获取详情 - operationId: dns_recordset_FetchCustomizeColumns - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_recordset_FetchCustomizeColumnsOutput' - summary: 解析详情 - tags: - - dns_recordset - put: - description: 更新 - operationId: dns_recordset_ValidateUpdateData - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_recordset: - $ref: '#/definitions/DnsRecordSetUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_ValidateUpdateDataOutput' - summary: 更新 - tags: - - dns_recordset - /dns_recordsets/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: dns_recordset_GetDetailsClassMetadata - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_recordset_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - dns_recordset - post: - description: 执行操作ClassMetadata - operationId: dns_recordset_PerformClassMetadata - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_recordset: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - dns_recordset - /dns_recordsets/{id}/disable: - post: - description: 执行操作Disable - operationId: dns_recordset_PerformDisable - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_recordset: - $ref: '#/definitions/DnsRecordDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_PerformDisableOutput' - summary: 禁用 - tags: - - dns_recordset - /dns_recordsets/{id}/enable: - post: - description: 执行操作Enable - operationId: dns_recordset_PerformEnable - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_recordset: - $ref: '#/definitions/DnsRecordEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_PerformEnableOutput' - summary: 启用 - tags: - - dns_recordset - /dns_recordsets/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: dns_recordset_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 dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_recordset_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - dns_recordset - /dns_recordsets/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: dns_recordset_PerformSetClassMetadata - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_recordset: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - dns_recordset - /dns_recordsets/{id}/set-traffic-policies: - post: - description: 执行操作SetTrafficPolicies - operationId: dns_recordset_PerformSetTrafficPolicies - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_recordset: - $ref: '#/definitions/DnsRecordSetTrafficPoliciesInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_PerformSetTrafficPoliciesOutput' - summary: 设置流量策略 - tags: - - dns_recordset - /dns_recordsets/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: dns_recordset_PerformSetUserMetadata - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_recordset: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - dns_recordset - /dns_recordsets/{id}/status: - get: - description: 获取指定信息Status - operationId: dns_recordset_GetDetailsStatus - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_recordset_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - dns_recordset - post: - description: 执行操作Status - operationId: dns_recordset_PerformStatus - parameters: - - description: The Id or Name of dns_recordset - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_recordset: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_PerformStatusOutput' - summary: 更新资源状态 - tags: - - dns_recordset - /dns_recordsets/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: dns_recordset_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/dns_recordset_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - dns_recordset - /dns_recordsets/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: dns_recordset_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - dns_recordset: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_recordset_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - dns_recordset - /dns_recordsets/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: dns_recordset_GetPropertySplitable - responses: - "200": - $ref: '#/responses/dns_recordset_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - dns_recordset - /dns_recordsets/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: dns_recordset_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/dns_recordset_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - dns_recordset - /dns_recordsets/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: dns_recordset_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/dns_recordset_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - dns_recordset - /dns_recordsets/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: dns_recordset_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/dns_recordset_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - dns_recordset - /dns_recordsets/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: dns_recordset_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/dns_recordset_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - dns_recordset - /dns_traffic_policies: - get: - description: 列表 - operationId: dns_traffic_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: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - in: query - items: - type: string - name: provider - type: array - x-go-name: Provider - - in: query - name: policy_type - type: string - x-go-name: PolicyType - responses: - "200": - $ref: '#/responses/dns_traffic_policy_ListItemFilterOutput' - summary: 列表 - tags: - - dns_traffic_policy - post: - description: 新建 - operationId: dns_traffic_policy_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - dns_traffic_policy: - $ref: '#/definitions/DnsTrafficPolicyCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_ValidateCreateDataOutput' - summary: 创建 - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}: - delete: - description: 删除 - operationId: dns_traffic_policy_CustomizeDelete - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_traffic_policy_CustomizeDeleteOutput' - summary: 删除 - tags: - - dns_traffic_policy - get: - description: 获取详情 - operationId: dns_traffic_policy_FetchCustomizeColumns - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_traffic_policy_FetchCustomizeColumnsOutput' - summary: 详情 - tags: - - dns_traffic_policy - put: - description: 更新 - operationId: dns_traffic_policy_ValidateUpdateData - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_ValidateUpdateDataOutput' - summary: 更新 - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: dns_traffic_policy_PerformChangeOwner - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: dns_traffic_policy_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: dns_traffic_policy_GetDetailsClassMetadata - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - dns_traffic_policy - post: - description: 执行操作ClassMetadata - operationId: dns_traffic_policy_PerformClassMetadata - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/disable: - post: - description: 执行操作Disable - operationId: dns_traffic_policy_PerformDisable - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformDisableOutput' - summary: 禁用资源 - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/enable: - post: - description: 执行操作Enable - operationId: dns_traffic_policy_PerformEnable - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformEnableOutput' - summary: 启用资源 - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: dns_traffic_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 dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/private: - post: - description: 执行操作Private - operationId: dns_traffic_policy_PerformPrivate - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformPrivateOutput' - summary: 执行操作Private - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/public: - post: - description: 执行操作Public - operationId: dns_traffic_policy_PerformPublic - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformPublicOutput' - summary: 执行操作Public - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: dns_traffic_policy_PerformSetClassMetadata - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: dns_traffic_policy_PerformSetUserMetadata - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - dns_traffic_policy - /dns_traffic_policies/{id}/status: - get: - description: 获取指定信息Status - operationId: dns_traffic_policy_GetDetailsStatus - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - dns_traffic_policy - post: - description: 执行操作Status - operationId: dns_traffic_policy_PerformStatus - parameters: - - description: The Id or Name of dns_traffic_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformStatusOutput' - summary: 更新资源状态 - tags: - - dns_traffic_policy - /dns_traffic_policies/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: dns_traffic_policy_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - dns_traffic_policy - /dns_traffic_policies/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: dns_traffic_policy_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - dns_traffic_policy - /dns_traffic_policies/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: dns_traffic_policy_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - dns_traffic_policy - /dns_traffic_policies/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: dns_traffic_policy_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_traffic_policy_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - dns_traffic_policy - /dns_traffic_policies/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: dns_traffic_policy_GetPropertySplitable - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - dns_traffic_policy - /dns_traffic_policies/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: dns_traffic_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/dns_traffic_policy_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - dns_traffic_policy - /dns_traffic_policies/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: dns_traffic_policy_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - dns_traffic_policy - /dns_traffic_policies/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: dns_traffic_policy_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - dns_traffic_policy - /dns_traffic_policies/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: dns_traffic_policy_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/dns_traffic_policy_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - dns_traffic_policy - /dns_zone_caches: - get: - description: 列表 - operationId: dns_zone_cache_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 - - in: query - name: dns_zone_id - type: string - x-go-name: DnsZoneId - - in: query - name: cloudaccount_id - type: string - x-go-name: CloudaccountId - responses: - "200": - $ref: '#/responses/dns_zone_cache_ListItemFilterOutput' - summary: 列表 - tags: - - dns_zone_cache - post: - description: 新建 - operationId: dns_zone_cache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - dns_zone_cache: - $ref: '#/definitions/DnsZoneCacheCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_cache_ValidateCreateDataOutput' - summary: 新建 - tags: - - dns_zone_cache - /dns_zone_caches/{id}: - delete: - description: 删除 - operationId: dns_zone_cache_CustomizeDelete - parameters: - - description: The Id or Name of dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_cache_CustomizeDeleteOutput' - summary: 删除 - tags: - - dns_zone_cache - get: - description: 获取详情 - operationId: dns_zone_cache_FetchCustomizeColumns - parameters: - - description: The Id or Name of dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_cache_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - dns_zone_cache - put: - description: 更新 - operationId: dns_zone_cache_ValidateUpdateData - parameters: - - description: The Id or Name of dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone_cache: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_cache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - dns_zone_cache - /dns_zone_caches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: dns_zone_cache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_cache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - dns_zone_cache - post: - description: 执行操作ClassMetadata - operationId: dns_zone_cache_PerformClassMetadata - parameters: - - description: The Id or Name of dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_cache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - dns_zone_cache - /dns_zone_caches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: dns_zone_cache_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 dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_cache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - dns_zone_cache - /dns_zone_caches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: dns_zone_cache_PerformSetClassMetadata - parameters: - - description: The Id or Name of dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_cache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - dns_zone_cache - /dns_zone_caches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: dns_zone_cache_PerformSetUserMetadata - parameters: - - description: The Id or Name of dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_cache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - dns_zone_cache - /dns_zone_caches/{id}/status: - get: - description: 获取指定信息Status - operationId: dns_zone_cache_GetDetailsStatus - parameters: - - description: The Id or Name of dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_cache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - dns_zone_cache - post: - description: 执行操作Status - operationId: dns_zone_cache_PerformStatus - parameters: - - description: The Id or Name of dns_zone_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone_cache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_cache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - dns_zone_cache - /dns_zone_caches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: dns_zone_cache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/dns_zone_cache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - dns_zone_cache - /dns_zone_caches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: dns_zone_cache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - dns_zone_cache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_cache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - dns_zone_cache - /dns_zone_caches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: dns_zone_cache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/dns_zone_cache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - dns_zone_cache - /dns_zone_caches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: dns_zone_cache_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/dns_zone_cache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - dns_zone_cache - /dns_zone_caches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: dns_zone_cache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/dns_zone_cache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - dns_zone_cache - /dns_zone_caches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: dns_zone_cache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/dns_zone_cache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - dns_zone_cache - /dns_zone_caches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: dns_zone_cache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/dns_zone_cache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - dns_zone_cache - /dns_zone_vpcs: - get: - description: 列表 - operationId: dns_zone_vpc_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/dns_zone_vpc_ListItemFilterOutput' - summary: 列表 - tags: - - dns_zone_vpc - post: - description: 新建 - operationId: dns_zone_vpc_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - dns_zone_vpc: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_vpc_ValidateCreateDataOutput' - summary: 新建 - tags: - - dns_zone_vpc - /dns_zone_vpcs/{id}: - delete: - description: 删除 - operationId: dns_zone_vpc_CustomizeDelete - parameters: - - description: The Id or Name of dns_zone_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_vpc_CustomizeDeleteOutput' - summary: 删除 - tags: - - dns_zone_vpc - get: - description: 获取详情 - operationId: dns_zone_vpc_FetchCustomizeColumns - parameters: - - description: The Id or Name of dns_zone_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_vpc_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - dns_zone_vpc - put: - description: 更新 - operationId: dns_zone_vpc_ValidateUpdateData - parameters: - - description: The Id or Name of dns_zone_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone_vpc: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_vpc_ValidateUpdateDataOutput' - summary: 更新 - tags: - - dns_zone_vpc - /dns_zone_vpcs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: dns_zone_vpc_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/dns_zone_vpc_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - dns_zone_vpc - /dns_zone_vpcs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: dns_zone_vpc_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - dns_zone_vpc: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_vpc_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - dns_zone_vpc - /dns_zone_vpcs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: dns_zone_vpc_GetPropertySplitable - responses: - "200": - $ref: '#/responses/dns_zone_vpc_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - dns_zone_vpc - /dns_zone_vpcs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: dns_zone_vpc_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/dns_zone_vpc_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - dns_zone_vpc - /dns_zones: - get: - description: 列表 - operationId: dns_zone_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: |- - 区域类型 - - - 类型 | 说明 | - ---------- |---------| - PublicZone | 公有 | - PrivateZone | 私有 | - in: query - name: zone_type - type: string - x-go-name: ZoneType - - description: Filter dns zone By vpc - in: query - name: vpc_id - type: string - x-go-name: VpcId - - in: query - name: with_cache - type: boolean - x-go-name: WithCache - responses: - "200": - $ref: '#/responses/dns_zone_ListItemFilterOutput' - summary: 列表 - tags: - - dns_zone - post: - description: 新建 - operationId: dns_zone_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - dns_zone: - $ref: '#/definitions/DnsZoneCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_ValidateCreateDataOutput' - summary: 创建 - tags: - - dns_zone - /dns_zones/{id}: - delete: - description: 删除 - operationId: dns_zone_CustomizeDelete - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_CustomizeDeleteOutput' - summary: 删除 - tags: - - dns_zone - get: - description: 获取详情 - operationId: dns_zone_FetchCustomizeColumns - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_FetchCustomizeColumnsOutput' - summary: 解析详情 - tags: - - dns_zone - put: - description: 更新 - operationId: dns_zone_ValidateUpdateData - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_ValidateUpdateDataOutput' - summary: 更新 - tags: - - dns_zone - /dns_zones/{id}/add-vpcs: - post: - description: 执行操作AddVpcs - operationId: dns_zone_PerformAddVpcs - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneAddVpcsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformAddVpcsOutput' - summary: 添加VPC - tags: - - dns_zone - /dns_zones/{id}/cache: - post: - description: 执行操作Cache - operationId: dns_zone_PerformCache - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneCacheInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformCacheOutput' - summary: 指定云账号创建 - tags: - - dns_zone - /dns_zones/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: dns_zone_PerformChangeOwner - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - dns_zone - /dns_zones/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: dns_zone_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - dns_zone - /dns_zones/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: dns_zone_GetDetailsClassMetadata - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - dns_zone - post: - description: 执行操作ClassMetadata - operationId: dns_zone_PerformClassMetadata - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - dns_zone - /dns_zones/{id}/disable: - post: - description: 执行操作Disable - operationId: dns_zone_PerformDisable - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformDisableOutput' - summary: 禁用资源 - tags: - - dns_zone - /dns_zones/{id}/enable: - post: - description: 执行操作Enable - operationId: dns_zone_PerformEnable - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformEnableOutput' - summary: 启用资源 - tags: - - dns_zone - /dns_zones/{id}/exports: - get: - description: 获取指定信息Exports - operationId: dns_zone_GetDetailsExports - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_GetDetailsExportsOutput' - summary: 获取指定信息Exports - tags: - - dns_zone - /dns_zones/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: dns_zone_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 dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - dns_zone - /dns_zones/{id}/private: - post: - description: 执行操作Private - operationId: dns_zone_PerformPrivate - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformPrivateOutput' - summary: 执行操作Private - tags: - - dns_zone - /dns_zones/{id}/public: - post: - description: 执行操作Public - operationId: dns_zone_PerformPublic - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformPublicOutput' - summary: 执行操作Public - tags: - - dns_zone - /dns_zones/{id}/purge: - post: - description: 执行操作Purge - operationId: dns_zone_PerformPurge - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZonePurgeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - dns_zone - /dns_zones/{id}/remove-vpcs: - post: - description: 执行操作RemoveVpcs - operationId: dns_zone_PerformRemoveVpcs - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneRemoveVpcsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformRemoveVpcsOutput' - summary: 移除VPC - tags: - - dns_zone - /dns_zones/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: dns_zone_PerformSetClassMetadata - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - dns_zone - /dns_zones/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: dns_zone_PerformSetUserMetadata - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - dns_zone - /dns_zones/{id}/status: - get: - description: 获取指定信息Status - operationId: dns_zone_GetDetailsStatus - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dns_zone_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - dns_zone - post: - description: 执行操作Status - operationId: dns_zone_PerformStatus - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformStatusOutput' - summary: 更新资源状态 - tags: - - dns_zone - /dns_zones/{id}/sync-recordsets: - post: - description: 执行操作SyncRecordsets - operationId: dns_zone_PerformSyncRecordsets - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneSyncRecordSetsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformSyncRecordsetsOutput' - summary: 同步解析列表到云上 - tags: - - dns_zone - /dns_zones/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: dns_zone_PerformSyncstatus - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneSyncStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformSyncstatusOutput' - summary: 同步状态 - tags: - - dns_zone - /dns_zones/{id}/uncache: - post: - description: 执行操作Uncache - operationId: dns_zone_PerformUncache - parameters: - - description: The Id or Name of dns_zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneUnacheInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformUncacheOutput' - summary: 删除云账号的云上资源 - tags: - - dns_zone - /dns_zones/capability: - get: - description: 获取指定资源类的信息Capability - operationId: dns_zone_GetPropertyCapability - responses: - "200": - $ref: '#/responses/dns_zone_GetPropertyCapabilityOutput' - summary: 获取指定资源类的信息Capability - tags: - - dns_zone - /dns_zones/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: dns_zone_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/dns_zone_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - dns_zone - /dns_zones/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: dns_zone_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/dns_zone_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - dns_zone - /dns_zones/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: dns_zone_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/dns_zone_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - dns_zone - /dns_zones/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: dns_zone_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - dns_zone: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dns_zone_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - dns_zone - /dns_zones/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: dns_zone_GetPropertySplitable - responses: - "200": - $ref: '#/responses/dns_zone_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - dns_zone - /dns_zones/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: dns_zone_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/dns_zone_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - dns_zone - /dns_zones/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: dns_zone_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/dns_zone_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - dns_zone - /dns_zones/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: dns_zone_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/dns_zone_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - dns_zone - /dns_zones/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: dns_zone_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/dns_zone_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - dns_zone - /domain_quotas/domains: - get: - description: 获取所有域的域配额 - operationId: models_ListDomainQuotas - 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_ListDomainQuotasOutput' - summary: 获取所有域的域配额 - tags: - - domain_quota - /domain_quotas/domains/{domainId}: - get: - description: 获取指定域的配额 - operationId: models_GetDomainQuota - 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_GetDomainQuotaOutput' - summary: 获取指定域的配额 - tags: - - domain_quota - post: - description: 设置域的域配额 - operationId: models_SetDomainQuotas - parameters: - - description: 指定域的ID - in: path - name: domainId - required: true - type: string - x-go-name: DomainId - - in: body - name: body - schema: - properties: - domain_quotas: - $ref: '#/definitions/SetDomainQuotaInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/models_SetDomainQuotasOutput' - summary: 设置域的域配额 - tags: - - domain_quota - /dynamicschedtags: - get: - description: 列表 - operationId: dynamicschedtag_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: 以关联的调度标签（ID或Name）过滤列表 - in: query - name: schedtag_id - type: string - x-go-name: SchedtagId - - description: 按调度标签名称排序 - in: query - name: order_by_schedtag - pattern: asc|desc - type: string - x-go-name: OrderBySchedtag - - description: 按调度标签资源类型排序 - in: query - name: order_by_resource_type - pattern: asc|desc - type: string - x-go-name: OrderByResourceType - - description: filter by enabled status - in: query - name: enabled - type: boolean - x-go-name: Enabled - responses: - "200": - $ref: '#/responses/dynamicschedtag_ListItemFilterOutput' - summary: 动态调度标签列表 - tags: - - dynamicschedtag - post: - description: 新建 - operationId: dynamicschedtag_ValidateCreateData - responses: - "200": - $ref: '#/responses/dynamicschedtag_ValidateCreateDataOutput' - summary: 新建 - tags: - - dynamicschedtag - /dynamicschedtags/{id}: - delete: - description: 删除 - operationId: dynamicschedtag_CustomizeDelete - parameters: - - description: The Id or Name of dynamicschedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dynamicschedtag_CustomizeDeleteOutput' - summary: 删除 - tags: - - dynamicschedtag - get: - description: 获取详情 - operationId: dynamicschedtag_FetchCustomizeColumns - parameters: - - description: The Id or Name of dynamicschedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dynamicschedtag_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - dynamicschedtag - put: - description: 更新 - operationId: dynamicschedtag_ValidateUpdateData - parameters: - - description: The Id or Name of dynamicschedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dynamicschedtag_ValidateUpdateDataOutput' - summary: 更新 - tags: - - dynamicschedtag - /dynamicschedtags/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: dynamicschedtag_GetDetailsClassMetadata - parameters: - - description: The Id or Name of dynamicschedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dynamicschedtag_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - dynamicschedtag - post: - description: 执行操作ClassMetadata - operationId: dynamicschedtag_PerformClassMetadata - parameters: - - description: The Id or Name of dynamicschedtag - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dynamicschedtag: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dynamicschedtag_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - dynamicschedtag - /dynamicschedtags/{id}/evaluate: - post: - description: 执行操作Evaluate - operationId: dynamicschedtag_PerformEvaluate - parameters: - - description: The Id or Name of dynamicschedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dynamicschedtag_PerformEvaluateOutput' - summary: 执行操作Evaluate - tags: - - dynamicschedtag - /dynamicschedtags/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: dynamicschedtag_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 dynamicschedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/dynamicschedtag_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - dynamicschedtag - /dynamicschedtags/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: dynamicschedtag_PerformSetClassMetadata - parameters: - - description: The Id or Name of dynamicschedtag - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dynamicschedtag: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dynamicschedtag_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - dynamicschedtag - /dynamicschedtags/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: dynamicschedtag_PerformSetUserMetadata - parameters: - - description: The Id or Name of dynamicschedtag - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - dynamicschedtag: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dynamicschedtag_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - dynamicschedtag - /dynamicschedtags/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: dynamicschedtag_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/dynamicschedtag_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - dynamicschedtag - /dynamicschedtags/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: dynamicschedtag_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - dynamicschedtag: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/dynamicschedtag_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - dynamicschedtag - /dynamicschedtags/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: dynamicschedtag_GetPropertySplitable - responses: - "200": - $ref: '#/responses/dynamicschedtag_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - dynamicschedtag - /dynamicschedtags/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: dynamicschedtag_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/dynamicschedtag_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - dynamicschedtag - /dynamicschedtags/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: dynamicschedtag_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/dynamicschedtag_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - dynamicschedtag - /dynamicschedtags/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: dynamicschedtag_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/dynamicschedtag_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - dynamicschedtag - /elastic_searches: - get: - description: 列表 - operationId: elastic_search_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 是否禁止删除 - in: query - name: disable_delete - type: boolean - x-go-name: DisableDelete - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/elastic_search_ListItemFilterOutput' - summary: ElasticSearch实例列表 - tags: - - elastic_search - post: - description: 新建 - operationId: elastic_search_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - elastic_search: - $ref: '#/definitions/ElasticSearchCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_ValidateCreateDataOutput' - summary: 新建 - tags: - - elastic_search - /elastic_searches/{id}: - delete: - description: 删除 - operationId: elastic_search_CustomizeDelete - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elastic_search_CustomizeDeleteOutput' - summary: 删除 - tags: - - elastic_search - get: - description: 获取详情 - operationId: elastic_search_FetchCustomizeColumns - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elastic_search_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - elastic_search - put: - description: 更新 - operationId: elastic_search_ValidateUpdateData - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elastic_search: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_ValidateUpdateDataOutput' - summary: 更新 - tags: - - elastic_search - /elastic_searches/{id}/access-info: - get: - description: 获取指定信息AccessInfo - operationId: elastic_search_GetDetailsAccessInfo - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elastic_search_GetDetailsAccessInfoOutput' - summary: 获取指定信息AccessInfo - tags: - - elastic_search - /elastic_searches/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: elastic_search_PerformCancelDelete - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elastic_search_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - elastic_search - /elastic_searches/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: elastic_search_PerformChangeOwner - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elastic_search: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - elastic_search - /elastic_searches/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: elastic_search_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elastic_search_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - elastic_search - /elastic_searches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: elastic_search_GetDetailsClassMetadata - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elastic_search_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - elastic_search - post: - description: 执行操作ClassMetadata - operationId: elastic_search_PerformClassMetadata - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elastic_search: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - elastic_search - /elastic_searches/{id}/freeze: - post: - description: 执行操作Freeze - operationId: elastic_search_PerformFreeze - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elastic_search: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - elastic_search - /elastic_searches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: elastic_search_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 elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elastic_search_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - elastic_search - /elastic_searches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: elastic_search_PerformSetClassMetadata - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elastic_search: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - elastic_search - /elastic_searches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: elastic_search_PerformSetUserMetadata - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elastic_search: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - elastic_search - /elastic_searches/{id}/status: - get: - description: 获取指定信息Status - operationId: elastic_search_GetDetailsStatus - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elastic_search_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - elastic_search - post: - description: 执行操作Status - operationId: elastic_search_PerformStatus - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elastic_search: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_PerformStatusOutput' - summary: 更新资源状态 - tags: - - elastic_search - /elastic_searches/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: elastic_search_PerformSyncstatus - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elastic_search_PerformSyncstatusOutput' - summary: 同步ElasticSearch实例状态 - tags: - - elastic_search - /elastic_searches/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: elastic_search_PerformUnfreeze - parameters: - - description: The Id or Name of elastic_search - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elastic_search: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - elastic_search - /elastic_searches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: elastic_search_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/elastic_search_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - elastic_search - /elastic_searches/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: elastic_search_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/elastic_search_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - elastic_search - /elastic_searches/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: elastic_search_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/elastic_search_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - elastic_search - /elastic_searches/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: elastic_search_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/elastic_search_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - elastic_search - /elastic_searches/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: elastic_search_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/elastic_search_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - elastic_search - /elastic_searches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: elastic_search_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - elastic_search: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elastic_search_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - elastic_search - /elastic_searches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: elastic_search_GetPropertySplitable - responses: - "200": - $ref: '#/responses/elastic_search_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - elastic_search - /elastic_searches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: elastic_search_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/elastic_search_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - elastic_search - /elastic_searches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: elastic_search_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/elastic_search_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - elastic_search - /elastic_searches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: elastic_search_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/elastic_search_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - elastic_search - /elastic_searches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: elastic_search_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/elastic_search_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - elastic_search - /elasticcache_accounts: - get: - description: 列表 - operationId: elasticcache_account_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 弹性缓存实例(ID or Name) - in: query - name: elasticcache_id - type: string - x-go-name: ElasticcacheId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 以弹性缓存实例名称排序 - in: query - name: order_by_elasticcache - type: string - x-go-name: OrderByElasticcache - - description: 账号类型 normal |admin - in: query - items: - type: string - name: account_type - type: array - x-go-name: AccountType - - description: 账号权限 read | write | repl（复制, 复制权限支持读写，且开放SYNC/PSYNC命令） - in: query - items: - type: string - name: account_privilege - type: array - x-go-name: AccountPrivilege - responses: - "200": - $ref: '#/responses/elasticcache_account_ListItemFilterOutput' - summary: 弹性缓存账号列表 - tags: - - elasticcache_account - post: - description: 新建 - operationId: elasticcache_account_ValidateCreateData - responses: - "200": - $ref: '#/responses/elasticcache_account_ValidateCreateDataOutput' - summary: 新建 - tags: - - elasticcache_account - /elasticcache_accounts/{id}: - delete: - description: 删除 - operationId: elasticcache_account_CustomizeDelete - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_account_CustomizeDeleteOutput' - summary: 删除 - tags: - - elasticcache_account - get: - description: 获取详情 - operationId: elasticcache_account_FetchCustomizeColumns - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_account_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - elasticcache_account - put: - description: 更新 - operationId: elasticcache_account_ValidateUpdateData - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_account: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_account_ValidateUpdateDataOutput' - summary: 更新 - tags: - - elasticcache_account - /elasticcache_accounts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: elasticcache_account_GetDetailsClassMetadata - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_account_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - elasticcache_account - post: - description: 执行操作ClassMetadata - operationId: elasticcache_account_PerformClassMetadata - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_account: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_account_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - elasticcache_account - /elasticcache_accounts/{id}/login-info: - get: - description: 获取指定信息LoginInfo - operationId: elasticcache_account_GetDetailsLoginInfo - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_account_GetDetailsLoginInfoOutput' - summary: 获取指定信息LoginInfo - tags: - - elasticcache_account - /elasticcache_accounts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: elasticcache_account_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 elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_account_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - elasticcache_account - /elasticcache_accounts/{id}/reset-password: - post: - description: 执行操作ResetPassword - operationId: elasticcache_account_PerformResetPassword - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_account_PerformResetPasswordOutput' - summary: 执行操作ResetPassword - tags: - - elasticcache_account - /elasticcache_accounts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: elasticcache_account_PerformSetClassMetadata - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_account: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_account_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - elasticcache_account - /elasticcache_accounts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: elasticcache_account_PerformSetUserMetadata - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_account: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_account_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - elasticcache_account - /elasticcache_accounts/{id}/status: - get: - description: 获取指定信息Status - operationId: elasticcache_account_GetDetailsStatus - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_account_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - elasticcache_account - post: - description: 执行操作Status - operationId: elasticcache_account_PerformStatus - parameters: - - description: The Id or Name of elasticcache_account - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_account: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_account_PerformStatusOutput' - summary: 更新资源状态 - tags: - - elasticcache_account - /elasticcache_accounts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: elasticcache_account_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/elasticcache_account_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - elasticcache_account - /elasticcache_accounts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: elasticcache_account_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - elasticcache_account: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_account_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - elasticcache_account - /elasticcache_accounts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: elasticcache_account_GetPropertySplitable - responses: - "200": - $ref: '#/responses/elasticcache_account_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - elasticcache_account - /elasticcache_accounts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: elasticcache_account_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/elasticcache_account_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - elasticcache_account - /elasticcache_accounts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: elasticcache_account_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/elasticcache_account_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - elasticcache_account - /elasticcache_accounts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: elasticcache_account_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/elasticcache_account_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - elasticcache_account - /elasticcache_accounts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: elasticcache_account_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/elasticcache_account_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - elasticcache_account - /elasticcache_acls: - get: - description: 列表 - operationId: elasticcache_acl_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 弹性缓存实例(ID or Name) - in: query - name: elasticcache_id - type: string - x-go-name: ElasticcacheId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 以弹性缓存实例名称排序 - in: query - name: order_by_elasticcache - type: string - x-go-name: OrderByElasticcache - - description: Ip地址白名单列表 - in: query - name: ip_list - type: string - x-go-name: IpList - responses: - "200": - $ref: '#/responses/elasticcache_acl_ListItemFilterOutput' - summary: 弹性缓存ACL规则列表 - tags: - - elasticcache_acl - post: - description: 新建 - operationId: elasticcache_acl_ValidateCreateData - responses: - "200": - $ref: '#/responses/elasticcache_acl_ValidateCreateDataOutput' - summary: 新建 - tags: - - elasticcache_acl - /elasticcache_acls/{id}: - delete: - description: 删除 - operationId: elasticcache_acl_CustomizeDelete - parameters: - - description: The Id or Name of elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_acl_CustomizeDeleteOutput' - summary: 删除 - tags: - - elasticcache_acl - get: - description: 获取详情 - operationId: elasticcache_acl_FetchCustomizeColumns - parameters: - - description: The Id or Name of elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_acl_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - elasticcache_acl - put: - description: 更新 - operationId: elasticcache_acl_ValidateUpdateData - parameters: - - description: The Id or Name of elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_acl_ValidateUpdateDataOutput' - summary: 更新 - tags: - - elasticcache_acl - /elasticcache_acls/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: elasticcache_acl_GetDetailsClassMetadata - parameters: - - description: The Id or Name of elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_acl_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - elasticcache_acl - post: - description: 执行操作ClassMetadata - operationId: elasticcache_acl_PerformClassMetadata - parameters: - - description: The Id or Name of elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_acl: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_acl_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - elasticcache_acl - /elasticcache_acls/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: elasticcache_acl_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 elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_acl_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - elasticcache_acl - /elasticcache_acls/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: elasticcache_acl_PerformSetClassMetadata - parameters: - - description: The Id or Name of elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_acl: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_acl_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - elasticcache_acl - /elasticcache_acls/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: elasticcache_acl_PerformSetUserMetadata - parameters: - - description: The Id or Name of elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_acl: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_acl_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - elasticcache_acl - /elasticcache_acls/{id}/status: - get: - description: 获取指定信息Status - operationId: elasticcache_acl_GetDetailsStatus - parameters: - - description: The Id or Name of elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_acl_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - elasticcache_acl - post: - description: 执行操作Status - operationId: elasticcache_acl_PerformStatus - parameters: - - description: The Id or Name of elasticcache_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_acl: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_acl_PerformStatusOutput' - summary: 更新资源状态 - tags: - - elasticcache_acl - /elasticcache_acls/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: elasticcache_acl_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/elasticcache_acl_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - elasticcache_acl - /elasticcache_acls/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: elasticcache_acl_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - elasticcache_acl: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_acl_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - elasticcache_acl - /elasticcache_acls/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: elasticcache_acl_GetPropertySplitable - responses: - "200": - $ref: '#/responses/elasticcache_acl_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - elasticcache_acl - /elasticcache_acls/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: elasticcache_acl_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/elasticcache_acl_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - elasticcache_acl - /elasticcache_acls/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: elasticcache_acl_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/elasticcache_acl_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - elasticcache_acl - /elasticcache_acls/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: elasticcache_acl_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/elasticcache_acl_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - elasticcache_acl - /elasticcache_backups: - get: - description: 列表 - operationId: elasticcache_backup_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 弹性缓存实例(ID or Name) - in: query - name: elasticcache_id - type: string - x-go-name: ElasticcacheId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 以弹性缓存实例名称排序 - in: query - name: order_by_elasticcache - type: string - x-go-name: OrderByElasticcache - - description: 备份类型, 全量|增量额 - in: query - items: - type: string - name: backup_type - type: array - x-go-name: BackupType - - description: 备份模式，自动|手动 - in: query - items: - type: string - name: backup_mode - type: array - x-go-name: BackupMode - responses: - "200": - $ref: '#/responses/elasticcache_backup_ListItemFilterOutput' - summary: 弹性缓存备份列表 - tags: - - elasticcache_backup - post: - description: 新建 - operationId: elasticcache_backup_ValidateCreateData - responses: - "200": - $ref: '#/responses/elasticcache_backup_ValidateCreateDataOutput' - summary: 新建 - tags: - - elasticcache_backup - /elasticcache_backups/{id}: - delete: - description: 删除 - operationId: elasticcache_backup_CustomizeDelete - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_backup_CustomizeDeleteOutput' - summary: 删除 - tags: - - elasticcache_backup - get: - description: 获取详情 - operationId: elasticcache_backup_FetchCustomizeColumns - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_backup_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - elasticcache_backup - put: - description: 更新 - operationId: elasticcache_backup_ValidateUpdateData - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_backup: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_backup_ValidateUpdateDataOutput' - summary: 更新 - tags: - - elasticcache_backup - /elasticcache_backups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: elasticcache_backup_GetDetailsClassMetadata - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_backup_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - elasticcache_backup - post: - description: 执行操作ClassMetadata - operationId: elasticcache_backup_PerformClassMetadata - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_backup_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - elasticcache_backup - /elasticcache_backups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: elasticcache_backup_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 elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_backup_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - elasticcache_backup - /elasticcache_backups/{id}/restore-instance: - post: - description: 执行操作RestoreInstance - operationId: elasticcache_backup_PerformRestoreInstance - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_backup_PerformRestoreInstanceOutput' - summary: 执行操作RestoreInstance - tags: - - elasticcache_backup - /elasticcache_backups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: elasticcache_backup_PerformSetClassMetadata - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_backup_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - elasticcache_backup - /elasticcache_backups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: elasticcache_backup_PerformSetUserMetadata - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_backup_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - elasticcache_backup - /elasticcache_backups/{id}/status: - get: - description: 获取指定信息Status - operationId: elasticcache_backup_GetDetailsStatus - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_backup_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - elasticcache_backup - post: - description: 执行操作Status - operationId: elasticcache_backup_PerformStatus - parameters: - - description: The Id or Name of elasticcache_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_backup: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_backup_PerformStatusOutput' - summary: 更新资源状态 - tags: - - elasticcache_backup - /elasticcache_backups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: elasticcache_backup_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/elasticcache_backup_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - elasticcache_backup - /elasticcache_backups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: elasticcache_backup_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - elasticcache_backup: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_backup_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - elasticcache_backup - /elasticcache_backups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: elasticcache_backup_GetPropertySplitable - responses: - "200": - $ref: '#/responses/elasticcache_backup_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - elasticcache_backup - /elasticcache_backups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: elasticcache_backup_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/elasticcache_backup_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - elasticcache_backup - /elasticcache_backups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: elasticcache_backup_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/elasticcache_backup_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - elasticcache_backup - /elasticcache_backups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: elasticcache_backup_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/elasticcache_backup_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - elasticcache_backup - /elasticcache_backups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: elasticcache_backup_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/elasticcache_backup_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - elasticcache_backup - /elasticcache_parameters: - get: - description: 列表 - operationId: elasticcache_parameter_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 弹性缓存实例(ID or Name) - in: query - name: elasticcache_id - type: string - x-go-name: ElasticcacheId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 以弹性缓存实例名称排序 - in: query - name: order_by_elasticcache - type: string - x-go-name: OrderByElasticcache - - description: 参数名称 - in: query - items: - type: string - name: key - type: array - x-go-name: Key - - description: 参数值 - in: query - items: - type: string - name: value - type: array - x-go-name: Value - responses: - "200": - $ref: '#/responses/elasticcache_parameter_ListItemFilterOutput' - summary: 列出弹性缓存参数 - tags: - - elasticcache_parameter - post: - description: 新建 - operationId: elasticcache_parameter_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - elasticcache_parameter: - $ref: '#/definitions/StandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_parameter_ValidateCreateDataOutput' - summary: 新建 - tags: - - elasticcache_parameter - /elasticcache_parameters/{id}: - delete: - description: 删除 - operationId: elasticcache_parameter_CustomizeDelete - parameters: - - description: The Id or Name of elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_parameter_CustomizeDeleteOutput' - summary: 删除 - tags: - - elasticcache_parameter - get: - description: 获取详情 - operationId: elasticcache_parameter_FetchCustomizeColumns - parameters: - - description: The Id or Name of elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_parameter_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - elasticcache_parameter - put: - description: 更新 - operationId: elasticcache_parameter_ValidateUpdateData - parameters: - - description: The Id or Name of elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_parameter_ValidateUpdateDataOutput' - summary: 更新 - tags: - - elasticcache_parameter - /elasticcache_parameters/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: elasticcache_parameter_GetDetailsClassMetadata - parameters: - - description: The Id or Name of elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_parameter_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - elasticcache_parameter - post: - description: 执行操作ClassMetadata - operationId: elasticcache_parameter_PerformClassMetadata - parameters: - - description: The Id or Name of elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_parameter: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_parameter_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - elasticcache_parameter - /elasticcache_parameters/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: elasticcache_parameter_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 elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_parameter_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - elasticcache_parameter - /elasticcache_parameters/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: elasticcache_parameter_PerformSetClassMetadata - parameters: - - description: The Id or Name of elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_parameter: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_parameter_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - elasticcache_parameter - /elasticcache_parameters/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: elasticcache_parameter_PerformSetUserMetadata - parameters: - - description: The Id or Name of elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_parameter: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_parameter_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - elasticcache_parameter - /elasticcache_parameters/{id}/status: - get: - description: 获取指定信息Status - operationId: elasticcache_parameter_GetDetailsStatus - parameters: - - description: The Id or Name of elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_parameter_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - elasticcache_parameter - post: - description: 执行操作Status - operationId: elasticcache_parameter_PerformStatus - parameters: - - description: The Id or Name of elasticcache_parameter - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_parameter: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_parameter_PerformStatusOutput' - summary: 更新资源状态 - tags: - - elasticcache_parameter - /elasticcache_parameters/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: elasticcache_parameter_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/elasticcache_parameter_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - elasticcache_parameter - /elasticcache_parameters/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: elasticcache_parameter_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - elasticcache_parameter: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_parameter_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - elasticcache_parameter - /elasticcache_parameters/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: elasticcache_parameter_GetPropertySplitable - responses: - "200": - $ref: '#/responses/elasticcache_parameter_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - elasticcache_parameter - /elasticcache_parameters/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: elasticcache_parameter_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/elasticcache_parameter_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - elasticcache_parameter - /elasticcache_parameters/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: elasticcache_parameter_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/elasticcache_parameter_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - elasticcache_parameter - /elasticcache_parameters/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: elasticcache_parameter_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/elasticcache_parameter_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - elasticcache_parameter - /elasticcache_skus: - get: - description: 列表 - operationId: elasticcache_sku_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: 计费类型，按需计费和预付费 - in: query - name: billing_type - pattern: prepaid|postpaid - type: string - x-go-name: BillingType - - description: 计费过期时间的查询起始时间 - format: date-time - in: query - name: billing_expire_since - type: string - x-go-name: BillingExpireSince - - description: 计费过期时间的查询终止时间 - format: date-time - in: query - name: billing_expire_before - type: string - x-go-name: BillingExpireBefore - - description: 计费周期 - example: 7d - in: query - name: billing_cycle - type: string - x-go-name: BillingCycle - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: filter sku by memory size in MB - format: int64 - in: query - name: memory_size_mb - type: integer - x-go-name: MemorySizeMb - - in: query - items: - type: string - name: instance_spec - type: array - x-go-name: InstanceSpec - - in: query - items: - type: string - name: engine_arch - type: array - x-go-name: EngineArch - - in: query - items: - type: string - name: local_category - type: array - x-go-name: LocalCategory - - in: query - items: - type: string - name: prepaid_status - type: array - x-go-name: PrepaidStatus - - in: query - items: - type: string - name: postpaid_sStatus - type: array - x-go-name: PostpaidStatus - - description: 引擎 redis|memcached - in: query - items: - type: string - name: engine - type: array - x-go-name: Engine - - description: 引擎版本 3.0 - in: query - items: - type: string - name: engine_version - type: array - x-go-name: EngineVersion - - description: CPU 架构 x86|ARM - in: query - items: - type: string - name: cpu_arch - type: array - x-go-name: CpuArch - - description: 存储类型 DRAM|SCM - in: query - items: - type: string - name: storage_type - type: array - x-go-name: StorageType - - description: standrad|enhanced - in: query - items: - type: string - name: performance_type - type: array - x-go-name: PerformanceType - - description: single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | - readfive（5只读） - in: query - items: - type: string - name: node_type - type: array - x-go-name: NodeType - responses: - "200": - $ref: '#/responses/elasticcache_sku_ListItemFilterOutput' - summary: 弹性缓存套餐规格列表 - tags: - - elasticcache_sku - post: - description: 新建 - operationId: elasticcache_sku_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - elasticcache_sku: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_sku_ValidateCreateDataOutput' - summary: 新建 - tags: - - elasticcache_sku - /elasticcache_skus/{id}: - delete: - description: 删除 - operationId: elasticcache_sku_CustomizeDelete - parameters: - - description: The Id or Name of elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_sku_CustomizeDeleteOutput' - summary: 删除 - tags: - - elasticcache_sku - get: - description: 获取详情 - operationId: elasticcache_sku_FetchCustomizeColumns - parameters: - - description: The Id or Name of elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_sku_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - elasticcache_sku - put: - description: 更新 - operationId: elasticcache_sku_ValidateUpdateData - parameters: - - description: The Id or Name of elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_sku_ValidateUpdateDataOutput' - summary: 更新 - tags: - - elasticcache_sku - /elasticcache_skus/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: elasticcache_sku_GetDetailsClassMetadata - parameters: - - description: The Id or Name of elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - elasticcache_sku - post: - description: 执行操作ClassMetadata - operationId: elasticcache_sku_PerformClassMetadata - parameters: - - description: The Id or Name of elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_sku_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - elasticcache_sku - /elasticcache_skus/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: elasticcache_sku_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 elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - elasticcache_sku - /elasticcache_skus/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: elasticcache_sku_PerformSetClassMetadata - parameters: - - description: The Id or Name of elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_sku_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - elasticcache_sku - /elasticcache_skus/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: elasticcache_sku_PerformSetUserMetadata - parameters: - - description: The Id or Name of elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_sku_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - elasticcache_sku - /elasticcache_skus/{id}/status: - get: - description: 获取指定信息Status - operationId: elasticcache_sku_GetDetailsStatus - parameters: - - description: The Id or Name of elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - elasticcache_sku - post: - description: 执行操作Status - operationId: elasticcache_sku_PerformStatus - parameters: - - description: The Id or Name of elasticcache_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_sku_PerformStatusOutput' - summary: 更新资源状态 - tags: - - elasticcache_sku - /elasticcache_skus/capability: - get: - description: 获取指定资源类的信息Capability - operationId: elasticcache_sku_GetPropertyCapability - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetPropertyCapabilityOutput' - summary: 获取指定资源类的信息Capability - tags: - - elasticcache_sku - /elasticcache_skus/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: elasticcache_sku_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - elasticcache_sku - /elasticcache_skus/instance-specs: - get: - description: 获取指定资源类的信息InstanceSpecs - operationId: elasticcache_sku_GetPropertyInstanceSpecs - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetPropertyInstanceSpecsOutput' - summary: 获取指定资源类的信息InstanceSpecs - tags: - - elasticcache_sku - /elasticcache_skus/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: elasticcache_sku_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_sku_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - elasticcache_sku - /elasticcache_skus/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: elasticcache_sku_GetPropertySplitable - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - elasticcache_sku - /elasticcache_skus/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: elasticcache_sku_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/elasticcache_sku_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - elasticcache_sku - /elasticcache_skus/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: elasticcache_sku_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - elasticcache_sku - /elasticcache_skus/sync-skus: - post: - description: 执行操作SyncSkus - operationId: elasticcache_sku_PerformSyncSkus - parameters: - - in: body - name: body - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/SkuSyncInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_sku_PerformSyncSkusOutput' - summary: 执行操作SyncSkus - tags: - - elasticcache_sku - /elasticcache_skus/sync-tasks: - get: - description: 获取指定资源类的信息SyncTasks - operationId: elasticcache_sku_GetPropertySyncTasks - parameters: - - description: 异步任务ID - in: query - items: - type: string - name: task_ids - type: array - x-go-name: TaskIds - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetPropertySyncTasksOutput' - summary: 获取指定资源类的信息SyncTasks - tags: - - elasticcache_sku - /elasticcache_skus/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: elasticcache_sku_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - elasticcache_sku - /elasticcache_skus/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: elasticcache_sku_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/elasticcache_sku_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - elasticcache_sku - /elasticcaches: - get: - description: 列表 - operationId: elasticcache_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 是否禁止删除 - in: query - name: disable_delete - type: boolean - x-go-name: DisableDelete - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - description: 实例规格 - example: redis.master.micro.default - in: query - items: - type: string - name: instance_type - type: array - x-go-name: InstanceType - - description: 对应Sku - in: query - items: - type: string - name: local_category - type: array - x-go-name: LocalCategory - - description: |- - 类型 - single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | readfive（5只读） - in: query - items: - type: string - name: node_type - type: array - x-go-name: NodeType - - description: |- - 后端存储引擎 - Redis | Memcache - example: redis - in: query - items: - type: string - name: engine - type: array - x-go-name: Engine - - description: 后端存储引擎版本 - example: "4.0" - in: query - items: - type: string - name: engine_version - type: array - x-go-name: EngineVersion - - description: 网络类型, CLASSIC（经典网络） VPC（专有网络） - example: CLASSIC - in: query - items: - type: string - name: network_type - type: array - x-go-name: NetworkType - - description: 内网DNS - in: query - items: - type: string - name: private_dns - type: array - x-go-name: PrivateDNS - - description: 内网IP地址 - in: query - items: - type: string - name: private_ip_addr - type: array - x-go-name: PrivateIpAddr - - description: 内网访问端口 - in: query - items: - format: int64 - type: integer - name: private_connect_port - type: array - x-go-name: PrivateConnectPort - - description: 公网DNS - in: query - items: - type: string - name: public_dns - type: array - x-go-name: PublicDNS - - description: 公网IP地址 - in: query - items: - type: string - name: public_ip_addr - type: array - x-go-name: PublicIpAddr - - description: 外网访问端口 - in: query - items: - format: int64 - type: integer - name: public_connect_port - type: array - x-go-name: PublicConnectPort - - description: 访问密码？ on （开启密码）|off （免密码访问） - in: query - items: - type: string - name: auth_mode - type: array - x-go-name: AuthMode - responses: - "200": - $ref: '#/responses/elasticcache_ListItemFilterOutput' - summary: 列出弹性缓存（redis等） - tags: - - elasticcache - post: - description: 新建 - operationId: elasticcache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - elasticcache: - $ref: '#/definitions/ElasticcacheCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_ValidateCreateDataOutput' - summary: 新建 - tags: - - elasticcache - /elasticcaches/{id}: - delete: - description: 删除 - operationId: elasticcache_CustomizeDelete - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_CustomizeDeleteOutput' - summary: 删除 - tags: - - elasticcache - get: - description: 获取详情 - operationId: elasticcache_FetchCustomizeColumns - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - elasticcache - put: - description: 更新 - operationId: elasticcache_ValidateUpdateData - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - elasticcache - /elasticcaches/{id}/add-secgroup: - post: - description: 执行操作AddSecgroup - operationId: elasticcache_PerformAddSecgroup - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/ElasticcacheSecgroupsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformAddSecgroupOutput' - summary: 执行操作AddSecgroup - tags: - - elasticcache - /elasticcaches/{id}/allocate-public-connection: - post: - description: 执行操作AllocatePublicConnection - operationId: elasticcache_PerformAllocatePublicConnection - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformAllocatePublicConnectionOutput' - summary: 执行操作AllocatePublicConnection - tags: - - elasticcache - /elasticcaches/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: elasticcache_PerformCancelDelete - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - elasticcache - /elasticcaches/{id}/cancel-expire: - post: - description: 执行操作CancelExpire - operationId: elasticcache_PerformCancelExpire - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformCancelExpireOutput' - summary: 执行操作CancelExpire - tags: - - elasticcache - /elasticcaches/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: elasticcache_PerformChangeOwner - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - elasticcache - /elasticcaches/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: elasticcache_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - elasticcache - /elasticcaches/{id}/change-spec: - post: - description: 执行操作ChangeSpec - operationId: elasticcache_PerformChangeSpec - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformChangeSpecOutput' - summary: 执行操作ChangeSpec - tags: - - elasticcache - /elasticcaches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: elasticcache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - elasticcache - post: - description: 执行操作ClassMetadata - operationId: elasticcache_PerformClassMetadata - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - elasticcache - /elasticcaches/{id}/flush-instance: - post: - description: 执行操作FlushInstance - operationId: elasticcache_PerformFlushInstance - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformFlushInstanceOutput' - summary: 执行操作FlushInstance - tags: - - elasticcache - /elasticcaches/{id}/freeze: - post: - description: 执行操作Freeze - operationId: elasticcache_PerformFreeze - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - elasticcache - /elasticcaches/{id}/login-info: - get: - description: 获取指定信息LoginInfo - operationId: elasticcache_GetDetailsLoginInfo - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_GetDetailsLoginInfoOutput' - summary: 获取指定信息LoginInfo - tags: - - elasticcache - /elasticcaches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: elasticcache_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 elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - elasticcache - /elasticcaches/{id}/postpaid-expire: - post: - description: 执行操作PostpaidExpire - operationId: elasticcache_PerformPostpaidExpire - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/PostpaidExpireInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformPostpaidExpireOutput' - summary: 执行操作PostpaidExpire - tags: - - elasticcache - /elasticcaches/{id}/release-public-connection: - post: - description: 执行操作ReleasePublicConnection - operationId: elasticcache_PerformReleasePublicConnection - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformReleasePublicConnectionOutput' - summary: 执行操作ReleasePublicConnection - tags: - - elasticcache - /elasticcaches/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: elasticcache_PerformRemoteUpdate - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/ElasticcacheRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - elasticcache - /elasticcaches/{id}/renew: - post: - description: 执行操作Renew - operationId: elasticcache_PerformRenew - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformRenewOutput' - summary: 执行操作Renew - tags: - - elasticcache - /elasticcaches/{id}/reset-password: - post: - description: 执行操作ResetPassword - operationId: elasticcache_PerformResetPassword - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformResetPasswordOutput' - summary: 执行操作ResetPassword - tags: - - elasticcache - /elasticcaches/{id}/restart: - post: - description: 执行操作Restart - operationId: elasticcache_PerformRestart - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformRestartOutput' - summary: 执行操作Restart - tags: - - elasticcache - /elasticcaches/{id}/revoke-secgroup: - post: - description: 执行操作RevokeSecgroup - operationId: elasticcache_PerformRevokeSecgroup - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/ElasticcacheSecgroupsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformRevokeSecgroupOutput' - summary: 执行操作RevokeSecgroup - tags: - - elasticcache - /elasticcaches/{id}/set-auto-renew: - post: - description: |- - 要求实例状态为running - 要求实例计费类型为包年包月(预付费) - operationId: elasticcache_PerformSetAutoRenew - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/GuestAutoRenewInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformSetAutoRenewOutput' - summary: 设置自动续费 - tags: - - elasticcache - /elasticcaches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: elasticcache_PerformSetClassMetadata - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - elasticcache - /elasticcaches/{id}/set-maintain-time: - post: - description: 执行操作SetMaintainTime - operationId: elasticcache_PerformSetMaintainTime - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformSetMaintainTimeOutput' - summary: 执行操作SetMaintainTime - tags: - - elasticcache - /elasticcaches/{id}/set-secgroup: - post: - description: 执行操作SetSecgroup - operationId: elasticcache_PerformSetSecgroup - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/ElasticcacheSecgroupsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformSetSecgroupOutput' - summary: 执行操作SetSecgroup - tags: - - elasticcache - /elasticcaches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: elasticcache_PerformSetUserMetadata - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - elasticcache - /elasticcaches/{id}/status: - get: - description: 获取指定信息Status - operationId: elasticcache_GetDetailsStatus - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - elasticcache - post: - description: 执行操作Status - operationId: elasticcache_PerformStatus - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - elasticcache - /elasticcaches/{id}/sync: - post: - description: 执行操作Sync - operationId: elasticcache_PerformSync - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformSyncOutput' - summary: 执行操作Sync - tags: - - elasticcache - /elasticcaches/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: elasticcache_PerformSyncstatus - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/ElasticcacheSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformSyncstatusOutput' - summary: 同步弹性缓存状态 - tags: - - elasticcache - /elasticcaches/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: elasticcache_PerformUnfreeze - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - elasticcache - /elasticcaches/{id}/update-auth-mode: - post: - description: 执行操作UpdateAuthMode - operationId: elasticcache_PerformUpdateAuthMode - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformUpdateAuthModeOutput' - summary: 执行操作UpdateAuthMode - tags: - - elasticcache - /elasticcaches/{id}/update-backup-policy: - post: - description: 执行操作UpdateBackupPolicy - operationId: elasticcache_PerformUpdateBackupPolicy - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformUpdateBackupPolicyOutput' - summary: 执行操作UpdateBackupPolicy - tags: - - elasticcache - /elasticcaches/{id}/update-instance-parameters: - post: - description: 执行操作UpdateInstanceParameters - operationId: elasticcache_PerformUpdateInstanceParameters - parameters: - - description: The Id or Name of elasticcache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcache_PerformUpdateInstanceParametersOutput' - summary: 执行操作UpdateInstanceParameters - tags: - - elasticcache - /elasticcaches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: elasticcache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/elasticcache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - elasticcache - /elasticcaches/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: elasticcache_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/elasticcache_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - elasticcache - /elasticcaches/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: elasticcache_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/elasticcache_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - elasticcache - /elasticcaches/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: elasticcache_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/elasticcache_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - elasticcache - /elasticcaches/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: elasticcache_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/elasticcache_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - elasticcache - /elasticcaches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: elasticcache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - elasticcache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - elasticcache - /elasticcaches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: elasticcache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/elasticcache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - elasticcache - /elasticcaches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: elasticcache_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/elasticcache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - elasticcache - /elasticcaches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: elasticcache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/elasticcache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - elasticcache - /elasticcaches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: elasticcache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/elasticcache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - elasticcache - /elasticcaches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: elasticcache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/elasticcache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - elasticcache - /elasticcachesecgroups: - get: - description: 列表 - operationId: elasticcachesecgroup_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 弹性缓存实例(ID or Name) - in: query - name: elasticcache_id - type: string - x-go-name: ElasticcacheId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 以弹性缓存实例名称排序 - in: query - name: order_by_elasticcache - type: string - x-go-name: OrderByElasticcache - - description: 过滤关联指定安全组（ID或Name）的列表结果 - in: query - name: secgroup_id - type: string - x-go-name: SecgroupId - - description: 模糊匹配安全组规则名称 - in: query - name: secgroup_name - type: string - x-go-name: SecgroupName - - description: 以安全组排序 - in: query - name: order_by_secgroup - type: string - x-go-name: OrderBySecgroup - responses: - "200": - $ref: '#/responses/elasticcachesecgroup_ListItemFilterOutput' - summary: 列表 - tags: - - elasticcachesecgroup - post: - description: 新建 - operationId: elasticcachesecgroup_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - elasticcachesecgroup: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcachesecgroup_ValidateCreateDataOutput' - summary: 新建 - tags: - - elasticcachesecgroup - /elasticcachesecgroups/{id}: - delete: - description: 删除 - operationId: elasticcachesecgroup_CustomizeDelete - parameters: - - description: The Id or Name of elasticcachesecgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcachesecgroup_CustomizeDeleteOutput' - summary: 删除 - tags: - - elasticcachesecgroup - get: - description: 获取详情 - operationId: elasticcachesecgroup_FetchCustomizeColumns - parameters: - - description: The Id or Name of elasticcachesecgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticcachesecgroup_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - elasticcachesecgroup - put: - description: 更新 - operationId: elasticcachesecgroup_ValidateUpdateData - parameters: - - description: The Id or Name of elasticcachesecgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticcachesecgroup: - $ref: '#/definitions/ElasticcacheJointBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcachesecgroup_ValidateUpdateDataOutput' - summary: 更新 - tags: - - elasticcachesecgroup - /elasticcachesecgroups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: elasticcachesecgroup_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/elasticcachesecgroup_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - elasticcachesecgroup - /elasticcachesecgroups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: elasticcachesecgroup_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - elasticcachesecgroup: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticcachesecgroup_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - elasticcachesecgroup - /elasticcachesecgroups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: elasticcachesecgroup_GetPropertySplitable - responses: - "200": - $ref: '#/responses/elasticcachesecgroup_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - elasticcachesecgroup - /elasticcachesecgroups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: elasticcachesecgroup_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/elasticcachesecgroup_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - elasticcachesecgroup - /elasticips: - get: - description: 列表 - operationId: elasticip_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - description: |- - filter usable eip for given associate type - enmu: server, natgateway - in: query - name: usable_eip_for_associate_type - type: string - x-go-name: UsableEipForAssociateType - - description: filter usable eip for given associate id - in: query - name: usable_eip_for_associate_id - type: string - x-go-name: UsableEipForAssociateId - - description: |- - 标识弹性或非弹性 - Mode | 说明 | - ------------|------------| - public_ip | 公网IP | - elastic_ip | 弹性公公网网IP | - example: elastic_ip - in: query - name: mode - type: string - x-go-name: Mode - - description: IP地址 - in: query - name: ip_addr - type: string - x-go-name: IpAddr - - description: 绑定资源类型 - in: query - name: associate_type - type: string - x-go-name: AssociateType - - description: 绑定资源Id - in: query - name: associate_id - type: string - x-go-name: AssociateId - - description: '计费类型: 流量、带宽' - example: bandwidth - in: query - items: - type: string - name: charge_type - type: array - x-go-name: ChargeType - - description: 目前只有华为云此字段是必需填写的 - in: query - items: - type: string - name: bgp_type - type: array - x-go-name: BgpType - - description: 是否跟随主机删除而自动释放 - in: query - name: auto_dellocate - type: boolean - x-go-name: AutoDellocate - - description: 按ip地址排序 - in: query - name: order_by_ip - pattern: asc|desc - type: string - x-go-name: OrderByIp - responses: - "200": - $ref: '#/responses/elasticip_ListItemFilterOutput' - summary: 弹性公网IP列表 - tags: - - elasticip - post: - description: 新建 - operationId: elasticip_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - elasticip: - $ref: '#/definitions/SElasticipCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_ValidateCreateDataOutput' - summary: 新建 - tags: - - elasticip - /elasticips/{id}: - delete: - description: 删除 - operationId: elasticip_CustomizeDelete - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_CustomizeDeleteOutput' - summary: 删除 - tags: - - elasticip - get: - description: 获取详情 - operationId: elasticip_FetchCustomizeColumns - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - elasticip - put: - description: 更新 - operationId: elasticip_ValidateUpdateData - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_ValidateUpdateDataOutput' - summary: 更新 - tags: - - elasticip - /elasticips/{id}/associate: - post: - description: 执行操作Associate - operationId: elasticip_PerformAssociate - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - $ref: '#/definitions/ElasticipAssociateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformAssociateOutput' - summary: 执行操作Associate - tags: - - elasticip - /elasticips/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: elasticip_PerformCancelDelete - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - elasticip - /elasticips/{id}/change-bandwidth: - post: - description: 执行操作ChangeBandwidth - operationId: elasticip_PerformChangeBandwidth - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_PerformChangeBandwidthOutput' - summary: 执行操作ChangeBandwidth - tags: - - elasticip - /elasticips/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: elasticip_PerformChangeOwner - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - elasticip - /elasticips/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: elasticip_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - elasticip - /elasticips/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: elasticip_GetDetailsClassMetadata - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - elasticip - post: - description: 执行操作ClassMetadata - operationId: elasticip_PerformClassMetadata - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - elasticip - /elasticips/{id}/dissociate: - post: - description: 执行操作Dissociate - operationId: elasticip_PerformDissociate - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - $ref: '#/definitions/ElasticDissociateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformDissociateOutput' - summary: 执行操作Dissociate - tags: - - elasticip - /elasticips/{id}/freeze: - post: - description: 执行操作Freeze - operationId: elasticip_PerformFreeze - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - elasticip - /elasticips/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: elasticip_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 elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - elasticip - /elasticips/{id}/purge: - post: - description: 执行操作Purge - operationId: elasticip_PerformPurge - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - elasticip - /elasticips/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: elasticip_PerformSetClassMetadata - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - elasticip - /elasticips/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: elasticip_PerformSetUserMetadata - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - elasticip - /elasticips/{id}/status: - get: - description: 获取指定信息Status - operationId: elasticip_GetDetailsStatus - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - elasticip - post: - description: 执行操作Status - operationId: elasticip_PerformStatus - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformStatusOutput' - summary: 更新资源状态 - tags: - - elasticip - /elasticips/{id}/sync: - post: - description: 执行操作Sync - operationId: elasticip_PerformSync - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/elasticip_PerformSyncOutput' - summary: 执行操作Sync - tags: - - elasticip - /elasticips/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: elasticip_PerformSyncstatus - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - $ref: '#/definitions/ElasticipSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformSyncstatusOutput' - summary: 同步弹性公网IP状态 - tags: - - elasticip - /elasticips/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: elasticip_PerformUnfreeze - parameters: - - description: The Id or Name of elasticip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - elasticip: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - elasticip - /elasticips/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: elasticip_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/elasticip_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - elasticip - /elasticips/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: elasticip_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/elasticip_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - elasticip - /elasticips/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: elasticip_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/elasticip_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - elasticip - /elasticips/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: elasticip_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/elasticip_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - elasticip - /elasticips/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: elasticip_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/elasticip_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - elasticip - /elasticips/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: elasticip_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - elasticip: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/elasticip_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - elasticip - /elasticips/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: elasticip_GetPropertySplitable - responses: - "200": - $ref: '#/responses/elasticip_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - elasticip - /elasticips/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: elasticip_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/elasticip_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - elasticip - /elasticips/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: elasticip_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/elasticip_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - elasticip - /elasticips/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: elasticip_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/elasticip_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - elasticip - /elasticips/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: elasticip_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/elasticip_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - elasticip - /external_projects: - get: - description: 列表 - operationId: external_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: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/external_project_ListItemFilterOutput' - summary: 云平台导入项目列表 - tags: - - external_project - post: - description: 新建 - operationId: external_project_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - external_project: - $ref: '#/definitions/ExternalProjectCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_ValidateCreateDataOutput' - summary: 新建 - tags: - - external_project - /external_projects/{id}: - delete: - description: 删除 - operationId: external_project_CustomizeDelete - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/external_project_CustomizeDeleteOutput' - summary: 删除 - tags: - - external_project - get: - description: 获取详情 - operationId: external_project_FetchCustomizeColumns - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/external_project_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - external_project - put: - description: 更新 - operationId: external_project_ValidateUpdateData - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - external_project: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_ValidateUpdateDataOutput' - summary: 更新 - tags: - - external_project - /external_projects/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: external_project_PerformCancelDelete - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/external_project_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - external_project - /external_projects/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: external_project_PerformChangeOwner - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - external_project: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - external_project - /external_projects/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: external_project_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/external_project_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - external_project - /external_projects/{id}/change-project: - post: - description: 执行操作ChangeProject - operationId: external_project_PerformChangeProject - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - external_project: - $ref: '#/definitions/ExternalProjectChangeProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_PerformChangeProjectOutput' - summary: 切换本地项目 - tags: - - external_project - /external_projects/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: external_project_GetDetailsClassMetadata - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/external_project_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - external_project - post: - description: 执行操作ClassMetadata - operationId: external_project_PerformClassMetadata - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - external_project: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - external_project - /external_projects/{id}/freeze: - post: - description: 执行操作Freeze - operationId: external_project_PerformFreeze - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - external_project: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - external_project - /external_projects/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: external_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 external_project - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/external_project_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - external_project - /external_projects/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: external_project_PerformSetClassMetadata - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - external_project: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - external_project - /external_projects/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: external_project_PerformSetUserMetadata - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - external_project: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - external_project - /external_projects/{id}/status: - get: - description: 获取指定信息Status - operationId: external_project_GetDetailsStatus - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/external_project_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - external_project - post: - description: 执行操作Status - operationId: external_project_PerformStatus - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - external_project: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_PerformStatusOutput' - summary: 更新资源状态 - tags: - - external_project - /external_projects/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: external_project_PerformUnfreeze - parameters: - - description: The Id or Name of external_project - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - external_project: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - external_project - /external_projects/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: external_project_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/external_project_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - external_project - /external_projects/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: external_project_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/external_project_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - external_project - /external_projects/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: external_project_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/external_project_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - external_project - /external_projects/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: external_project_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/external_project_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - external_project - /external_projects/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: external_project_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/external_project_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - external_project - /external_projects/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: external_project_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - external_project: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/external_project_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - external_project - /external_projects/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: external_project_GetPropertySplitable - responses: - "200": - $ref: '#/responses/external_project_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - external_project - /external_projects/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: external_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/external_project_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - external_project - /external_projects/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: external_project_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/external_project_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - external_project - /external_projects/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: external_project_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/external_project_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - external_project - /external_projects/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: external_project_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/external_project_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - external_project - /file_systems: - get: - description: 列表 - operationId: file_system_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - responses: - "200": - $ref: '#/responses/file_system_ListItemFilterOutput' - summary: 列表 - tags: - - file_system - post: - description: 新建 - operationId: file_system_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - file_system: - $ref: '#/definitions/FileSystemCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_ValidateCreateDataOutput' - summary: 新建 - tags: - - file_system - /file_systems/{id}: - delete: - description: 删除 - operationId: file_system_CustomizeDelete - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/file_system_CustomizeDeleteOutput' - summary: 删除 - tags: - - file_system - get: - description: 获取详情 - operationId: file_system_FetchCustomizeColumns - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/file_system_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - file_system - put: - description: 更新 - operationId: file_system_ValidateUpdateData - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_ValidateUpdateDataOutput' - summary: 更新 - tags: - - file_system - /file_systems/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: file_system_PerformChangeOwner - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - file_system - /file_systems/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: file_system_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/file_system_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - file_system - /file_systems/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: file_system_GetDetailsClassMetadata - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/file_system_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - file_system - post: - description: 执行操作ClassMetadata - operationId: file_system_PerformClassMetadata - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - file_system - /file_systems/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: file_system_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 file_system - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/file_system_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - file_system - /file_systems/{id}/private: - post: - description: 执行操作Private - operationId: file_system_PerformPrivate - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformPrivateOutput' - summary: 执行操作Private - tags: - - file_system - /file_systems/{id}/public: - post: - description: 执行操作Public - operationId: file_system_PerformPublic - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformPublicOutput' - summary: 执行操作Public - tags: - - file_system - /file_systems/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: file_system_PerformRemoteUpdate - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - $ref: '#/definitions/FileSystemRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - file_system - /file_systems/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: file_system_PerformSetClassMetadata - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - file_system - /file_systems/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: file_system_PerformSetUserMetadata - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - file_system - /file_systems/{id}/status: - get: - description: 获取指定信息Status - operationId: file_system_GetDetailsStatus - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/file_system_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - file_system - post: - description: 执行操作Status - operationId: file_system_PerformStatus - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformStatusOutput' - summary: 更新资源状态 - tags: - - file_system - /file_systems/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: file_system_PerformSyncstatus - parameters: - - description: The Id or Name of file_system - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - file_system: - $ref: '#/definitions/FileSystemSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformSyncstatusOutput' - summary: 同步NAS状态 - tags: - - file_system - /file_systems/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: file_system_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/file_system_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - file_system - /file_systems/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: file_system_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/file_system_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - file_system - /file_systems/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: file_system_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/file_system_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - file_system - /file_systems/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: file_system_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - file_system: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/file_system_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - file_system - /file_systems/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: file_system_GetPropertySplitable - responses: - "200": - $ref: '#/responses/file_system_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - file_system - /file_systems/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: file_system_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/file_system_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - file_system - /file_systems/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: file_system_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/file_system_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - file_system - /file_systems/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: file_system_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/file_system_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - file_system - /file_systems/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: file_system_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/file_system_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - file_system - /global_vpcs: - get: - description: 列表 - operationId: global_vpc_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 以关联的vpc数量排序 - in: query - name: order_by_vpc_count - pattern: asc|desc - type: string - x-go-name: OrderByVpcCount - responses: - "200": - $ref: '#/responses/global_vpc_ListItemFilterOutput' - summary: 全局VPC列表 - tags: - - global_vpc - post: - description: 新建 - operationId: global_vpc_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - global_vpc: - $ref: '#/definitions/GlobalVpcCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_ValidateCreateDataOutput' - summary: 新建 - tags: - - global_vpc - /global_vpcs/{id}: - delete: - description: 删除 - operationId: global_vpc_CustomizeDelete - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/global_vpc_CustomizeDeleteOutput' - summary: 删除 - tags: - - global_vpc - get: - description: 获取详情 - operationId: global_vpc_FetchCustomizeColumns - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/global_vpc_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - global_vpc - put: - description: 更新 - operationId: global_vpc_ValidateUpdateData - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - $ref: '#/definitions/GlobalvpcUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_ValidateUpdateDataOutput' - summary: 更新 - tags: - - global_vpc - /global_vpcs/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: global_vpc_PerformChangeOwner - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - global_vpc - /global_vpcs/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: global_vpc_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/global_vpc_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - global_vpc - /global_vpcs/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: global_vpc_GetDetailsClassMetadata - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/global_vpc_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - global_vpc - post: - description: 执行操作ClassMetadata - operationId: global_vpc_PerformClassMetadata - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - global_vpc - /global_vpcs/{id}/disable: - post: - description: 执行操作Disable - operationId: global_vpc_PerformDisable - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformDisableOutput' - summary: 禁用资源 - tags: - - global_vpc - /global_vpcs/{id}/enable: - post: - description: 执行操作Enable - operationId: global_vpc_PerformEnable - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformEnableOutput' - summary: 启用资源 - tags: - - global_vpc - /global_vpcs/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: global_vpc_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 global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/global_vpc_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - global_vpc - /global_vpcs/{id}/private: - post: - description: 执行操作Private - operationId: global_vpc_PerformPrivate - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformPrivateOutput' - summary: 执行操作Private - tags: - - global_vpc - /global_vpcs/{id}/public: - post: - description: 执行操作Public - operationId: global_vpc_PerformPublic - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformPublicOutput' - summary: 执行操作Public - tags: - - global_vpc - /global_vpcs/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: global_vpc_PerformSetClassMetadata - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - global_vpc - /global_vpcs/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: global_vpc_PerformSetUserMetadata - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - global_vpc - /global_vpcs/{id}/status: - get: - description: 获取指定信息Status - operationId: global_vpc_GetDetailsStatus - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/global_vpc_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - global_vpc - post: - description: 执行操作Status - operationId: global_vpc_PerformStatus - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformStatusOutput' - summary: 更新资源状态 - tags: - - global_vpc - /global_vpcs/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: global_vpc_PerformSyncstatus - parameters: - - description: The Id or Name of global_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - global_vpc: - $ref: '#/definitions/SyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformSyncstatusOutput' - summary: 同步全局VPC状态 - tags: - - global_vpc - /global_vpcs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: global_vpc_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/global_vpc_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - global_vpc - /global_vpcs/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: global_vpc_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/global_vpc_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - global_vpc - /global_vpcs/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: global_vpc_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/global_vpc_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - global_vpc - /global_vpcs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: global_vpc_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - global_vpc: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/global_vpc_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - global_vpc - /global_vpcs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: global_vpc_GetPropertySplitable - responses: - "200": - $ref: '#/responses/global_vpc_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - global_vpc - /global_vpcs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: global_vpc_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/global_vpc_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - global_vpc - /global_vpcs/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: global_vpc_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/global_vpc_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - global_vpc - /global_vpcs/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: global_vpc_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/global_vpc_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - global_vpc - /global_vpcs/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: global_vpc_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/global_vpc_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - global_vpc - /groupguests: - get: - description: 列表 - operationId: groupguest_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 实例组（ID或Name） - in: query - name: group_id - type: string - x-go-name: GroupId - - description: 按组名排序 - in: query - name: order_by_group - type: string - x-go-name: OrderByGroup - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: 以主机名称排序 - in: query - name: order_by_server - type: string - x-go-name: OrderByServer - - description: 标签 - in: query - items: - type: string - name: tag - type: array - x-go-name: Tag - responses: - "200": - $ref: '#/responses/groupguest_ListItemFilterOutput' - summary: 列表 - tags: - - groupguest - post: - description: 新建 - operationId: groupguest_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - groupguest: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/groupguest_ValidateCreateDataOutput' - summary: 新建 - tags: - - groupguest - /groupguests/{id}: - delete: - description: 删除 - operationId: groupguest_CustomizeDelete - parameters: - - description: The Id or Name of groupguest - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/groupguest_CustomizeDeleteOutput' - summary: 删除 - tags: - - groupguest - get: - description: 获取详情 - operationId: groupguest_FetchCustomizeColumns - parameters: - - description: The Id or Name of groupguest - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/groupguest_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - groupguest - put: - description: 更新 - operationId: groupguest_ValidateUpdateData - parameters: - - description: The Id or Name of groupguest - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - groupguest: - $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/groupguest_ValidateUpdateDataOutput' - summary: 更新 - tags: - - groupguest - /groupguests/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: groupguest_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/groupguest_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - groupguest - /groupguests/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: groupguest_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - groupguest: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/groupguest_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - groupguest - /groupguests/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: groupguest_GetPropertySplitable - responses: - "200": - $ref: '#/responses/groupguest_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - groupguest - /groupguests/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: groupguest_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/groupguest_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - groupguest - /groupnetworks: - get: - description: 列表 - operationId: groupnetwork_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 实例组（ID或Name） - in: query - name: group_id - type: string - x-go-name: GroupId - - description: 按组名排序 - in: query - name: order_by_group - type: string - x-go-name: OrderByGroup - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - description: IP地址 - in: query - items: - type: string - name: ip_addr - type: array - x-go-name: IpAddr - responses: - "200": - $ref: '#/responses/groupnetwork_ListItemFilterOutput' - summary: 列表 - tags: - - groupnetwork - post: - description: 新建 - operationId: groupnetwork_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - groupnetwork: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/groupnetwork_ValidateCreateDataOutput' - summary: 新建 - tags: - - groupnetwork - /groupnetworks/{id}: - delete: - description: 删除 - operationId: groupnetwork_CustomizeDelete - parameters: - - description: The Id or Name of groupnetwork - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/groupnetwork_CustomizeDeleteOutput' - summary: 删除 - tags: - - groupnetwork - get: - description: 获取详情 - operationId: groupnetwork_FetchCustomizeColumns - parameters: - - description: The Id or Name of groupnetwork - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/groupnetwork_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - groupnetwork - put: - description: 更新 - operationId: groupnetwork_ValidateUpdateData - parameters: - - description: The Id or Name of groupnetwork - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - groupnetwork: - $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/groupnetwork_ValidateUpdateDataOutput' - summary: 更新 - tags: - - groupnetwork - /groupnetworks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: groupnetwork_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/groupnetwork_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - groupnetwork - /groupnetworks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: groupnetwork_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - groupnetwork: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/groupnetwork_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - groupnetwork - /groupnetworks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: groupnetwork_GetPropertySplitable - responses: - "200": - $ref: '#/responses/groupnetwork_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - groupnetwork - /groupnetworks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: groupnetwork_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/groupnetwork_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - groupnetwork - /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: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: 以主机名称排序 - in: query - name: order_by_server - type: string - x-go-name: OrderByServer - - description: 以service_type过滤列表结果 - in: query - name: service_type - type: string - x-go-name: ServiceType - - description: 以parent_id过滤列表结果 - in: query - name: parent_id - type: string - x-go-name: ParentId - - description: 调度策略 - in: query - name: sched_strategy - type: string - x-go-name: SchedStrategy - - description: 按ip地址排序 - in: query - name: order_by_vips - pattern: asc|desc - type: string - x-go-name: OrderByVips - - description: 按关联的虚拟机数量排序 - in: query - name: order_by_guest_count - pattern: asc|desc - type: string - x-go-name: OrderByGuestCount - 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/VirtualResourceCreateInput' - 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/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_ValidateUpdateDataOutput' - summary: 更新 - tags: - - group - /groups/{id}/associate-eip: - post: - description: 执行操作AssociateEip - operationId: group_PerformAssociateEip - 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/ServerAssociateEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformAssociateEipOutput' - summary: 执行操作AssociateEip - tags: - - group - /groups/{id}/attachnetwork: - post: - description: 执行操作Attachnetwork - operationId: group_PerformAttachnetwork - 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/GroupAttachNetworkInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformAttachnetworkOutput' - summary: 执行操作Attachnetwork - tags: - - group - /groups/{id}/bind-guests: - post: - description: 执行操作BindGuests - operationId: group_PerformBindGuests - 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_PerformBindGuestsOutput' - summary: 执行操作BindGuests - tags: - - group - /groups/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: group_PerformCancelDelete - 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_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - group - /groups/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: group_PerformChangeOwner - 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/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - group - /groups/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: group_GetDetailsChangeOwnerCandidateDomains - 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_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - 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}/create-eip: - post: - description: 执行操作CreateEip - operationId: group_PerformCreateEip - 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/ServerCreateEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformCreateEipOutput' - summary: 执行操作CreateEip - tags: - - group - /groups/{id}/detachnetwork: - post: - description: 执行操作Detachnetwork - operationId: group_PerformDetachnetwork - 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/GroupDetachNetworkInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformDetachnetworkOutput' - summary: 执行操作Detachnetwork - tags: - - group - /groups/{id}/disable: - post: - description: 执行操作Disable - operationId: group_PerformDisable - 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/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformDisableOutput' - summary: 执行操作Disable - tags: - - group - /groups/{id}/dissociate-eip: - post: - description: 执行操作DissociateEip - operationId: group_PerformDissociateEip - 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/ServerDissociateEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformDissociateEipOutput' - summary: 执行操作DissociateEip - tags: - - group - /groups/{id}/enable: - post: - description: 执行操作Enable - operationId: group_PerformEnable - 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/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformEnableOutput' - summary: 执行操作Enable - tags: - - group - /groups/{id}/freeze: - post: - description: 执行操作Freeze - operationId: group_PerformFreeze - 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/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - 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}/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/{id}/status: - get: - description: 获取指定信息Status - operationId: group_GetDetailsStatus - 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_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - group - post: - description: 执行操作Status - operationId: group_PerformStatus - 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/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformStatusOutput' - summary: 更新资源状态 - tags: - - group - /groups/{id}/unbind-guests: - post: - description: 执行操作UnbindGuests - operationId: group_PerformUnbindGuests - 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_PerformUnbindGuestsOutput' - summary: 执行操作UnbindGuests - tags: - - group - /groups/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: group_PerformUnfreeze - 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/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/group_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - group - /groups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: group_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/group_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - group - /groups/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: group_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/group_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - group - /groups/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: group_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/group_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - group - /groups/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: group_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/group_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - group - /groups/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: group_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/group_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - 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/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: group_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/group_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - 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 - /guest_templates: - get: - description: 列表 - operationId: guest_template_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - in: query - name: billing_type - type: string - x-go-name: BillingType - - in: query - name: brand - type: string - x-go-name: Brand - responses: - "200": - $ref: '#/responses/guest_template_ListItemFilterOutput' - summary: 主机模板列表 - tags: - - guest_template - post: - description: 新建 - operationId: guest_template_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - guest_template: - $ref: '#/definitions/GuestTemplateCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_ValidateCreateDataOutput' - summary: 新建 - tags: - - guest_template - /guest_templates/{id}: - delete: - description: 删除 - operationId: guest_template_CustomizeDelete - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_template_CustomizeDeleteOutput' - summary: 删除 - tags: - - guest_template - get: - description: 获取详情 - operationId: guest_template_FetchCustomizeColumns - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_template_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - guest_template - put: - description: 更新 - operationId: guest_template_ValidateUpdateData - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - $ref: '#/definitions/GuestTemplateUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_ValidateUpdateDataOutput' - summary: 更新 - tags: - - guest_template - /guest_templates/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: guest_template_PerformCancelDelete - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_template_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - guest_template - /guest_templates/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: guest_template_PerformChangeOwner - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - guest_template - /guest_templates/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: guest_template_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_template_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - guest_template - /guest_templates/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: guest_template_GetDetailsClassMetadata - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_template_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - guest_template - post: - description: 执行操作ClassMetadata - operationId: guest_template_PerformClassMetadata - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - guest_template - /guest_templates/{id}/freeze: - post: - description: 执行操作Freeze - operationId: guest_template_PerformFreeze - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - guest_template - /guest_templates/{id}/inspect: - post: - description: 执行操作Inspect - operationId: guest_template_PerformInspect - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_template_PerformInspectOutput' - summary: 执行操作Inspect - tags: - - guest_template - /guest_templates/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: guest_template_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 guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_template_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - guest_template - /guest_templates/{id}/private: - post: - description: 执行操作Private - operationId: guest_template_PerformPrivate - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformPrivateOutput' - summary: 执行操作Private - tags: - - guest_template - /guest_templates/{id}/public: - post: - description: 执行操作Public - operationId: guest_template_PerformPublic - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformPublicOutput' - summary: 执行操作Public - tags: - - guest_template - /guest_templates/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: guest_template_PerformSetClassMetadata - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - guest_template - /guest_templates/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: guest_template_PerformSetUserMetadata - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - guest_template - /guest_templates/{id}/status: - get: - description: 获取指定信息Status - operationId: guest_template_GetDetailsStatus - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_template_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - guest_template - post: - description: 执行操作Status - operationId: guest_template_PerformStatus - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformStatusOutput' - summary: 更新资源状态 - tags: - - guest_template - /guest_templates/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: guest_template_PerformUnfreeze - parameters: - - description: The Id or Name of guest_template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_template: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - guest_template - /guest_templates/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: guest_template_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/guest_template_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - guest_template - /guest_templates/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: guest_template_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/guest_template_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - guest_template - /guest_templates/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: guest_template_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/guest_template_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - guest_template - /guest_templates/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: guest_template_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/guest_template_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - guest_template - /guest_templates/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: guest_template_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/guest_template_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - guest_template - /guest_templates/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: guest_template_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - guest_template: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_template_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - guest_template - /guest_templates/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: guest_template_GetPropertySplitable - responses: - "200": - $ref: '#/responses/guest_template_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - guest_template - /guest_templates/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: guest_template_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/guest_template_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - guest_template - /guest_templates/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: guest_template_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/guest_template_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - guest_template - /guest_templates/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: guest_template_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/guest_template_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - guest_template - /guest_templates/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: guest_template_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/guest_template_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - guest_template - /guestdisks: - get: - description: 列表 - operationId: guestdisk_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: 以主机名称排序 - in: query - name: order_by_server - type: string - x-go-name: OrderByServer - - description: 存储（ID或Name） - in: query - name: storage_id - type: string - x-go-name: StorageId - - description: 以存储名称排序 - in: query - name: order_by_storage - pattern: asc|desc - type: string - x-go-name: OrderByStorage - - description: filter shared storage - in: query - name: share - type: boolean - x-go-name: Share - - description: filter local storage - in: query - name: local - type: boolean - x-go-name: Local - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 虚拟磁盘（ID或Name） - in: query - name: disk_id - type: string - x-go-name: DiskId - - description: 以磁盘名称排序 - in: query - name: order_by_disk - pattern: asc|desc - type: string - x-go-name: OrderByDisk - - in: query - items: - type: string - name: driver - type: array - x-go-name: Driver - - in: query - items: - type: string - name: cache_mode - type: array - x-go-name: CacheMode - - in: query - items: - type: string - name: aio_mode - type: array - x-go-name: AioMode - responses: - "200": - $ref: '#/responses/guestdisk_ListItemFilterOutput' - summary: 列表 - tags: - - guestdisk - post: - description: 新建 - operationId: guestdisk_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - guestdisk: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guestdisk_ValidateCreateDataOutput' - summary: 新建 - tags: - - guestdisk - /guestdisks/{id}: - delete: - description: 删除 - operationId: guestdisk_CustomizeDelete - parameters: - - description: The Id or Name of guestdisk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guestdisk_CustomizeDeleteOutput' - summary: 删除 - tags: - - guestdisk - get: - description: 获取详情 - operationId: guestdisk_FetchCustomizeColumns - parameters: - - description: The Id or Name of guestdisk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guestdisk_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - guestdisk - put: - description: 更新 - operationId: guestdisk_ValidateUpdateData - parameters: - - description: The Id or Name of guestdisk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guestdisk: - $ref: '#/definitions/GuestdiskUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guestdisk_ValidateUpdateDataOutput' - summary: 更新 - tags: - - guestdisk - /guestdisks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: guestdisk_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/guestdisk_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - guestdisk - /guestdisks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: guestdisk_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - guestdisk: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guestdisk_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - guestdisk - /guestdisks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: guestdisk_GetPropertySplitable - responses: - "200": - $ref: '#/responses/guestdisk_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - guestdisk - /guestdisks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: guestdisk_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/guestdisk_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - guestdisk - /guestnetworks: - get: - description: 列表 - operationId: guestnetwork_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: 以主机名称排序 - in: query - name: order_by_server - type: string - x-go-name: OrderByServer - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - in: query - items: - type: string - name: mac_addr - type: array - x-go-name: MacAddr - - in: query - items: - type: string - name: ip_addr - type: array - x-go-name: IpAddr - - in: query - items: - type: string - name: ip6_addr - type: array - x-go-name: Ip6Addr - - in: query - items: - type: string - name: driver - type: array - x-go-name: Driver - - in: query - items: - type: string - name: ifname - type: array - x-go-name: Ifname - - in: query - items: - type: string - name: team_with - type: array - x-go-name: TeamWith - responses: - "200": - $ref: '#/responses/guestnetwork_ListItemFilterOutput' - summary: 列表 - tags: - - guestnetwork - post: - description: 新建 - operationId: guestnetwork_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - guestnetwork: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guestnetwork_ValidateCreateDataOutput' - summary: 新建 - tags: - - guestnetwork - /guestnetworks/{id}: - delete: - description: 删除 - operationId: guestnetwork_CustomizeDelete - parameters: - - description: The Id or Name of guestnetwork - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guestnetwork_CustomizeDeleteOutput' - summary: 删除 - tags: - - guestnetwork - get: - description: 获取详情 - operationId: guestnetwork_FetchCustomizeColumns - parameters: - - description: The Id or Name of guestnetwork - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guestnetwork_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - guestnetwork - put: - description: 更新 - operationId: guestnetwork_ValidateUpdateData - parameters: - - description: The Id or Name of guestnetwork - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guestnetwork: - $ref: '#/definitions/GuestnetworkUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guestnetwork_ValidateUpdateDataOutput' - summary: 更新 - tags: - - guestnetwork - /guestnetworks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: guestnetwork_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/guestnetwork_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - guestnetwork - /guestnetworks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: guestnetwork_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - guestnetwork: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guestnetwork_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - guestnetwork - /guestnetworks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: guestnetwork_GetPropertySplitable - responses: - "200": - $ref: '#/responses/guestnetwork_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - guestnetwork - /guestnetworks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: guestnetwork_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/guestnetwork_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - guestnetwork - /guestsecgroups: - get: - description: 列表 - operationId: guestsecgroup_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: 以主机名称排序 - in: query - name: order_by_server - type: string - x-go-name: OrderByServer - - description: 过滤关联指定安全组（ID或Name）的列表结果 - in: query - name: secgroup_id - type: string - x-go-name: SecgroupId - - description: 模糊匹配安全组规则名称 - in: query - name: secgroup_name - type: string - x-go-name: SecgroupName - - description: 以安全组排序 - in: query - name: order_by_secgroup - type: string - x-go-name: OrderBySecgroup - responses: - "200": - $ref: '#/responses/guestsecgroup_ListItemFilterOutput' - summary: 列表 - tags: - - guestsecgroup - post: - description: 新建 - operationId: guestsecgroup_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - guestsecgroup: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guestsecgroup_ValidateCreateDataOutput' - summary: 新建 - tags: - - guestsecgroup - /guestsecgroups/{id}: - delete: - description: 删除 - operationId: guestsecgroup_CustomizeDelete - parameters: - - description: The Id or Name of guestsecgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guestsecgroup_CustomizeDeleteOutput' - summary: 删除 - tags: - - guestsecgroup - get: - description: 获取详情 - operationId: guestsecgroup_FetchCustomizeColumns - parameters: - - description: The Id or Name of guestsecgroup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guestsecgroup_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - guestsecgroup - put: - description: 更新 - operationId: guestsecgroup_ValidateUpdateData - parameters: - - description: The Id or Name of guestsecgroup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guestsecgroup: - $ref: '#/definitions/GuestJointBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guestsecgroup_ValidateUpdateDataOutput' - summary: 更新 - tags: - - guestsecgroup - /guestsecgroups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: guestsecgroup_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/guestsecgroup_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - guestsecgroup - /guestsecgroups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: guestsecgroup_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - guestsecgroup: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guestsecgroup_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - guestsecgroup - /guestsecgroups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: guestsecgroup_GetPropertySplitable - responses: - "200": - $ref: '#/responses/guestsecgroup_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - guestsecgroup - /guestsecgroups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: guestsecgroup_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/guestsecgroup_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - guestsecgroup - /hostnetworks: - get: - description: 列表 - operationId: hostnetwork_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - description: IP地址 - in: query - items: - type: string - name: ip_addr - type: array - x-go-name: IpAddr - - description: MAC地址 - in: query - items: - type: string - name: mac_addr - type: array - x-go-name: MacAddr - responses: - "200": - $ref: '#/responses/hostnetwork_ListItemFilterOutput' - summary: 列表 - tags: - - hostnetwork - post: - description: 新建 - operationId: hostnetwork_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - hostnetwork: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/hostnetwork_ValidateCreateDataOutput' - summary: 新建 - tags: - - hostnetwork - /hostnetworks/{id}: - delete: - description: 删除 - operationId: hostnetwork_CustomizeDelete - parameters: - - description: The Id or Name of hostnetwork - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/hostnetwork_CustomizeDeleteOutput' - summary: 删除 - tags: - - hostnetwork - get: - description: 获取详情 - operationId: hostnetwork_FetchCustomizeColumns - parameters: - - description: The Id or Name of hostnetwork - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/hostnetwork_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - hostnetwork - put: - description: 更新 - operationId: hostnetwork_ValidateUpdateData - parameters: - - description: The Id or Name of hostnetwork - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - hostnetwork: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/hostnetwork_ValidateUpdateDataOutput' - summary: 更新 - tags: - - hostnetwork - /hostnetworks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: hostnetwork_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/hostnetwork_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - hostnetwork - /hostnetworks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: hostnetwork_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - hostnetwork: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/hostnetwork_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - hostnetwork - /hostnetworks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: hostnetwork_GetPropertySplitable - responses: - "200": - $ref: '#/responses/hostnetwork_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - hostnetwork - /hostnetworks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: hostnetwork_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/hostnetwork_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - hostnetwork - /hosts: - get: - description: 列表 - operationId: host_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: 以关联的调度标签（ID或Name）过滤列表 - in: query - name: schedtag_id - type: string - x-go-name: SchedtagId - - description: 按调度标签名称排序 - in: query - name: order_by_schedtag - pattern: asc|desc - type: string - x-go-name: OrderBySchedtag - - description: 按调度标签资源类型排序 - in: query - name: order_by_resource_type - pattern: asc|desc - type: string - x-go-name: OrderByResourceType - - description: 存储（ID或Name） - in: query - name: storage_id - type: string - x-go-name: StorageId - - description: filter shared storage - in: query - name: share - type: boolean - x-go-name: Share - - description: filter local storage - in: query - name: local - type: boolean - x-go-name: Local - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: filter by ResourceType - in: query - name: resource_type - type: string - x-go-name: ResourceType - - description: filter by mac of any network interface - in: query - name: any_mac - type: string - x-go-name: AnyMac - - description: filter by ip of any network interface - in: query - name: any_ip - type: string - x-go-name: AnyIp - - description: filter storages not attached to this host - in: query - name: storage_not_attached - type: boolean - x-go-name: StorageNotAttached - - description: filter by Hypervisor - in: query - name: hypervisor - type: string - x-go-name: Hypervisor - - description: filter host that is empty - in: query - name: is_empty - type: boolean - x-go-name: IsEmpty - - description: filter host that is baremetal - in: query - name: baremetal - type: boolean - x-go-name: Baremetal - - description: 机架 - in: query - items: - type: string - name: rack - type: array - x-go-name: Rack - - description: 机位 - in: query - items: - type: string - name: slots - type: array - x-go-name: Slots - - description: 管理口MAC - in: query - items: - type: string - name: access_mac - type: array - x-go-name: AccessMac - - description: 管理口Ip地址 - in: query - items: - type: string - name: access_ip - type: array - x-go-name: AccessIp - - description: 物理机序列号信息 - in: query - items: - type: string - name: sn - type: array - x-go-name: SN - - description: CPU大小 - in: query - items: - format: int64 - type: integer - name: cpu_count - type: array - x-go-name: CpuCount - - description: 内存大小,单位Mb - in: query - items: - format: int64 - type: integer - name: mem_size - type: array - x-go-name: MemSize - - description: 存储类型 - in: query - items: - type: string - name: storage_type - type: array - x-go-name: StorageType - - description: IPMI地址 - in: query - items: - type: string - name: ipmi_ip - type: array - x-go-name: IpmiIp - - description: 宿主机状态 - example: online - in: query - items: - type: string - name: host_status - type: array - x-go-name: HostStatus - - description: 宿主机类型 - in: query - items: - type: string - name: host_type - type: array - x-go-name: HostType - - description: host服务软件版本 - in: query - items: - type: string - name: version - type: array - x-go-name: Version - - description: OVN软件版本 - in: query - items: - type: string - name: ovn_version - type: array - x-go-name: OvnVersion - - description: 是否处于维护状态 - in: query - name: is_maintenance - type: boolean - x-go-name: IsMaintenance - - description: 是否为导入的宿主机 - in: query - name: is_import - type: boolean - x-go-name: IsImport - - description: 是否允许PXE启动 - in: query - name: enable_pxe_boot - type: boolean - x-go-name: EnablePxeBoot - - description: 主机UUID - in: query - items: - type: string - name: uuid - type: array - x-go-name: Uuid - - description: 主机启动模式, 可能值位PXE和ISO - in: query - items: - type: string - name: boot_mode - type: array - x-go-name: BootMode - - description: 虚拟机所在的二层网络 - in: query - name: server_id_for_network - type: string - x-go-name: ServerIdForNetwork - - description: 宿主机 cpu 架构 - in: query - items: - type: string - name: cpu_architecture - type: array - x-go-name: CpuArchitecture - - in: query - name: os_arch - type: string - x-go-name: OsArch - - description: 按虚拟机数量排序 - enum: - - asc - - desc - in: query - name: order_by_server_count - type: string - x-go-name: OrderByServerCount - - description: |- - 按存储大小排序 - enmu: asc,desc - in: query - name: order_by_storage - pattern: asc|desc - type: string - x-go-name: OrderByStorage - - description: |- - 按存储超分率排序 - enmu: asc,desc - in: query - name: order_by_storage_commit_rate - type: string - x-go-name: OrderByStorageCommitRate - - description: |- - 按cpu超分率排序 - enmu: asc,desc - in: query - name: order_by_cpu_commit_rate - type: string - x-go-name: OrderByCpuCommitRate - - description: |- - 按内存超分率排序 - enmu: asc,desc - in: query - name: order_by_mem_commit_rate - type: string - x-go-name: OrderByMemCommitRate - responses: - "200": - $ref: '#/responses/host_ListItemFilterOutput' - summary: 宿主机/物理机列表 - tags: - - host - post: - description: 新建 - operationId: host_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - host: - $ref: '#/definitions/HostCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_ValidateCreateDataOutput' - summary: 新建 - tags: - - host - /hosts/{id}: - delete: - description: 删除 - operationId: host_CustomizeDelete - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_CustomizeDeleteOutput' - summary: 删除 - tags: - - host - get: - description: 获取详情 - operationId: host_FetchCustomizeColumns - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - host - put: - description: 更新 - operationId: host_ValidateUpdateData - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/HostUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_ValidateUpdateDataOutput' - summary: 更新 - tags: - - host - /hosts/{id}/add-netif: - post: - description: 执行操作AddNetif - operationId: host_PerformAddNetif - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformAddNetifOutput' - summary: 执行操作AddNetif - tags: - - host - /hosts/{id}/app-options: - get: - description: 获取指定信息AppOptions - operationId: host_GetDetailsAppOptions - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsAppOptionsOutput' - summary: 获取指定信息AppOptions - tags: - - host - /hosts/{id}/auto-migrate-on-host-down: - post: - description: 执行操作AutoMigrateOnHostDown - operationId: host_PerformAutoMigrateOnHostDown - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/HostAutoMigrateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformAutoMigrateOnHostDownOutput' - summary: 执行操作AutoMigrateOnHostDown - tags: - - host - /hosts/{id}/cache-image: - post: - description: 执行操作CacheImage - operationId: host_PerformCacheImage - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/CacheImageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformCacheImageOutput' - summary: 执行操作CacheImage - tags: - - host - /hosts/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: host_PerformChangeOwner - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - host - /hosts/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: host_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - host - /hosts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: host_GetDetailsClassMetadata - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - host - post: - description: 执行操作ClassMetadata - operationId: host_PerformClassMetadata - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - host - /hosts/{id}/convert-hypervisor: - post: - description: 执行操作ConvertHypervisor - operationId: host_PerformConvertHypervisor - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformConvertHypervisorOutput' - summary: 执行操作ConvertHypervisor - tags: - - host - /hosts/{id}/disable: - post: - description: 执行操作Disable - operationId: host_PerformDisable - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformDisableOutput' - summary: 执行操作Disable - tags: - - host - /hosts/{id}/disable-netif: - post: - description: 执行操作DisableNetif - operationId: host_PerformDisableNetif - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformDisableNetifOutput' - summary: 执行操作DisableNetif - tags: - - host - /hosts/{id}/eject-iso: - post: - description: 执行操作EjectIso - operationId: host_PerformEjectIso - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformEjectIsoOutput' - summary: 执行操作EjectIso - tags: - - host - /hosts/{id}/enable: - post: - description: 执行操作Enable - operationId: host_PerformEnable - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformEnableOutput' - summary: 执行操作Enable - tags: - - host - /hosts/{id}/enable-netif: - post: - description: 执行操作EnableNetif - operationId: host_PerformEnableNetif - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformEnableNetifOutput' - summary: 执行操作EnableNetif - tags: - - host - /hosts/{id}/host-exit-maintenance: - post: - description: 执行操作HostExitMaintenance - operationId: host_PerformHostExitMaintenance - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformHostExitMaintenanceOutput' - summary: 执行操作HostExitMaintenance - tags: - - host - /hosts/{id}/host-maintenance: - post: - description: 执行操作HostMaintenance - operationId: host_PerformHostMaintenance - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformHostMaintenanceOutput' - summary: 执行操作HostMaintenance - tags: - - host - /hosts/{id}/initialize: - post: - description: 执行操作Initialize - operationId: host_PerformInitialize - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformInitializeOutput' - summary: 执行操作Initialize - tags: - - host - /hosts/{id}/insert-iso: - post: - description: 执行操作InsertIso - operationId: host_PerformInsertIso - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformInsertIsoOutput' - summary: 执行操作InsertIso - tags: - - host - /hosts/{id}/ipmi: - get: - description: 获取指定信息Ipmi - operationId: host_GetDetailsIpmi - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsIpmiOutput' - summary: 获取指定信息Ipmi - tags: - - host - /hosts/{id}/ipmi-probe: - post: - description: 执行操作IpmiProbe - operationId: host_PerformIpmiProbe - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformIpmiProbeOutput' - summary: 执行操作IpmiProbe - tags: - - host - /hosts/{id}/jnlp: - get: - description: 获取指定信息Jnlp - operationId: host_GetDetailsJnlp - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsJnlpOutput' - summary: 获取指定信息Jnlp - tags: - - host - /hosts/{id}/maintenance: - post: - description: 执行操作Maintenance - operationId: host_PerformMaintenance - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformMaintenanceOutput' - summary: 执行操作Maintenance - tags: - - host - /hosts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: host_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 host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - host - /hosts/{id}/offline: - post: - description: 执行操作Offline - operationId: host_PerformOffline - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/HostOfflineInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformOfflineOutput' - summary: 执行操作Offline - tags: - - host - /hosts/{id}/online: - post: - description: 执行操作Online - operationId: host_PerformOnline - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformOnlineOutput' - summary: 执行操作Online - tags: - - host - /hosts/{id}/ping: - post: - description: 执行操作Ping - operationId: host_PerformPing - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/SHostPingInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformPingOutput' - summary: 执行操作Ping - tags: - - host - /hosts/{id}/prepare: - post: - description: 执行操作Prepare - operationId: host_PerformPrepare - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformPrepareOutput' - summary: 执行操作Prepare - tags: - - host - /hosts/{id}/private: - post: - description: 执行操作Private - operationId: host_PerformPrivate - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformPrivateOutput' - summary: 执行操作Private - tags: - - host - /hosts/{id}/probe-isolated-devices: - post: - description: 执行操作ProbeIsolatedDevices - operationId: host_PerformProbeIsolatedDevices - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformProbeIsolatedDevicesOutput' - summary: 执行操作ProbeIsolatedDevices - tags: - - host - /hosts/{id}/public: - post: - description: 执行操作Public - operationId: host_PerformPublic - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformPublicOutput' - summary: 执行操作Public - tags: - - host - /hosts/{id}/remove-all-netifs: - post: - description: 执行操作RemoveAllNetifs - operationId: host_PerformRemoveAllNetifs - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformRemoveAllNetifsOutput' - summary: 执行操作RemoveAllNetifs - tags: - - host - /hosts/{id}/remove-netif: - post: - description: 执行操作RemoveNetif - operationId: host_PerformRemoveNetif - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformRemoveNetifOutput' - summary: 执行操作RemoveNetif - tags: - - host - /hosts/{id}/renew-prepaid-recycle: - post: - description: 执行操作RenewPrepaidRecycle - operationId: host_PerformRenewPrepaidRecycle - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformRenewPrepaidRecycleOutput' - summary: 执行操作RenewPrepaidRecycle - tags: - - host - /hosts/{id}/reserve-cpus: - post: - description: 执行操作ReserveCpus - operationId: host_PerformReserveCpus - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/HostReserveCpusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformReserveCpusOutput' - summary: 执行操作ReserveCpus - tags: - - host - /hosts/{id}/reset: - post: - description: 执行操作Reset - operationId: host_PerformReset - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformResetOutput' - summary: 执行操作Reset - tags: - - host - /hosts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: host_PerformSetClassMetadata - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - host - /hosts/{id}/set-reserved-resource-for-isolated-device: - post: - description: 执行操作SetReservedResourceForIsolatedDevice - operationId: host_PerformSetReservedResourceForIsolatedDevice - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/IsolatedDeviceReservedResourceInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformSetReservedResourceForIsolatedDeviceOutput' - summary: 执行操作SetReservedResourceForIsolatedDevice - tags: - - host - /hosts/{id}/set-schedtag: - post: - description: 执行操作SetSchedtag - operationId: host_PerformSetSchedtag - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformSetSchedtagOutput' - summary: 执行操作SetSchedtag - tags: - - host - /hosts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: host_PerformSetUserMetadata - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - host - /hosts/{id}/spec: - get: - description: 获取指定信息Spec - operationId: host_GetDetailsSpec - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsSpecOutput' - summary: 获取指定信息Spec - tags: - - host - /hosts/{id}/start: - post: - description: 执行操作Start - operationId: host_PerformStart - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformStartOutput' - summary: 执行操作Start - tags: - - host - /hosts/{id}/status: - get: - description: 获取指定信息Status - operationId: host_GetDetailsStatus - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - host - post: - description: 执行操作Status - operationId: host_PerformStatus - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformStatusOutput' - summary: 执行操作Status - tags: - - host - /hosts/{id}/stop: - post: - description: 执行操作Stop - operationId: host_PerformStop - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformStopOutput' - summary: 执行操作Stop - tags: - - host - /hosts/{id}/sync-config: - post: - description: 执行操作SyncConfig - operationId: host_PerformSyncConfig - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformSyncConfigOutput' - summary: 执行操作SyncConfig - tags: - - host - /hosts/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: host_PerformSyncstatus - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - host - /hosts/{id}/tap-config: - get: - description: 获取指定信息TapConfig - operationId: host_GetDetailsTapConfig - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsTapConfigOutput' - summary: 获取指定信息TapConfig - tags: - - host - /hosts/{id}/undo-convert: - post: - description: 执行操作UndoConvert - operationId: host_PerformUndoConvert - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformUndoConvertOutput' - summary: 执行操作UndoConvert - tags: - - host - /hosts/{id}/undo-prepaid-recycle: - post: - description: 执行操作UndoPrepaidRecycle - operationId: host_PerformUndoPrepaidRecycle - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformUndoPrepaidRecycleOutput' - summary: 执行操作UndoPrepaidRecycle - tags: - - host - /hosts/{id}/unmaintenance: - post: - description: 执行操作Unmaintenance - operationId: host_PerformUnmaintenance - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformUnmaintenanceOutput' - summary: 执行操作Unmaintenance - tags: - - host - /hosts/{id}/unreserve-cpus: - post: - description: 执行操作UnreserveCpus - operationId: host_PerformUnreserveCpus - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformUnreserveCpusOutput' - summary: 执行操作UnreserveCpus - tags: - - host - /hosts/{id}/update-storage: - post: - description: 执行操作UpdateStorage - operationId: host_PerformUpdateStorage - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_PerformUpdateStorageOutput' - summary: 执行操作UpdateStorage - tags: - - host - /hosts/{id}/vnc: - get: - description: 获取指定信息Vnc - operationId: host_GetDetailsVnc - parameters: - - description: The Id or Name of host - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/host_GetDetailsVncOutput' - summary: 获取指定信息Vnc - tags: - - host - /hosts/bm-start-register-script: - get: - description: 获取指定资源类的信息BmStartRegisterScript - operationId: host_GetPropertyBmStartRegisterScript - responses: - "200": - $ref: '#/responses/host_GetPropertyBmStartRegisterScriptOutput' - summary: 获取指定资源类的信息BmStartRegisterScript - tags: - - host - /hosts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: host_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/host_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - host - /hosts/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: host_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/host_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - host - /hosts/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: host_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/host_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - host - /hosts/host-type-count: - get: - description: 获取指定资源类的信息HostTypeCount - operationId: host_GetPropertyHostTypeCount - 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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: 以关联的调度标签（ID或Name）过滤列表 - in: query - name: schedtag_id - type: string - x-go-name: SchedtagId - - description: 按调度标签名称排序 - in: query - name: order_by_schedtag - pattern: asc|desc - type: string - x-go-name: OrderBySchedtag - - description: 按调度标签资源类型排序 - in: query - name: order_by_resource_type - pattern: asc|desc - type: string - x-go-name: OrderByResourceType - - description: 存储（ID或Name） - in: query - name: storage_id - type: string - x-go-name: StorageId - - description: filter shared storage - in: query - name: share - type: boolean - x-go-name: Share - - description: filter local storage - in: query - name: local - type: boolean - x-go-name: Local - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: filter by ResourceType - in: query - name: resource_type - type: string - x-go-name: ResourceType - - description: filter by mac of any network interface - in: query - name: any_mac - type: string - x-go-name: AnyMac - - description: filter by ip of any network interface - in: query - name: any_ip - type: string - x-go-name: AnyIp - - description: filter storages not attached to this host - in: query - name: storage_not_attached - type: boolean - x-go-name: StorageNotAttached - - description: filter by Hypervisor - in: query - name: hypervisor - type: string - x-go-name: Hypervisor - - description: filter host that is empty - in: query - name: is_empty - type: boolean - x-go-name: IsEmpty - - description: filter host that is baremetal - in: query - name: baremetal - type: boolean - x-go-name: Baremetal - - description: 机架 - in: query - items: - type: string - name: rack - type: array - x-go-name: Rack - - description: 机位 - in: query - items: - type: string - name: slots - type: array - x-go-name: Slots - - description: 管理口MAC - in: query - items: - type: string - name: access_mac - type: array - x-go-name: AccessMac - - description: 管理口Ip地址 - in: query - items: - type: string - name: access_ip - type: array - x-go-name: AccessIp - - description: 物理机序列号信息 - in: query - items: - type: string - name: sn - type: array - x-go-name: SN - - description: CPU大小 - in: query - items: - format: int64 - type: integer - name: cpu_count - type: array - x-go-name: CpuCount - - description: 内存大小,单位Mb - in: query - items: - format: int64 - type: integer - name: mem_size - type: array - x-go-name: MemSize - - description: 存储类型 - in: query - items: - type: string - name: storage_type - type: array - x-go-name: StorageType - - description: IPMI地址 - in: query - items: - type: string - name: ipmi_ip - type: array - x-go-name: IpmiIp - - description: 宿主机状态 - example: online - in: query - items: - type: string - name: host_status - type: array - x-go-name: HostStatus - - description: 宿主机类型 - in: query - items: - type: string - name: host_type - type: array - x-go-name: HostType - - description: host服务软件版本 - in: query - items: - type: string - name: version - type: array - x-go-name: Version - - description: OVN软件版本 - in: query - items: - type: string - name: ovn_version - type: array - x-go-name: OvnVersion - - description: 是否处于维护状态 - in: query - name: is_maintenance - type: boolean - x-go-name: IsMaintenance - - description: 是否为导入的宿主机 - in: query - name: is_import - type: boolean - x-go-name: IsImport - - description: 是否允许PXE启动 - in: query - name: enable_pxe_boot - type: boolean - x-go-name: EnablePxeBoot - - description: 主机UUID - in: query - items: - type: string - name: uuid - type: array - x-go-name: Uuid - - description: 主机启动模式, 可能值位PXE和ISO - in: query - items: - type: string - name: boot_mode - type: array - x-go-name: BootMode - - description: 虚拟机所在的二层网络 - in: query - name: server_id_for_network - type: string - x-go-name: ServerIdForNetwork - - description: 宿主机 cpu 架构 - in: query - items: - type: string - name: cpu_architecture - type: array - x-go-name: CpuArchitecture - - in: query - name: os_arch - type: string - x-go-name: OsArch - - description: 按虚拟机数量排序 - enum: - - asc - - desc - in: query - name: order_by_server_count - type: string - x-go-name: OrderByServerCount - - description: |- - 按存储大小排序 - enmu: asc,desc - in: query - name: order_by_storage - pattern: asc|desc - type: string - x-go-name: OrderByStorage - - description: |- - 按存储超分率排序 - enmu: asc,desc - in: query - name: order_by_storage_commit_rate - type: string - x-go-name: OrderByStorageCommitRate - - description: |- - 按cpu超分率排序 - enmu: asc,desc - in: query - name: order_by_cpu_commit_rate - type: string - x-go-name: OrderByCpuCommitRate - - description: |- - 按内存超分率排序 - enmu: asc,desc - in: query - name: order_by_mem_commit_rate - type: string - x-go-name: OrderByMemCommitRate - responses: - "200": - $ref: '#/responses/host_GetPropertyHostTypeCountOutput' - summary: 获取指定资源类的信息HostTypeCount - tags: - - host - /hosts/k8s-master-node-ips: - get: - description: 获取指定资源类的信息K8sMasterNodeIps - operationId: host_GetPropertyK8sMasterNodeIps - responses: - "200": - $ref: '#/responses/host_GetPropertyK8sMasterNodeIpsOutput' - summary: 获取指定资源类的信息K8sMasterNodeIps - tags: - - host - /hosts/node-count: - get: - description: 获取指定资源类的信息NodeCount - operationId: host_GetPropertyNodeCount - 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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: 以关联的调度标签（ID或Name）过滤列表 - in: query - name: schedtag_id - type: string - x-go-name: SchedtagId - - description: 按调度标签名称排序 - in: query - name: order_by_schedtag - pattern: asc|desc - type: string - x-go-name: OrderBySchedtag - - description: 按调度标签资源类型排序 - in: query - name: order_by_resource_type - pattern: asc|desc - type: string - x-go-name: OrderByResourceType - - description: 存储（ID或Name） - in: query - name: storage_id - type: string - x-go-name: StorageId - - description: filter shared storage - in: query - name: share - type: boolean - x-go-name: Share - - description: filter local storage - in: query - name: local - type: boolean - x-go-name: Local - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: filter by ResourceType - in: query - name: resource_type - type: string - x-go-name: ResourceType - - description: filter by mac of any network interface - in: query - name: any_mac - type: string - x-go-name: AnyMac - - description: filter by ip of any network interface - in: query - name: any_ip - type: string - x-go-name: AnyIp - - description: filter storages not attached to this host - in: query - name: storage_not_attached - type: boolean - x-go-name: StorageNotAttached - - description: filter by Hypervisor - in: query - name: hypervisor - type: string - x-go-name: Hypervisor - - description: filter host that is empty - in: query - name: is_empty - type: boolean - x-go-name: IsEmpty - - description: filter host that is baremetal - in: query - name: baremetal - type: boolean - x-go-name: Baremetal - - description: 机架 - in: query - items: - type: string - name: rack - type: array - x-go-name: Rack - - description: 机位 - in: query - items: - type: string - name: slots - type: array - x-go-name: Slots - - description: 管理口MAC - in: query - items: - type: string - name: access_mac - type: array - x-go-name: AccessMac - - description: 管理口Ip地址 - in: query - items: - type: string - name: access_ip - type: array - x-go-name: AccessIp - - description: 物理机序列号信息 - in: query - items: - type: string - name: sn - type: array - x-go-name: SN - - description: CPU大小 - in: query - items: - format: int64 - type: integer - name: cpu_count - type: array - x-go-name: CpuCount - - description: 内存大小,单位Mb - in: query - items: - format: int64 - type: integer - name: mem_size - type: array - x-go-name: MemSize - - description: 存储类型 - in: query - items: - type: string - name: storage_type - type: array - x-go-name: StorageType - - description: IPMI地址 - in: query - items: - type: string - name: ipmi_ip - type: array - x-go-name: IpmiIp - - description: 宿主机状态 - example: online - in: query - items: - type: string - name: host_status - type: array - x-go-name: HostStatus - - description: 宿主机类型 - in: query - items: - type: string - name: host_type - type: array - x-go-name: HostType - - description: host服务软件版本 - in: query - items: - type: string - name: version - type: array - x-go-name: Version - - description: OVN软件版本 - in: query - items: - type: string - name: ovn_version - type: array - x-go-name: OvnVersion - - description: 是否处于维护状态 - in: query - name: is_maintenance - type: boolean - x-go-name: IsMaintenance - - description: 是否为导入的宿主机 - in: query - name: is_import - type: boolean - x-go-name: IsImport - - description: 是否允许PXE启动 - in: query - name: enable_pxe_boot - type: boolean - x-go-name: EnablePxeBoot - - description: 主机UUID - in: query - items: - type: string - name: uuid - type: array - x-go-name: Uuid - - description: 主机启动模式, 可能值位PXE和ISO - in: query - items: - type: string - name: boot_mode - type: array - x-go-name: BootMode - - description: 虚拟机所在的二层网络 - in: query - name: server_id_for_network - type: string - x-go-name: ServerIdForNetwork - - description: 宿主机 cpu 架构 - in: query - items: - type: string - name: cpu_architecture - type: array - x-go-name: CpuArchitecture - - in: query - name: os_arch - type: string - x-go-name: OsArch - - description: 按虚拟机数量排序 - enum: - - asc - - desc - in: query - name: order_by_server_count - type: string - x-go-name: OrderByServerCount - - description: |- - 按存储大小排序 - enmu: asc,desc - in: query - name: order_by_storage - pattern: asc|desc - type: string - x-go-name: OrderByStorage - - description: |- - 按存储超分率排序 - enmu: asc,desc - in: query - name: order_by_storage_commit_rate - type: string - x-go-name: OrderByStorageCommitRate - - description: |- - 按cpu超分率排序 - enmu: asc,desc - in: query - name: order_by_cpu_commit_rate - type: string - x-go-name: OrderByCpuCommitRate - - description: |- - 按内存超分率排序 - enmu: asc,desc - in: query - name: order_by_mem_commit_rate - type: string - x-go-name: OrderByMemCommitRate - responses: - "200": - $ref: '#/responses/host_GetPropertyNodeCountOutput' - summary: 获取指定资源类的信息NodeCount - tags: - - host - /hosts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: host_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - host: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/host_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - host - /hosts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: host_GetPropertySplitable - responses: - "200": - $ref: '#/responses/host_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - host - /hosts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: host_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/host_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - host - /hosts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: host_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/host_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - host - /hosts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: host_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/host_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - host - /hosts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: host_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/host_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - host - /hoststorages: - get: - description: 列表 - operationId: hoststorage_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 存储（ID或Name） - in: query - name: storage_id - type: string - x-go-name: StorageId - - description: 以存储名称排序 - in: query - name: order_by_storage - pattern: asc|desc - type: string - x-go-name: OrderByStorage - - description: filter shared storage - in: query - name: share - type: boolean - x-go-name: Share - - description: filter local storage - in: query - name: local - type: boolean - x-go-name: Local - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/hoststorage_ListItemFilterOutput' - summary: 列表 - tags: - - hoststorage - post: - description: 新建 - operationId: hoststorage_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - hoststorage: - $ref: '#/definitions/HostStorageCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/hoststorage_ValidateCreateDataOutput' - summary: 新建 - tags: - - hoststorage - /hoststorages/{id}: - delete: - description: 删除 - operationId: hoststorage_CustomizeDelete - parameters: - - description: The Id or Name of hoststorage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/hoststorage_CustomizeDeleteOutput' - summary: 删除 - tags: - - hoststorage - get: - description: 获取详情 - operationId: hoststorage_FetchCustomizeColumns - parameters: - - description: The Id or Name of hoststorage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/hoststorage_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - hoststorage - put: - description: 更新 - operationId: hoststorage_ValidateUpdateData - parameters: - - description: The Id or Name of hoststorage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - hoststorage: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/hoststorage_ValidateUpdateDataOutput' - summary: 更新 - tags: - - hoststorage - /hoststorages/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: hoststorage_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/hoststorage_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - hoststorage - /hoststorages/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: hoststorage_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - hoststorage: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/hoststorage_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - hoststorage - /hoststorages/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: hoststorage_GetPropertySplitable - responses: - "200": - $ref: '#/responses/hoststorage_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - hoststorage - /hoststorages/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: hoststorage_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/hoststorage_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - hoststorage - /hostwires: - get: - description: 列表 - operationId: hostwire_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: 网桥名称 - in: query - items: - type: string - name: bridge - type: array - x-go-name: Bridge - - description: 接口名称 - in: query - items: - type: string - name: interface - type: array - x-go-name: Interface - - description: 是否是主网口 - in: query - name: is_master - type: boolean - x-go-name: IsMaster - - description: MAC地址 - in: query - items: - type: string - name: mac_addr - type: array - x-go-name: MacAddr - responses: - "200": - $ref: '#/responses/hostwire_ListItemFilterOutput' - summary: 列表 - tags: - - hostwire - post: - description: 新建 - operationId: hostwire_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - hostwire: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/hostwire_ValidateCreateDataOutput' - summary: 新建 - tags: - - hostwire - /hostwires/{id}: - delete: - description: 删除 - operationId: hostwire_CustomizeDelete - parameters: - - description: The Id or Name of hostwire - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/hostwire_CustomizeDeleteOutput' - summary: 删除 - tags: - - hostwire - get: - description: 获取详情 - operationId: hostwire_FetchCustomizeColumns - parameters: - - description: The Id or Name of hostwire - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/hostwire_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - hostwire - put: - description: 更新 - operationId: hostwire_ValidateUpdateData - parameters: - - description: The Id or Name of hostwire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - hostwire: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/hostwire_ValidateUpdateDataOutput' - summary: 更新 - tags: - - hostwire - /hostwires/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: hostwire_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/hostwire_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - hostwire - /hostwires/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: hostwire_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - hostwire: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/hostwire_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - hostwire - /hostwires/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: hostwire_GetPropertySplitable - responses: - "200": - $ref: '#/responses/hostwire_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - hostwire - /hostwires/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: hostwire_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/hostwire_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - hostwire - /infras_quotas/domains: - get: - description: 获取所有域的基础设施配额 - operationId: models_ListInfrasQuotas - 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_ListInfrasQuotasOutput' - summary: 获取所有域的基础设施配额 - tags: - - infras_quota - /infras_quotas/domains/{domainId}: - get: - description: 获取指定域的基础设施配额 - operationId: models_GetInfrasQuota - 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_GetInfrasQuotaOutput' - summary: 获取指定域的基础设施配额 - tags: - - infras_quota - post: - description: 设置指定域的基础设施配额 - operationId: models_SetInfrasQuotas - parameters: - - description: 指定域的ID - in: path - name: domainId - required: true - type: string - x-go-name: DomainId - - in: body - name: body - schema: - properties: - infras_quotas: - $ref: '#/definitions/SetInfrasQuotaInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/models_SetInfrasQuotasOutput' - summary: 设置指定域的基础设施配额 - tags: - - infras_quota - /instance_backups: - get: - description: 列表 - operationId: instance_backup_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: |- - 通过操作系统架构过滤 - x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 - arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 - 其他的输入会过滤出以输入字符开头的资源 - enmu: x86, arm - in: query - name: os_arch - type: string - x-go-name: OsArch - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: 以主机名称排序 - in: query - name: order_by_server - type: string - x-go-name: OrderByServer - - description: 按虚拟机名称排序 - in: query - name: order_by_guest - pattern: asc|desc - type: string - x-go-name: OrderByGuest - - description: 操作系统类型 - in: query - items: - type: string - name: os_type - type: array - x-go-name: OsType - responses: - "200": - $ref: '#/responses/instance_backup_ListItemFilterOutput' - summary: 列表 - tags: - - instance_backup - post: - description: 新建 - operationId: instance_backup_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - instance_backup: - $ref: '#/definitions/InstanceBackupManagerCreateFromPackageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_ValidateCreateDataOutput' - summary: 新建 - tags: - - instance_backup - /instance_backups/{id}: - delete: - description: 删除 - operationId: instance_backup_CustomizeDelete - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_backup_CustomizeDeleteOutput' - summary: 删除 - tags: - - instance_backup - get: - description: 获取详情 - operationId: instance_backup_FetchCustomizeColumns - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_backup_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - instance_backup - put: - description: 更新 - operationId: instance_backup_ValidateUpdateData - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_ValidateUpdateDataOutput' - summary: 更新 - tags: - - instance_backup - /instance_backups/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: instance_backup_PerformCancelDelete - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_backup_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - instance_backup - /instance_backups/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: instance_backup_PerformChangeOwner - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - instance_backup - /instance_backups/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: instance_backup_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - instance_backup - /instance_backups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: instance_backup_GetDetailsClassMetadata - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_backup_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - instance_backup - post: - description: 执行操作ClassMetadata - operationId: instance_backup_PerformClassMetadata - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - instance_backup - /instance_backups/{id}/freeze: - post: - description: 执行操作Freeze - operationId: instance_backup_PerformFreeze - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - instance_backup - /instance_backups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: instance_backup_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 instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_backup_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - instance_backup - /instance_backups/{id}/pack: - post: - description: 执行操作Pack - operationId: instance_backup_PerformPack - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - $ref: '#/definitions/InstanceBackupPackInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformPackOutput' - summary: 执行操作Pack - tags: - - instance_backup - /instance_backups/{id}/recovery: - post: - description: 执行操作Recovery - operationId: instance_backup_PerformRecovery - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - $ref: '#/definitions/InstanceBackupRecoveryInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformRecoveryOutput' - summary: 执行操作Recovery - tags: - - instance_backup - /instance_backups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: instance_backup_PerformSetClassMetadata - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - instance_backup - /instance_backups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: instance_backup_PerformSetUserMetadata - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - instance_backup - /instance_backups/{id}/status: - get: - description: 获取指定信息Status - operationId: instance_backup_GetDetailsStatus - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_backup_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - instance_backup - post: - description: 执行操作Status - operationId: instance_backup_PerformStatus - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformStatusOutput' - summary: 更新资源状态 - tags: - - instance_backup - /instance_backups/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: instance_backup_PerformSyncstatus - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - $ref: '#/definitions/InstanceBackupManagerSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - instance_backup - /instance_backups/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: instance_backup_PerformUnfreeze - parameters: - - description: The Id or Name of instance_backup - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_backup: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - instance_backup - /instance_backups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: instance_backup_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/instance_backup_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - instance_backup - /instance_backups/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: instance_backup_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/instance_backup_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - instance_backup - /instance_backups/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: instance_backup_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/instance_backup_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - instance_backup - /instance_backups/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: instance_backup_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/instance_backup_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - instance_backup - /instance_backups/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: instance_backup_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/instance_backup_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - instance_backup - /instance_backups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: instance_backup_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - instance_backup: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_backup_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - instance_backup - /instance_backups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: instance_backup_GetPropertySplitable - responses: - "200": - $ref: '#/responses/instance_backup_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - instance_backup - /instance_backups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: instance_backup_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/instance_backup_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - instance_backup - /instance_backups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: instance_backup_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/instance_backup_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - instance_backup - /instance_backups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: instance_backup_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/instance_backup_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - instance_backup - /instance_backups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: instance_backup_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/instance_backup_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - instance_backup - /instance_snapshots: - get: - description: 列表 - operationId: instance_snapshot_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: |- - 通过操作系统架构过滤 - x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 - arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 - 其他的输入会过滤出以输入字符开头的资源 - enmu: x86, arm - in: query - name: os_arch - type: string - x-go-name: OsArch - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: 以主机名称排序 - in: query - name: order_by_server - type: string - x-go-name: OrderByServer - - description: 操作系统类型 - in: query - items: - type: string - name: os_type - type: array - x-go-name: OsType - - description: 包含内存快照 - in: query - name: with_memory - type: boolean - x-go-name: WithMemory - - description: 按磁盘快照数量排序 - in: query - name: order_by_disk_snapshot_count - pattern: asc|desc - type: string - x-go-name: OrderByDiskSnapshotCount - - description: 按虚拟机名称排序 - in: query - name: order_by_guest - pattern: asc|desc - type: string - x-go-name: OrderByGuest - responses: - "200": - $ref: '#/responses/instance_snapshot_ListItemFilterOutput' - summary: 主机快照列表 - tags: - - instance_snapshot - post: - description: 新建 - operationId: instance_snapshot_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - instance_snapshot: - $ref: '#/definitions/VirtualResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_ValidateCreateDataOutput' - summary: 新建 - tags: - - instance_snapshot - /instance_snapshots/{id}: - delete: - description: 删除 - operationId: instance_snapshot_CustomizeDelete - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_snapshot_CustomizeDeleteOutput' - summary: 删除 - tags: - - instance_snapshot - get: - description: 获取详情 - operationId: instance_snapshot_FetchCustomizeColumns - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_snapshot_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - instance_snapshot - put: - description: 更新 - operationId: instance_snapshot_ValidateUpdateData - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_snapshot: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_ValidateUpdateDataOutput' - summary: 更新 - tags: - - instance_snapshot - /instance_snapshots/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: instance_snapshot_PerformCancelDelete - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_snapshot_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - instance_snapshot - /instance_snapshots/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: instance_snapshot_PerformChangeOwner - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_snapshot: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - instance_snapshot - /instance_snapshots/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: instance_snapshot_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_snapshot_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - instance_snapshot - /instance_snapshots/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: instance_snapshot_GetDetailsClassMetadata - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_snapshot_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - instance_snapshot - post: - description: 执行操作ClassMetadata - operationId: instance_snapshot_PerformClassMetadata - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_snapshot: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - instance_snapshot - /instance_snapshots/{id}/freeze: - post: - description: 执行操作Freeze - operationId: instance_snapshot_PerformFreeze - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_snapshot: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - instance_snapshot - /instance_snapshots/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: instance_snapshot_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 instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_snapshot_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - instance_snapshot - /instance_snapshots/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: instance_snapshot_PerformSetClassMetadata - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_snapshot: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - instance_snapshot - /instance_snapshots/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: instance_snapshot_PerformSetUserMetadata - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_snapshot: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - instance_snapshot - /instance_snapshots/{id}/status: - get: - description: 获取指定信息Status - operationId: instance_snapshot_GetDetailsStatus - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/instance_snapshot_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - instance_snapshot - post: - description: 执行操作Status - operationId: instance_snapshot_PerformStatus - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_snapshot: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_PerformStatusOutput' - summary: 更新资源状态 - tags: - - instance_snapshot - /instance_snapshots/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: instance_snapshot_PerformUnfreeze - parameters: - - description: The Id or Name of instance_snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - instance_snapshot: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - instance_snapshot - /instance_snapshots/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: instance_snapshot_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/instance_snapshot_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - instance_snapshot - /instance_snapshots/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: instance_snapshot_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/instance_snapshot_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - instance_snapshot - /instance_snapshots/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: instance_snapshot_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/instance_snapshot_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - instance_snapshot - /instance_snapshots/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: instance_snapshot_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/instance_snapshot_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - instance_snapshot - /instance_snapshots/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: instance_snapshot_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/instance_snapshot_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - instance_snapshot - /instance_snapshots/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: instance_snapshot_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - instance_snapshot: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/instance_snapshot_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - instance_snapshot - /instance_snapshots/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: instance_snapshot_GetPropertySplitable - responses: - "200": - $ref: '#/responses/instance_snapshot_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - instance_snapshot - /instance_snapshots/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: instance_snapshot_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/instance_snapshot_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - instance_snapshot - /instance_snapshots/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: instance_snapshot_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/instance_snapshot_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - instance_snapshot - /instance_snapshots/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: instance_snapshot_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/instance_snapshot_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - instance_snapshot - /instance_snapshots/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: instance_snapshot_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/instance_snapshot_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - instance_snapshot - /inter_vpc_network_route_sets: - get: - description: 列表 - operationId: inter_vpc_network_route_set_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - in: query - name: InterVpcNetworkId - type: string - - in: query - name: cidr - type: string - x-go-name: Cidr - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_ListItemFilterOutput' - summary: 列表 - tags: - - inter_vpc_network_route_set - post: - description: 新建 - operationId: inter_vpc_network_route_set_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - inter_vpc_network_route_set: - $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_ValidateCreateDataOutput' - summary: 新建 - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/{id}: - delete: - description: 删除 - operationId: inter_vpc_network_route_set_CustomizeDelete - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_CustomizeDeleteOutput' - summary: 删除 - tags: - - inter_vpc_network_route_set - get: - description: 获取详情 - operationId: inter_vpc_network_route_set_FetchCustomizeColumns - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - inter_vpc_network_route_set - put: - description: 更新 - operationId: inter_vpc_network_route_set_ValidateUpdateData - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_ValidateUpdateDataOutput' - summary: 更新 - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: inter_vpc_network_route_set_GetDetailsClassMetadata - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - inter_vpc_network_route_set - post: - description: 执行操作ClassMetadata - operationId: inter_vpc_network_route_set_PerformClassMetadata - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network_route_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/{id}/disable: - post: - description: 执行操作Disable - operationId: inter_vpc_network_route_set_PerformDisable - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/InterVpcNetworkRouteSetDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_PerformDisableOutput' - summary: 执行操作Disable - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/{id}/enable: - post: - description: 执行操作Enable - operationId: inter_vpc_network_route_set_PerformEnable - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/InterVpcNetworkRouteSetEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_PerformEnableOutput' - summary: 执行操作Enable - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: inter_vpc_network_route_set_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 inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: inter_vpc_network_route_set_PerformSetClassMetadata - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network_route_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: inter_vpc_network_route_set_PerformSetUserMetadata - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network_route_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/{id}/status: - get: - description: 获取指定信息Status - operationId: inter_vpc_network_route_set_GetDetailsStatus - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - inter_vpc_network_route_set - post: - description: 执行操作Status - operationId: inter_vpc_network_route_set_PerformStatus - parameters: - - description: The Id or Name of inter_vpc_network_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_PerformStatusOutput' - summary: 更新资源状态 - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: inter_vpc_network_route_set_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: inter_vpc_network_route_set_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: inter_vpc_network_route_set_GetPropertySplitable - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: inter_vpc_network_route_set_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/inter_vpc_network_route_set_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: inter_vpc_network_route_set_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: inter_vpc_network_route_set_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - inter_vpc_network_route_set - /inter_vpc_network_route_sets/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: inter_vpc_network_route_set_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/inter_vpc_network_route_set_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - inter_vpc_network_route_set - /inter_vpc_network_vpcs: - get: - description: 列表 - operationId: inter_vpc_network_vpc_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/inter_vpc_network_vpc_ListItemFilterOutput' - summary: 列表 - tags: - - inter_vpc_network_vpc - post: - description: 新建 - operationId: inter_vpc_network_vpc_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - inter_vpc_network_vpc: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_vpc_ValidateCreateDataOutput' - summary: 新建 - tags: - - inter_vpc_network_vpc - /inter_vpc_network_vpcs/{id}: - delete: - description: 删除 - operationId: inter_vpc_network_vpc_CustomizeDelete - parameters: - - description: The Id or Name of inter_vpc_network_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_vpc_CustomizeDeleteOutput' - summary: 删除 - tags: - - inter_vpc_network_vpc - get: - description: 获取详情 - operationId: inter_vpc_network_vpc_FetchCustomizeColumns - parameters: - - description: The Id or Name of inter_vpc_network_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_vpc_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - inter_vpc_network_vpc - put: - description: 更新 - operationId: inter_vpc_network_vpc_ValidateUpdateData - parameters: - - description: The Id or Name of inter_vpc_network_vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network_vpc: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_vpc_ValidateUpdateDataOutput' - summary: 更新 - tags: - - inter_vpc_network_vpc - /inter_vpc_network_vpcs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: inter_vpc_network_vpc_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/inter_vpc_network_vpc_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - inter_vpc_network_vpc - /inter_vpc_network_vpcs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: inter_vpc_network_vpc_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - inter_vpc_network_vpc: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_vpc_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - inter_vpc_network_vpc - /inter_vpc_network_vpcs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: inter_vpc_network_vpc_GetPropertySplitable - responses: - "200": - $ref: '#/responses/inter_vpc_network_vpc_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - inter_vpc_network_vpc - /inter_vpc_network_vpcs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: inter_vpc_network_vpc_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/inter_vpc_network_vpc_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - inter_vpc_network_vpc - /inter_vpc_networks: - get: - description: 列表 - operationId: inter_vpc_network_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/inter_vpc_network_ListItemFilterOutput' - summary: 列表 - tags: - - inter_vpc_network - post: - description: 新建 - operationId: inter_vpc_network_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - inter_vpc_network: - $ref: '#/definitions/InterVpcNetworkCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_ValidateCreateDataOutput' - summary: 新建 - tags: - - inter_vpc_network - /inter_vpc_networks/{id}: - delete: - description: 删除 - operationId: inter_vpc_network_CustomizeDelete - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_CustomizeDeleteOutput' - summary: 删除 - tags: - - inter_vpc_network - get: - description: 获取详情 - operationId: inter_vpc_network_FetchCustomizeColumns - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - inter_vpc_network - put: - description: 更新 - operationId: inter_vpc_network_ValidateUpdateData - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_ValidateUpdateDataOutput' - summary: 更新 - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/addvpc: - post: - description: 执行操作Addvpc - operationId: inter_vpc_network_PerformAddvpc - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/InterVpcNetworkAddVpcInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformAddvpcOutput' - summary: 执行操作Addvpc - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: inter_vpc_network_PerformChangeOwner - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: inter_vpc_network_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: inter_vpc_network_GetDetailsClassMetadata - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - inter_vpc_network - post: - description: 执行操作ClassMetadata - operationId: inter_vpc_network_PerformClassMetadata - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/disable: - post: - description: 执行操作Disable - operationId: inter_vpc_network_PerformDisable - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformDisableOutput' - summary: 禁用资源 - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/enable: - post: - description: 执行操作Enable - operationId: inter_vpc_network_PerformEnable - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformEnableOutput' - summary: 启用资源 - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: inter_vpc_network_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 inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/private: - post: - description: 执行操作Private - operationId: inter_vpc_network_PerformPrivate - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformPrivateOutput' - summary: 执行操作Private - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/public: - post: - description: 执行操作Public - operationId: inter_vpc_network_PerformPublic - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformPublicOutput' - summary: 执行操作Public - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/removevpc: - post: - description: 执行操作Removevpc - operationId: inter_vpc_network_PerformRemovevpc - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/InterVpcNetworkRemoveVpcInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformRemovevpcOutput' - summary: 执行操作Removevpc - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: inter_vpc_network_PerformSetClassMetadata - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: inter_vpc_network_PerformSetUserMetadata - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/status: - get: - description: 获取指定信息Status - operationId: inter_vpc_network_GetDetailsStatus - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - inter_vpc_network - post: - description: 执行操作Status - operationId: inter_vpc_network_PerformStatus - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformStatusOutput' - summary: 更新资源状态 - tags: - - inter_vpc_network - /inter_vpc_networks/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: inter_vpc_network_PerformSyncstatus - parameters: - - description: The Id or Name of inter_vpc_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/InterVpcNetworkSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - inter_vpc_network - /inter_vpc_networks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: inter_vpc_network_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - inter_vpc_network - /inter_vpc_networks/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: inter_vpc_network_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - inter_vpc_network - /inter_vpc_networks/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: inter_vpc_network_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - inter_vpc_network - /inter_vpc_networks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: inter_vpc_network_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/inter_vpc_network_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - inter_vpc_network - /inter_vpc_networks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: inter_vpc_network_GetPropertySplitable - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - inter_vpc_network - /inter_vpc_networks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: inter_vpc_network_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/inter_vpc_network_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - inter_vpc_network - /inter_vpc_networks/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: inter_vpc_network_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - inter_vpc_network - /inter_vpc_networks/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: inter_vpc_network_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - inter_vpc_network - /inter_vpc_networks/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: inter_vpc_network_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/inter_vpc_network_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - inter_vpc_network - /ipv6_gateways: - get: - description: 列表 - operationId: ipv6_gateway_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/ipv6_gateway_ListItemFilterOutput' - summary: IPv6网关列表 - tags: - - ipv6_gateway - post: - description: 新建 - operationId: ipv6_gateway_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - ipv6_gateway: - $ref: '#/definitions/IPv6GatewayCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_ValidateCreateDataOutput' - summary: 新建 - tags: - - ipv6_gateway - /ipv6_gateways/{id}: - delete: - description: 删除 - operationId: ipv6_gateway_CustomizeDelete - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/ipv6_gateway_CustomizeDeleteOutput' - summary: 删除 - tags: - - ipv6_gateway - get: - description: 获取详情 - operationId: ipv6_gateway_FetchCustomizeColumns - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/ipv6_gateway_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - ipv6_gateway - put: - description: 更新 - operationId: ipv6_gateway_ValidateUpdateData - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/IPv6GatewayUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_ValidateUpdateDataOutput' - summary: 更新 - tags: - - ipv6_gateway - /ipv6_gateways/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: ipv6_gateway_PerformCancelDelete - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - ipv6_gateway - /ipv6_gateways/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: ipv6_gateway_PerformChangeOwner - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - ipv6_gateway - /ipv6_gateways/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: ipv6_gateway_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - ipv6_gateway - /ipv6_gateways/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: ipv6_gateway_GetDetailsClassMetadata - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - ipv6_gateway - post: - description: 执行操作ClassMetadata - operationId: ipv6_gateway_PerformClassMetadata - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - ipv6_gateway - /ipv6_gateways/{id}/freeze: - post: - description: 执行操作Freeze - operationId: ipv6_gateway_PerformFreeze - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - ipv6_gateway - /ipv6_gateways/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: ipv6_gateway_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 ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - ipv6_gateway - /ipv6_gateways/{id}/private: - post: - description: 执行操作Private - operationId: ipv6_gateway_PerformPrivate - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformPrivateOutput' - summary: 执行操作Private - tags: - - ipv6_gateway - /ipv6_gateways/{id}/public: - post: - description: 执行操作Public - operationId: ipv6_gateway_PerformPublic - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformPublicOutput' - summary: 执行操作Public - tags: - - ipv6_gateway - /ipv6_gateways/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: ipv6_gateway_PerformSetClassMetadata - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - ipv6_gateway - /ipv6_gateways/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: ipv6_gateway_PerformSetUserMetadata - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - ipv6_gateway - /ipv6_gateways/{id}/status: - get: - description: 获取指定信息Status - operationId: ipv6_gateway_GetDetailsStatus - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - ipv6_gateway - post: - description: 执行操作Status - operationId: ipv6_gateway_PerformStatus - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformStatusOutput' - summary: 更新资源状态 - tags: - - ipv6_gateway - /ipv6_gateways/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: ipv6_gateway_PerformUnfreeze - parameters: - - description: The Id or Name of ipv6_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - ipv6_gateway - /ipv6_gateways/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: ipv6_gateway_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - ipv6_gateway - /ipv6_gateways/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: ipv6_gateway_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - ipv6_gateway - /ipv6_gateways/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: ipv6_gateway_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - ipv6_gateway - /ipv6_gateways/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: ipv6_gateway_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - ipv6_gateway - /ipv6_gateways/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: ipv6_gateway_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - ipv6_gateway - /ipv6_gateways/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: ipv6_gateway_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/ipv6_gateway_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - ipv6_gateway - /ipv6_gateways/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: ipv6_gateway_GetPropertySplitable - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - ipv6_gateway - /ipv6_gateways/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: ipv6_gateway_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/ipv6_gateway_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - ipv6_gateway - /ipv6_gateways/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: ipv6_gateway_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - ipv6_gateway - /ipv6_gateways/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: ipv6_gateway_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - ipv6_gateway - /ipv6_gateways/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: ipv6_gateway_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/ipv6_gateway_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - ipv6_gateway - /isolated_device_models: - get: - description: 列表 - operationId: isolated_device_model_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: 设备类型 - example: NPU - in: query - items: - type: string - name: dev_type - type: array - x-go-name: DevType - - description: 设备型号 - in: query - items: - type: string - name: model - type: array - x-go-name: Model - - description: 设备VendorId - in: query - name: vendor_id - type: string - x-go-name: VendorId - - description: 设备DeviceId - in: query - name: device_id - type: string - x-go-name: DeviceId - - description: 支持热插拔 HotPluggable - in: query - name: hot_pluggable - type: boolean - x-go-name: HotPluggable - responses: - "200": - $ref: '#/responses/isolated_device_model_ListItemFilterOutput' - summary: 列表 - tags: - - isolated_device_model - post: - description: 新建 - operationId: isolated_device_model_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - isolated_device_model: - $ref: '#/definitions/IsolatedDeviceModelCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_model_ValidateCreateDataOutput' - summary: 新建 - tags: - - isolated_device_model - /isolated_device_models/{id}: - delete: - description: 删除 - operationId: isolated_device_model_CustomizeDelete - parameters: - - description: The Id or Name of isolated_device_model - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/isolated_device_model_CustomizeDeleteOutput' - summary: 删除 - tags: - - isolated_device_model - get: - description: 获取详情 - operationId: isolated_device_model_FetchCustomizeColumns - parameters: - - description: The Id or Name of isolated_device_model - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/isolated_device_model_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - isolated_device_model - put: - description: 更新 - operationId: isolated_device_model_ValidateUpdateData - parameters: - - description: The Id or Name of isolated_device_model - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - isolated_device_model: - $ref: '#/definitions/IsolatedDeviceModelUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_model_ValidateUpdateDataOutput' - summary: 更新 - tags: - - isolated_device_model - /isolated_device_models/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: isolated_device_model_GetDetailsClassMetadata - parameters: - - description: The Id or Name of isolated_device_model - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/isolated_device_model_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - isolated_device_model - post: - description: 执行操作ClassMetadata - operationId: isolated_device_model_PerformClassMetadata - parameters: - - description: The Id or Name of isolated_device_model - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - isolated_device_model: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_model_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - isolated_device_model - /isolated_device_models/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: isolated_device_model_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 isolated_device_model - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/isolated_device_model_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - isolated_device_model - /isolated_device_models/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: isolated_device_model_PerformSetClassMetadata - parameters: - - description: The Id or Name of isolated_device_model - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - isolated_device_model: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_model_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - isolated_device_model - /isolated_device_models/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: isolated_device_model_PerformSetUserMetadata - parameters: - - description: The Id or Name of isolated_device_model - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - isolated_device_model: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_model_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - isolated_device_model - /isolated_device_models/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: isolated_device_model_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/isolated_device_model_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - isolated_device_model - /isolated_device_models/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: isolated_device_model_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - isolated_device_model: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_model_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - isolated_device_model - /isolated_device_models/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: isolated_device_model_GetPropertySplitable - responses: - "200": - $ref: '#/responses/isolated_device_model_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - isolated_device_model - /isolated_device_models/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: isolated_device_model_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/isolated_device_model_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - isolated_device_model - /isolated_device_models/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: isolated_device_model_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/isolated_device_model_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - isolated_device_model - /isolated_device_models/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: isolated_device_model_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/isolated_device_model_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - isolated_device_model - /isolated_devices: - get: - description: 列表 - operationId: isolated_device_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: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 只列出GPU直通设备 - in: query - name: gpu - type: boolean - x-go-name: Gpu - - description: 只列出USB直通设备 - in: query - name: usb - type: boolean - x-go-name: Usb - - description: 只列出未使用的直通设备 - in: query - name: unused - type: boolean - x-go-name: Unused - - description: |- - # PCI / GPU-HPC / GPU-VGA / USB / NIC - 设备类型 - in: query - items: - type: string - name: dev_type - type: array - x-go-name: DevType - - description: '# Specific device name read from lspci command, e.g. `Tesla - K40m` ...' - in: query - items: - type: string - name: model - type: array - x-go-name: Model - - description: '# pci address of `Bus:Device.Function` format, or usb bus address - of `bus.addr`' - in: query - items: - type: string - name: addr - type: array - x-go-name: Addr - - description: 设备VENDOE编号 - in: query - items: - type: string - name: vendor_device_id - type: array - x-go-name: VendorDeviceId - - description: 展示物理机的上的设备 - in: query - name: show_baremetal_isolated_devices - type: boolean - x-go-name: ShowBaremetalIsolatedDevices - - description: 列出虚拟机上挂载的设备 - in: query - name: guest_id - type: string - x-go-name: GuestId - responses: - "200": - $ref: '#/responses/isolated_device_ListItemFilterOutput' - summary: 直通设备（GPU等）列表 - tags: - - isolated_device - post: - description: 新建 - operationId: isolated_device_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - isolated_device: - $ref: '#/definitions/IsolatedDeviceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_ValidateCreateDataOutput' - summary: 新建 - tags: - - isolated_device - /isolated_devices/{id}: - delete: - description: 删除 - operationId: isolated_device_CustomizeDelete - parameters: - - description: The Id or Name of isolated_device - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/isolated_device_CustomizeDeleteOutput' - summary: 删除 - tags: - - isolated_device - get: - description: 获取详情 - operationId: isolated_device_FetchCustomizeColumns - parameters: - - description: The Id or Name of isolated_device - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/isolated_device_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - isolated_device - put: - description: 更新 - operationId: isolated_device_ValidateUpdateData - parameters: - - description: The Id or Name of isolated_device - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - isolated_device: - $ref: '#/definitions/IsolatedDeviceUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_ValidateUpdateDataOutput' - summary: 更新 - tags: - - isolated_device - /isolated_devices/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: isolated_device_GetDetailsClassMetadata - parameters: - - description: The Id or Name of isolated_device - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/isolated_device_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - isolated_device - post: - description: 执行操作ClassMetadata - operationId: isolated_device_PerformClassMetadata - parameters: - - description: The Id or Name of isolated_device - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - isolated_device: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - isolated_device - /isolated_devices/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: isolated_device_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 isolated_device - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/isolated_device_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - isolated_device - /isolated_devices/{id}/purge: - post: - description: 执行操作Purge - operationId: isolated_device_PerformPurge - parameters: - - description: The Id or Name of isolated_device - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/isolated_device_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - isolated_device - /isolated_devices/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: isolated_device_PerformSetClassMetadata - parameters: - - description: The Id or Name of isolated_device - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - isolated_device: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - isolated_device - /isolated_devices/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: isolated_device_PerformSetUserMetadata - parameters: - - description: The Id or Name of isolated_device - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - isolated_device: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - isolated_device - /isolated_devices/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: isolated_device_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/isolated_device_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - isolated_device - /isolated_devices/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: isolated_device_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - isolated_device: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/isolated_device_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - isolated_device - /isolated_devices/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: isolated_device_GetPropertySplitable - responses: - "200": - $ref: '#/responses/isolated_device_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - isolated_device - /isolated_devices/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: isolated_device_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/isolated_device_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - isolated_device - /isolated_devices/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: isolated_device_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/isolated_device_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - isolated_device - /isolated_devices/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: isolated_device_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/isolated_device_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - isolated_device - /kafkas: - get: - description: 列表 - operationId: kafka_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 是否禁止删除 - in: query - name: disable_delete - type: boolean - x-go-name: DisableDelete - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/kafka_ListItemFilterOutput' - summary: Kafka实例列表 - tags: - - kafka - post: - description: 新建 - operationId: kafka_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - kafka: - $ref: '#/definitions/KafkaCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_ValidateCreateDataOutput' - summary: 新建 - tags: - - kafka - /kafkas/{id}: - delete: - description: 删除 - operationId: kafka_CustomizeDelete - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kafka_CustomizeDeleteOutput' - summary: 删除 - tags: - - kafka - get: - description: 获取详情 - operationId: kafka_FetchCustomizeColumns - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kafka_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - kafka - put: - description: 更新 - operationId: kafka_ValidateUpdateData - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kafka: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_ValidateUpdateDataOutput' - summary: 更新 - tags: - - kafka - /kafkas/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: kafka_PerformCancelDelete - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kafka_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - kafka - /kafkas/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: kafka_PerformChangeOwner - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kafka: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - kafka - /kafkas/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: kafka_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kafka_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - kafka - /kafkas/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: kafka_GetDetailsClassMetadata - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kafka_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - kafka - post: - description: 执行操作ClassMetadata - operationId: kafka_PerformClassMetadata - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kafka: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - kafka - /kafkas/{id}/freeze: - post: - description: 执行操作Freeze - operationId: kafka_PerformFreeze - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kafka: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - kafka - /kafkas/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: kafka_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 kafka - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kafka_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - kafka - /kafkas/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: kafka_PerformSetClassMetadata - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kafka: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - kafka - /kafkas/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: kafka_PerformSetUserMetadata - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kafka: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - kafka - /kafkas/{id}/status: - get: - description: 获取指定信息Status - operationId: kafka_GetDetailsStatus - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kafka_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - kafka - post: - description: 执行操作Status - operationId: kafka_PerformStatus - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kafka: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_PerformStatusOutput' - summary: 更新资源状态 - tags: - - kafka - /kafkas/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: kafka_PerformSyncstatus - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kafka_PerformSyncstatusOutput' - summary: 同步Kafka实例状态 - tags: - - kafka - /kafkas/{id}/topics: - get: - description: 获取指定信息Topics - operationId: kafka_GetDetailsTopics - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kafka_GetDetailsTopicsOutput' - summary: 获取Kafka Topic列表 - tags: - - kafka - /kafkas/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: kafka_PerformUnfreeze - parameters: - - description: The Id or Name of kafka - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kafka: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - kafka - /kafkas/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: kafka_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/kafka_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - kafka - /kafkas/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: kafka_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/kafka_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - kafka - /kafkas/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: kafka_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/kafka_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - kafka - /kafkas/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: kafka_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/kafka_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - kafka - /kafkas/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: kafka_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/kafka_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - kafka - /kafkas/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: kafka_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - kafka: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kafka_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - kafka - /kafkas/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: kafka_GetPropertySplitable - responses: - "200": - $ref: '#/responses/kafka_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - kafka - /kafkas/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: kafka_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/kafka_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - kafka - /kafkas/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: kafka_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/kafka_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - kafka - /kafkas/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: kafka_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/kafka_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - kafka - /kafkas/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: kafka_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/kafka_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - kafka - /keypairs: - get: - description: 列表 - operationId: keypair_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: user_id - type: string - x-go-name: UserId - - description: 加密类型 - example: RSA - in: query - items: - type: string - name: scheme - type: array - x-go-name: Scheme - - description: 指纹信息 - example: 1d:3a:83:4a:a1:f3:75:97:ec:d1:ef:f8:3f:a7:5d:9e - in: query - items: - type: string - name: fingerprint - type: array - x-go-name: Fingerprint - responses: - "200": - $ref: '#/responses/keypair_ListItemFilterOutput' - summary: 列出ssh密钥对 - tags: - - keypair - post: - description: 新建 - operationId: keypair_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - keypair: - $ref: '#/definitions/KeypairCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/keypair_ValidateCreateDataOutput' - summary: 新建 - tags: - - keypair - /keypairs/{id}: - delete: - description: 删除 - operationId: keypair_CustomizeDelete - parameters: - - description: The Id or Name of keypair - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/keypair_CustomizeDeleteOutput' - summary: 删除 - tags: - - keypair - get: - description: 获取详情 - operationId: keypair_FetchCustomizeColumns - parameters: - - description: The Id or Name of keypair - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/keypair_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - keypair - put: - description: 更新 - operationId: keypair_ValidateUpdateData - parameters: - - description: The Id or Name of keypair - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - keypair: - $ref: '#/definitions/StandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/keypair_ValidateUpdateDataOutput' - summary: 更新 - tags: - - keypair - /keypairs/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: keypair_GetDetailsClassMetadata - parameters: - - description: The Id or Name of keypair - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/keypair_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - keypair - post: - description: 执行操作ClassMetadata - operationId: keypair_PerformClassMetadata - parameters: - - description: The Id or Name of keypair - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - keypair: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/keypair_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - keypair - /keypairs/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: keypair_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 keypair - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/keypair_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - keypair - /keypairs/{id}/privatekey: - get: - description: 获取指定信息Privatekey - operationId: keypair_GetDetailsPrivatekey - parameters: - - description: The Id or Name of keypair - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/keypair_GetDetailsPrivatekeyOutput' - summary: 获取指定信息Privatekey - tags: - - keypair - /keypairs/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: keypair_PerformSetClassMetadata - parameters: - - description: The Id or Name of keypair - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - keypair: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/keypair_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - keypair - /keypairs/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: keypair_PerformSetUserMetadata - parameters: - - description: The Id or Name of keypair - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - keypair: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/keypair_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - keypair - /keypairs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: keypair_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/keypair_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - keypair - /keypairs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: keypair_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - keypair: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/keypair_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - keypair - /keypairs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: keypair_GetPropertySplitable - responses: - "200": - $ref: '#/responses/keypair_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - keypair - /keypairs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: keypair_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/keypair_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - keypair - /keypairs/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: keypair_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/keypair_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - keypair - /keypairs/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: keypair_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/keypair_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - keypair - /kube_clusters: - get: - description: 列表 - operationId: kube_cluster_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/kube_cluster_ListItemFilterOutput' - summary: 列出Kube Cluster - tags: - - kube_cluster - post: - description: 新建 - operationId: kube_cluster_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - kube_cluster: - $ref: '#/definitions/KubeClusterCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_ValidateCreateDataOutput' - summary: 新建 - tags: - - kube_cluster - /kube_clusters/{id}: - delete: - description: 删除 - operationId: kube_cluster_CustomizeDelete - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/KubeClusterDeleteInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_CustomizeDeleteOutput' - summary: 删除 - tags: - - kube_cluster - get: - description: 获取详情 - operationId: kube_cluster_FetchCustomizeColumns - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_cluster_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - kube_cluster - put: - description: 更新 - operationId: kube_cluster_ValidateUpdateData - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/KubeClusterUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_ValidateUpdateDataOutput' - summary: 更新 - tags: - - kube_cluster - /kube_clusters/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: kube_cluster_PerformChangeOwner - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - kube_cluster - /kube_clusters/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: kube_cluster_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_cluster_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - kube_cluster - /kube_clusters/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: kube_cluster_GetDetailsClassMetadata - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_cluster_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - kube_cluster - post: - description: 执行操作ClassMetadata - operationId: kube_cluster_PerformClassMetadata - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - kube_cluster - /kube_clusters/{id}/disable: - post: - description: 执行操作Disable - operationId: kube_cluster_PerformDisable - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformDisableOutput' - summary: 禁用资源 - tags: - - kube_cluster - /kube_clusters/{id}/enable: - post: - description: 执行操作Enable - operationId: kube_cluster_PerformEnable - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformEnableOutput' - summary: 启用资源 - tags: - - kube_cluster - /kube_clusters/{id}/kubeconfig: - get: - description: 获取指定信息Kubeconfig - operationId: kube_cluster_GetDetailsKubeconfig - parameters: - - description: 是否获取内网kubeconfig, 默认false即获取外网kubeconfig - in: query - name: private - type: boolean - x-go-name: Private - - description: |- - kubeconfig 到期时间 - 阿里云: 15（15分钟）～4320（3天） - 腾讯云不传此参数默认时效是20年 - format: int64 - in: query - name: expire_minutes - type: integer - x-go-name: ExpireMinutes - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_cluster_GetDetailsKubeconfigOutput' - summary: 获取指定信息Kubeconfig - tags: - - kube_cluster - /kube_clusters/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: kube_cluster_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 kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_cluster_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - kube_cluster - /kube_clusters/{id}/private: - post: - description: 执行操作Private - operationId: kube_cluster_PerformPrivate - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformPrivateOutput' - summary: 执行操作Private - tags: - - kube_cluster - /kube_clusters/{id}/public: - post: - description: 执行操作Public - operationId: kube_cluster_PerformPublic - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformPublicOutput' - summary: 执行操作Public - tags: - - kube_cluster - /kube_clusters/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: kube_cluster_PerformSetClassMetadata - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - kube_cluster - /kube_clusters/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: kube_cluster_PerformSetUserMetadata - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - kube_cluster - /kube_clusters/{id}/status: - get: - description: 获取指定信息Status - operationId: kube_cluster_GetDetailsStatus - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_cluster_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - kube_cluster - post: - description: 执行操作Status - operationId: kube_cluster_PerformStatus - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformStatusOutput' - summary: 更新资源状态 - tags: - - kube_cluster - /kube_clusters/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: kube_cluster_PerformSyncstatus - parameters: - - description: The Id or Name of kube_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/SyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformSyncstatusOutput' - summary: 同步Kube Cluster状态 - tags: - - kube_cluster - /kube_clusters/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: kube_cluster_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/kube_cluster_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - kube_cluster - /kube_clusters/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: kube_cluster_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/kube_cluster_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - kube_cluster - /kube_clusters/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: kube_cluster_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/kube_cluster_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - kube_cluster - /kube_clusters/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: kube_cluster_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - kube_cluster: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_cluster_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - kube_cluster - /kube_clusters/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: kube_cluster_GetPropertySplitable - responses: - "200": - $ref: '#/responses/kube_cluster_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - kube_cluster - /kube_clusters/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: kube_cluster_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/kube_cluster_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - kube_cluster - /kube_clusters/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: kube_cluster_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/kube_cluster_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - kube_cluster - /kube_clusters/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: kube_cluster_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/kube_cluster_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - kube_cluster - /kube_clusters/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: kube_cluster_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/kube_cluster_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - kube_cluster - /kube_node_pools: - get: - description: 列表 - operationId: kube_node_pool_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - in: query - name: cloud_kube_cluster_id - type: string - x-go-name: CloudKubeClusterId - responses: - "200": - $ref: '#/responses/kube_node_pool_ListItemFilterOutput' - summary: Kube Node Pool列表 - tags: - - kube_node_pool - post: - description: 新建 - operationId: kube_node_pool_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - kube_node_pool: - $ref: '#/definitions/KubeNodePoolCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_pool_ValidateCreateDataOutput' - summary: 新建 - tags: - - kube_node_pool - /kube_node_pools/{id}: - delete: - description: 删除 - operationId: kube_node_pool_CustomizeDelete - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_pool_CustomizeDeleteOutput' - summary: 删除 - tags: - - kube_node_pool - get: - description: 获取详情 - operationId: kube_node_pool_FetchCustomizeColumns - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_pool_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - kube_node_pool - put: - description: 更新 - operationId: kube_node_pool_ValidateUpdateData - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node_pool: - $ref: '#/definitions/KubeNodePoolUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_pool_ValidateUpdateDataOutput' - summary: 更新 - tags: - - kube_node_pool - /kube_node_pools/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: kube_node_pool_GetDetailsClassMetadata - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_pool_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - kube_node_pool - post: - description: 执行操作ClassMetadata - operationId: kube_node_pool_PerformClassMetadata - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node_pool: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_pool_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - kube_node_pool - /kube_node_pools/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: kube_node_pool_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 kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_pool_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - kube_node_pool - /kube_node_pools/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: kube_node_pool_PerformSetClassMetadata - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node_pool: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_pool_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - kube_node_pool - /kube_node_pools/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: kube_node_pool_PerformSetUserMetadata - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node_pool: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_pool_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - kube_node_pool - /kube_node_pools/{id}/status: - get: - description: 获取指定信息Status - operationId: kube_node_pool_GetDetailsStatus - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_pool_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - kube_node_pool - post: - description: 执行操作Status - operationId: kube_node_pool_PerformStatus - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node_pool: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_pool_PerformStatusOutput' - summary: 更新资源状态 - tags: - - kube_node_pool - /kube_node_pools/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: kube_node_pool_PerformSyncstatus - parameters: - - description: The Id or Name of kube_node_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node_pool: - $ref: '#/definitions/SyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_pool_PerformSyncstatusOutput' - summary: 同步Kube Node Pool 状态 - tags: - - kube_node_pool - /kube_node_pools/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: kube_node_pool_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/kube_node_pool_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - kube_node_pool - /kube_node_pools/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: kube_node_pool_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - kube_node_pool: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_pool_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - kube_node_pool - /kube_node_pools/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: kube_node_pool_GetPropertySplitable - responses: - "200": - $ref: '#/responses/kube_node_pool_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - kube_node_pool - /kube_node_pools/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: kube_node_pool_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/kube_node_pool_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - kube_node_pool - /kube_node_pools/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: kube_node_pool_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/kube_node_pool_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - kube_node_pool - /kube_node_pools/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: kube_node_pool_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/kube_node_pool_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - kube_node_pool - /kube_node_pools/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: kube_node_pool_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/kube_node_pool_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - kube_node_pool - /kube_nodes: - get: - description: 列表 - operationId: kube_node_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/kube_node_ListItemFilterOutput' - summary: Kube Node列表 - tags: - - kube_node - post: - description: 新建 - operationId: kube_node_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - kube_node: - $ref: '#/definitions/KubeNodeCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_ValidateCreateDataOutput' - summary: 新建 - tags: - - kube_node - /kube_nodes/{id}: - delete: - description: 删除 - operationId: kube_node_CustomizeDelete - parameters: - - description: The Id or Name of kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_CustomizeDeleteOutput' - summary: 删除 - tags: - - kube_node - get: - description: 获取详情 - operationId: kube_node_FetchCustomizeColumns - parameters: - - description: The Id or Name of kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - kube_node - put: - description: 更新 - operationId: kube_node_ValidateUpdateData - parameters: - - description: The Id or Name of kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node: - $ref: '#/definitions/KubeNodeUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_ValidateUpdateDataOutput' - summary: 更新 - tags: - - kube_node - /kube_nodes/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: kube_node_GetDetailsClassMetadata - parameters: - - description: The Id or Name of kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - kube_node - post: - description: 执行操作ClassMetadata - operationId: kube_node_PerformClassMetadata - parameters: - - description: The Id or Name of kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - kube_node - /kube_nodes/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: kube_node_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 kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - kube_node - /kube_nodes/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: kube_node_PerformSetClassMetadata - parameters: - - description: The Id or Name of kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - kube_node - /kube_nodes/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: kube_node_PerformSetUserMetadata - parameters: - - description: The Id or Name of kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - kube_node - /kube_nodes/{id}/status: - get: - description: 获取指定信息Status - operationId: kube_node_GetDetailsStatus - parameters: - - description: The Id or Name of kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/kube_node_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - kube_node - post: - description: 执行操作Status - operationId: kube_node_PerformStatus - parameters: - - description: The Id or Name of kube_node - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - kube_node: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_PerformStatusOutput' - summary: 更新资源状态 - tags: - - kube_node - /kube_nodes/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: kube_node_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/kube_node_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - kube_node - /kube_nodes/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: kube_node_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - kube_node: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/kube_node_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - kube_node - /kube_nodes/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: kube_node_GetPropertySplitable - responses: - "200": - $ref: '#/responses/kube_node_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - kube_node - /kube_nodes/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: kube_node_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/kube_node_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - kube_node - /kube_nodes/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: kube_node_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/kube_node_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - kube_node - /kube_nodes/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: kube_node_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/kube_node_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - kube_node - /kube_nodes/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: kube_node_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/kube_node_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - kube_node - /loadbalancer_acls: - get: - description: 列表 - operationId: loadbalancer_acl_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - in: query - name: fingerprint - type: string - x-go-name: Fingerprint - responses: - "200": - $ref: '#/responses/loadbalancer_acl_ListItemFilterOutput' - summary: 负载均衡ACL规则列表 - tags: - - loadbalancer_acl - post: - description: 新建 - operationId: loadbalancer_acl_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - loadbalancer_acl: - $ref: '#/definitions/LoadbalancerAclCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_ValidateCreateDataOutput' - summary: 新建 - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}: - delete: - description: 删除 - operationId: loadbalancer_acl_CustomizeDelete - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_acl_CustomizeDeleteOutput' - summary: 删除 - tags: - - loadbalancer_acl - get: - description: 获取详情 - operationId: loadbalancer_acl_FetchCustomizeColumns - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_acl_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - loadbalancer_acl - put: - description: 更新 - operationId: loadbalancer_acl_ValidateUpdateData - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/LoadbalancerAclUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_ValidateUpdateDataOutput' - summary: 更新 - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: loadbalancer_acl_PerformCancelDelete - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: loadbalancer_acl_PerformChangeOwner - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: loadbalancer_acl_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: loadbalancer_acl_GetDetailsClassMetadata - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - loadbalancer_acl - post: - description: 执行操作ClassMetadata - operationId: loadbalancer_acl_PerformClassMetadata - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/freeze: - post: - description: 执行操作Freeze - operationId: loadbalancer_acl_PerformFreeze - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: loadbalancer_acl_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 loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/patch: - post: - description: This is intended mainly for command line operations. - operationId: loadbalancer_acl_PerformPatch - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/LoadbalancerAclPatchInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformPatchOutput' - summary: PerformPatch patches acl entries by adding then deleting the specified - acls. - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/private: - post: - description: 执行操作Private - operationId: loadbalancer_acl_PerformPrivate - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformPrivateOutput' - summary: 执行操作Private - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/public: - post: - description: 执行操作Public - operationId: loadbalancer_acl_PerformPublic - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformPublicOutput' - summary: 执行操作Public - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/purge: - post: - description: 执行操作Purge - operationId: loadbalancer_acl_PerformPurge - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: loadbalancer_acl_PerformSetClassMetadata - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: loadbalancer_acl_PerformSetUserMetadata - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/status: - get: - description: 获取指定信息Status - operationId: loadbalancer_acl_GetDetailsStatus - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - loadbalancer_acl - post: - description: 执行操作Status - operationId: loadbalancer_acl_PerformStatus - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformStatusOutput' - summary: 更新资源状态 - tags: - - loadbalancer_acl - /loadbalancer_acls/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: loadbalancer_acl_PerformUnfreeze - parameters: - - description: The Id or Name of loadbalancer_acl - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - loadbalancer_acl - /loadbalancer_acls/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: loadbalancer_acl_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - loadbalancer_acl - /loadbalancer_acls/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: loadbalancer_acl_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - loadbalancer_acl - /loadbalancer_acls/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: loadbalancer_acl_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - loadbalancer_acl - /loadbalancer_acls/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: loadbalancer_acl_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - loadbalancer_acl - /loadbalancer_acls/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: loadbalancer_acl_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - loadbalancer_acl - /loadbalancer_acls/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: loadbalancer_acl_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_acl_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - loadbalancer_acl - /loadbalancer_acls/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: loadbalancer_acl_GetPropertySplitable - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - loadbalancer_acl - /loadbalancer_acls/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: loadbalancer_acl_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/loadbalancer_acl_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - loadbalancer_acl - /loadbalancer_acls/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: loadbalancer_acl_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - loadbalancer_acl - /loadbalancer_acls/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: loadbalancer_acl_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - loadbalancer_acl - /loadbalancer_acls/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: loadbalancer_acl_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_acl_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - loadbalancer_acl - /loadbalancer_agents: - get: - description: 列表 - operationId: loadbalancer_agent_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: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: 负载均衡集群ID或名称 - in: query - name: cluster_id - type: string - x-go-name: ClusterId - - description: 以负载均衡集群排序 - in: query - name: order_by_cluster - type: string - x-go-name: OrderByCluster - - in: query - items: - type: string - name: version - type: array - x-go-name: Version - - in: query - items: - type: string - name: ip - type: array - x-go-name: IP - - in: query - items: - type: string - name: ha_state - type: array - x-go-name: HaState - responses: - "200": - $ref: '#/responses/loadbalancer_agent_ListItemFilterOutput' - summary: 负载均衡Agent列表 - tags: - - loadbalancer_agent - post: - description: 新建 - operationId: loadbalancer_agent_ValidateCreateData - responses: - "200": - $ref: '#/responses/loadbalancer_agent_ValidateCreateDataOutput' - summary: 新建 - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}: - delete: - description: 删除 - operationId: loadbalancer_agent_CustomizeDelete - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_agent_CustomizeDeleteOutput' - summary: 删除 - tags: - - loadbalancer_agent - get: - description: 获取详情 - operationId: loadbalancer_agent_FetchCustomizeColumns - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_agent_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - loadbalancer_agent - put: - description: 更新 - operationId: loadbalancer_agent_ValidateUpdateData - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_agent_ValidateUpdateDataOutput' - summary: 更新 - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: loadbalancer_agent_GetDetailsClassMetadata - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_agent_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - loadbalancer_agent - post: - description: 执行操作ClassMetadata - operationId: loadbalancer_agent_PerformClassMetadata - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_agent: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/deploy: - post: - description: 执行操作Deploy - operationId: loadbalancer_agent_PerformDeploy - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_agent: - $ref: '#/definitions/LoadbalancerAgentDeployInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformDeployOutput' - summary: 执行操作Deploy - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/hb: - post: - description: 执行操作Hb - operationId: loadbalancer_agent_PerformHb - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformHbOutput' - summary: 执行操作Hb - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/join-cluster: - post: - description: 执行操作JoinCluster - operationId: loadbalancer_agent_PerformJoinCluster - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_agent: - $ref: '#/definitions/LoadbalancerAgentJoinClusterInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformJoinClusterOutput' - summary: 执行操作JoinCluster - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/leave-cluster: - post: - description: 执行操作LeaveCluster - operationId: loadbalancer_agent_PerformLeaveCluster - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_agent: - $ref: '#/definitions/LoadbalancerAgentLeaveClusterInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformLeaveClusterOutput' - summary: 执行操作LeaveCluster - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: loadbalancer_agent_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 loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_agent_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/params-patch: - post: - description: 执行操作ParamsPatch - operationId: loadbalancer_agent_PerformParamsPatch - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformParamsPatchOutput' - summary: 执行操作ParamsPatch - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: loadbalancer_agent_PerformSetClassMetadata - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_agent: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: loadbalancer_agent_PerformSetUserMetadata - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_agent: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - loadbalancer_agent - /loadbalancer_agents/{id}/undeploy: - post: - description: 执行操作Undeploy - operationId: loadbalancer_agent_PerformUndeploy - parameters: - - description: The Id or Name of loadbalancer_agent - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformUndeployOutput' - summary: 执行操作Undeploy - tags: - - loadbalancer_agent - /loadbalancer_agents/default-params: - get: - description: 获取指定资源类的信息DefaultParams - operationId: loadbalancer_agent_GetPropertyDefaultParams - responses: - "200": - $ref: '#/responses/loadbalancer_agent_GetPropertyDefaultParamsOutput' - summary: 获取指定资源类的信息DefaultParams - tags: - - loadbalancer_agent - /loadbalancer_agents/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: loadbalancer_agent_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/loadbalancer_agent_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - loadbalancer_agent - /loadbalancer_agents/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: loadbalancer_agent_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - loadbalancer_agent: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_agent_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - loadbalancer_agent - /loadbalancer_agents/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: loadbalancer_agent_GetPropertySplitable - responses: - "200": - $ref: '#/responses/loadbalancer_agent_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - loadbalancer_agent - /loadbalancer_agents/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: loadbalancer_agent_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/loadbalancer_agent_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - loadbalancer_agent - /loadbalancer_agents/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: loadbalancer_agent_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_agent_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - loadbalancer_agent - /loadbalancer_agents/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: loadbalancer_agent_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_agent_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - loadbalancer_agent - /loadbalancer_backend_groups: - get: - description: 列表 - operationId: loadbalancer_backend_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: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 负载均衡名称 - in: query - name: loadbalancer_id - type: string - x-go-name: LoadbalancerId - - description: 以负载均衡名称排序 - in: query - name: order_by_loadbalancer - type: string - x-go-name: OrderByLoadbalancer - - description: filter LoadbalancerBackendGroup with no reference - in: query - name: no_ref - type: boolean - x-go-name: NoRef - - in: query - items: - type: string - name: type - type: array - x-go-name: Type - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_ListItemFilterOutput' - summary: 负载均衡后端服务器组列表 - tags: - - loadbalancer_backend_group - post: - description: 新建 - operationId: loadbalancer_backend_group_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - loadbalancer_backend_group: - $ref: '#/definitions/LoadbalancerBackendGroupCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_ValidateCreateDataOutput' - summary: 新建 - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/{id}: - delete: - description: 删除 - operationId: loadbalancer_backend_group_CustomizeDelete - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_CustomizeDeleteOutput' - summary: 删除 - tags: - - loadbalancer_backend_group - get: - description: 获取详情 - operationId: loadbalancer_backend_group_FetchCustomizeColumns - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - loadbalancer_backend_group - put: - description: 更新 - operationId: loadbalancer_backend_group_ValidateUpdateData - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend_group: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_ValidateUpdateDataOutput' - summary: 更新 - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: loadbalancer_backend_group_GetDetailsClassMetadata - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - loadbalancer_backend_group - post: - description: 执行操作ClassMetadata - operationId: loadbalancer_backend_group_PerformClassMetadata - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: loadbalancer_backend_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 loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/{id}/purge: - post: - description: 执行操作Purge - operationId: loadbalancer_backend_group_PerformPurge - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: loadbalancer_backend_group_PerformSetClassMetadata - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: loadbalancer_backend_group_PerformSetUserMetadata - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/{id}/status: - get: - description: 获取指定信息Status - operationId: loadbalancer_backend_group_GetDetailsStatus - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - loadbalancer_backend_group - post: - description: 执行操作Status - operationId: loadbalancer_backend_group_PerformStatus - parameters: - - description: The Id or Name of loadbalancer_backend_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend_group: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_PerformStatusOutput' - summary: 更新资源状态 - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: loadbalancer_backend_group_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: loadbalancer_backend_group_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - loadbalancer_backend_group: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: loadbalancer_backend_group_GetPropertySplitable - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: loadbalancer_backend_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/loadbalancer_backend_group_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: loadbalancer_backend_group_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: loadbalancer_backend_group_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - loadbalancer_backend_group - /loadbalancer_backend_groups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: loadbalancer_backend_group_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_backend_group_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - loadbalancer_backend_group - /loadbalancer_backends: - get: - description: 列表 - operationId: loadbalancer_backend_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 负载均衡名称 - in: query - name: loadbalancer_id - type: string - x-go-name: LoadbalancerId - - description: 以负载均衡名称排序 - in: query - name: order_by_loadbalancer - type: string - x-go-name: OrderByLoadbalancer - - description: 负载均衡后端组ID或名称 - in: query - name: backend_group_id - type: string - x-go-name: BackendGroupId - - description: 以负载均衡后端组名称排序 - in: query - name: order_by_backend_group - type: string - x-go-name: OrderByBackendGroup - - description: filter by backend server - in: query - name: backend - type: string - x-go-name: Backend - - in: query - items: - type: string - name: backend_type - type: array - x-go-name: BackendType - - in: query - items: - type: string - name: backend_role - type: array - x-go-name: BackendRole - - in: query - items: - type: string - name: address - type: array - x-go-name: Address - - in: query - items: - type: string - name: send_proxy - type: array - x-go-name: SendProxy - - in: query - items: - type: string - name: ssl - type: array - x-go-name: Ssl - responses: - "200": - $ref: '#/responses/loadbalancer_backend_ListItemFilterOutput' - summary: 负载均衡后端列表 - tags: - - loadbalancer_backend - post: - description: 新建 - operationId: loadbalancer_backend_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - loadbalancer_backend: - $ref: '#/definitions/LoadbalancerBackendCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_ValidateCreateDataOutput' - summary: 新建 - tags: - - loadbalancer_backend - /loadbalancer_backends/{id}: - delete: - description: 删除 - operationId: loadbalancer_backend_CustomizeDelete - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_CustomizeDeleteOutput' - summary: 删除 - tags: - - loadbalancer_backend - get: - description: 获取详情 - operationId: loadbalancer_backend_FetchCustomizeColumns - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - loadbalancer_backend - put: - description: 更新 - operationId: loadbalancer_backend_ValidateUpdateData - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend: - $ref: '#/definitions/LoadbalancerBackendUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_ValidateUpdateDataOutput' - summary: 更新 - tags: - - loadbalancer_backend - /loadbalancer_backends/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: loadbalancer_backend_GetDetailsClassMetadata - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - loadbalancer_backend - post: - description: 执行操作ClassMetadata - operationId: loadbalancer_backend_PerformClassMetadata - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - loadbalancer_backend - /loadbalancer_backends/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: loadbalancer_backend_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 loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - loadbalancer_backend - /loadbalancer_backends/{id}/purge: - post: - description: 执行操作Purge - operationId: loadbalancer_backend_PerformPurge - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - loadbalancer_backend - /loadbalancer_backends/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: loadbalancer_backend_PerformSetClassMetadata - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - loadbalancer_backend - /loadbalancer_backends/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: loadbalancer_backend_PerformSetUserMetadata - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - loadbalancer_backend - /loadbalancer_backends/{id}/status: - get: - description: 获取指定信息Status - operationId: loadbalancer_backend_GetDetailsStatus - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_backend_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - loadbalancer_backend - post: - description: 执行操作Status - operationId: loadbalancer_backend_PerformStatus - parameters: - - description: The Id or Name of loadbalancer_backend - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_backend: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_PerformStatusOutput' - summary: 更新资源状态 - tags: - - loadbalancer_backend - /loadbalancer_backends/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: loadbalancer_backend_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/loadbalancer_backend_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - loadbalancer_backend - /loadbalancer_backends/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: loadbalancer_backend_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - loadbalancer_backend: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_backend_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - loadbalancer_backend - /loadbalancer_backends/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: loadbalancer_backend_GetPropertySplitable - responses: - "200": - $ref: '#/responses/loadbalancer_backend_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - loadbalancer_backend - /loadbalancer_backends/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: loadbalancer_backend_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/loadbalancer_backend_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - loadbalancer_backend - /loadbalancer_backends/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: loadbalancer_backend_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_backend_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - loadbalancer_backend - /loadbalancer_backends/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: loadbalancer_backend_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_backend_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - loadbalancer_backend - /loadbalancer_backends/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: loadbalancer_backend_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_backend_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - loadbalancer_backend - /loadbalancer_certificates: - get: - description: 列表 - operationId: loadbalancer_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 - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - in: query - items: - type: string - name: common_name - type: array - x-go-name: CommonName - - in: query - items: - type: string - name: subject_alternative_names - type: array - x-go-name: SubjectAlternativeNames - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_ListItemFilterOutput' - summary: 列表 - tags: - - loadbalancer_certificate - post: - description: 新建 - operationId: loadbalancer_certificate_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - loadbalancer_certificate: - $ref: '#/definitions/LoadbalancerCertificateCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_ValidateCreateDataOutput' - summary: 新建 - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}: - delete: - description: 删除 - operationId: loadbalancer_certificate_CustomizeDelete - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_CustomizeDeleteOutput' - summary: 删除 - tags: - - loadbalancer_certificate - get: - description: 获取详情 - operationId: loadbalancer_certificate_FetchCustomizeColumns - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - loadbalancer_certificate - put: - description: 更新 - operationId: loadbalancer_certificate_ValidateUpdateData - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/LoadbalancerCertificateUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_ValidateUpdateDataOutput' - summary: 更新 - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: loadbalancer_certificate_PerformCancelDelete - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: loadbalancer_certificate_PerformChangeOwner - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: loadbalancer_certificate_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: loadbalancer_certificate_GetDetailsClassMetadata - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - loadbalancer_certificate - post: - description: 执行操作ClassMetadata - operationId: loadbalancer_certificate_PerformClassMetadata - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/freeze: - post: - description: 执行操作Freeze - operationId: loadbalancer_certificate_PerformFreeze - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: loadbalancer_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 loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/private: - post: - description: 执行操作Private - operationId: loadbalancer_certificate_PerformPrivate - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformPrivateOutput' - summary: 执行操作Private - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/public: - post: - description: 执行操作Public - operationId: loadbalancer_certificate_PerformPublic - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformPublicOutput' - summary: 执行操作Public - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: loadbalancer_certificate_PerformSetClassMetadata - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: loadbalancer_certificate_PerformSetUserMetadata - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/status: - get: - description: 获取指定信息Status - operationId: loadbalancer_certificate_GetDetailsStatus - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - loadbalancer_certificate - post: - description: 执行操作Status - operationId: loadbalancer_certificate_PerformStatus - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformStatusOutput' - summary: 更新资源状态 - tags: - - loadbalancer_certificate - /loadbalancer_certificates/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: loadbalancer_certificate_PerformUnfreeze - parameters: - - description: The Id or Name of loadbalancer_certificate - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - loadbalancer_certificate - /loadbalancer_certificates/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: loadbalancer_certificate_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - loadbalancer_certificate - /loadbalancer_certificates/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: loadbalancer_certificate_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - loadbalancer_certificate - /loadbalancer_certificates/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: loadbalancer_certificate_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - loadbalancer_certificate - /loadbalancer_certificates/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: loadbalancer_certificate_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - loadbalancer_certificate - /loadbalancer_certificates/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: loadbalancer_certificate_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - loadbalancer_certificate - /loadbalancer_certificates/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: loadbalancer_certificate_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - loadbalancer_certificate - /loadbalancer_certificates/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: loadbalancer_certificate_GetPropertySplitable - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - loadbalancer_certificate - /loadbalancer_certificates/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: loadbalancer_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/loadbalancer_certificate_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - loadbalancer_certificate - /loadbalancer_certificates/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: loadbalancer_certificate_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - loadbalancer_certificate - /loadbalancer_certificates/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: loadbalancer_certificate_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - loadbalancer_certificate - /loadbalancer_certificates/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: loadbalancer_certificate_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_certificate_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - loadbalancer_certificate - /loadbalancer_clusters: - get: - description: 列表 - operationId: loadbalancer_cluster_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: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_ListItemFilterOutput' - summary: 负载均衡集群列表 - tags: - - loadbalancer_cluster - post: - description: 新建 - operationId: loadbalancer_cluster_ValidateCreateData - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_ValidateCreateDataOutput' - summary: 新建 - tags: - - loadbalancer_cluster - /loadbalancer_clusters/{id}: - delete: - description: 删除 - operationId: loadbalancer_cluster_CustomizeDelete - parameters: - - description: The Id or Name of loadbalancer_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_CustomizeDeleteOutput' - summary: 删除 - tags: - - loadbalancer_cluster - get: - description: 获取详情 - operationId: loadbalancer_cluster_FetchCustomizeColumns - parameters: - - description: The Id or Name of loadbalancer_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - loadbalancer_cluster - put: - description: 更新 - operationId: loadbalancer_cluster_ValidateUpdateData - parameters: - - description: The Id or Name of loadbalancer_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_ValidateUpdateDataOutput' - summary: 更新 - tags: - - loadbalancer_cluster - /loadbalancer_clusters/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: loadbalancer_cluster_GetDetailsClassMetadata - parameters: - - description: The Id or Name of loadbalancer_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - loadbalancer_cluster - post: - description: 执行操作ClassMetadata - operationId: loadbalancer_cluster_PerformClassMetadata - parameters: - - description: The Id or Name of loadbalancer_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_cluster: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - loadbalancer_cluster - /loadbalancer_clusters/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: loadbalancer_cluster_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 loadbalancer_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - loadbalancer_cluster - /loadbalancer_clusters/{id}/params-patch: - post: - description: 执行操作ParamsPatch - operationId: loadbalancer_cluster_PerformParamsPatch - parameters: - - description: The Id or Name of loadbalancer_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_PerformParamsPatchOutput' - summary: 执行操作ParamsPatch - tags: - - loadbalancer_cluster - /loadbalancer_clusters/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: loadbalancer_cluster_PerformSetClassMetadata - parameters: - - description: The Id or Name of loadbalancer_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_cluster: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - loadbalancer_cluster - /loadbalancer_clusters/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: loadbalancer_cluster_PerformSetUserMetadata - parameters: - - description: The Id or Name of loadbalancer_cluster - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_cluster: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - loadbalancer_cluster - /loadbalancer_clusters/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: loadbalancer_cluster_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - loadbalancer_cluster - /loadbalancer_clusters/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: loadbalancer_cluster_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - loadbalancer_cluster: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - loadbalancer_cluster - /loadbalancer_clusters/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: loadbalancer_cluster_GetPropertySplitable - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - loadbalancer_cluster - /loadbalancer_clusters/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: loadbalancer_cluster_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/loadbalancer_cluster_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - loadbalancer_cluster - /loadbalancer_clusters/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: loadbalancer_cluster_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - loadbalancer_cluster - /loadbalancer_clusters/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: loadbalancer_cluster_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_cluster_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - loadbalancer_cluster - /loadbalancer_listener_rules: - get: - description: 列表 - operationId: loadbalancer_listener_rule_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 负载均衡名称 - in: query - name: loadbalancer_id - type: string - x-go-name: LoadbalancerId - - description: 以负载均衡名称排序 - in: query - name: order_by_loadbalancer - type: string - x-go-name: OrderByLoadbalancer - - description: 负载均衡监听器 - in: query - name: listener_id - type: string - x-go-name: ListenerId - - description: 以负载均衡监听器名称排序 - in: query - name: order_by_listener - type: string - x-go-name: OrderByListener - - description: filter by backend_group - in: query - name: backend_group - type: string - x-go-name: BackendGroup - - description: 默认转发策略，目前只有aws用到其它云都是false - in: query - name: is_default - type: boolean - x-go-name: IsDefault - - in: query - items: - type: string - name: domain - type: array - x-go-name: Domain - - in: query - items: - type: string - name: path - type: array - x-go-name: Path - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_ListItemFilterOutput' - summary: 负载均衡监听器规则列表 - tags: - - loadbalancer_listener_rule - post: - description: 新建 - operationId: loadbalancer_listener_rule_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - loadbalancer_listener_rule: - $ref: '#/definitions/LoadbalancerListenerRuleCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_ValidateCreateDataOutput' - summary: 新建 - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/{id}: - delete: - description: 删除 - operationId: loadbalancer_listener_rule_CustomizeDelete - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_CustomizeDeleteOutput' - summary: 删除 - tags: - - loadbalancer_listener_rule - get: - description: 获取详情 - operationId: loadbalancer_listener_rule_FetchCustomizeColumns - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - loadbalancer_listener_rule - put: - description: 更新 - operationId: loadbalancer_listener_rule_ValidateUpdateData - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener_rule: - $ref: '#/definitions/LoadbalancerListenerRuleUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_ValidateUpdateDataOutput' - summary: 更新 - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/{id}/backend-status: - get: - description: 获取指定信息BackendStatus - operationId: loadbalancer_listener_rule_GetDetailsBackendStatus - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_GetDetailsBackendStatusOutput' - summary: 获取指定信息BackendStatus - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: loadbalancer_listener_rule_GetDetailsClassMetadata - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - loadbalancer_listener_rule - post: - description: 执行操作ClassMetadata - operationId: loadbalancer_listener_rule_PerformClassMetadata - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener_rule: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: loadbalancer_listener_rule_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 loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/{id}/purge: - post: - description: 执行操作Purge - operationId: loadbalancer_listener_rule_PerformPurge - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: loadbalancer_listener_rule_PerformSetClassMetadata - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener_rule: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: loadbalancer_listener_rule_PerformSetUserMetadata - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener_rule: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/{id}/status: - get: - description: 获取指定信息Status - operationId: loadbalancer_listener_rule_GetDetailsStatus - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - loadbalancer_listener_rule - post: - description: 执行操作Status - operationId: loadbalancer_listener_rule_PerformStatus - parameters: - - description: The Id or Name of loadbalancer_listener_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener_rule: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_PerformStatusOutput' - summary: 更新资源状态 - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: loadbalancer_listener_rule_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: loadbalancer_listener_rule_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - loadbalancer_listener_rule: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: loadbalancer_listener_rule_GetPropertySplitable - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: loadbalancer_listener_rule_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/loadbalancer_listener_rule_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: loadbalancer_listener_rule_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: loadbalancer_listener_rule_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - loadbalancer_listener_rule - /loadbalancer_listener_rules/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: loadbalancer_listener_rule_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_listener_rule_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - loadbalancer_listener_rule - /loadbalancer_listeners: - get: - description: 列表 - operationId: loadbalancer_listener_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 负载均衡名称 - in: query - name: loadbalancer_id - type: string - x-go-name: LoadbalancerId - - description: 以负载均衡名称排序 - in: query - name: order_by_loadbalancer - type: string - x-go-name: OrderByLoadbalancer - - description: ACL名称或ID - in: query - name: acl_id - type: string - x-go-name: AclId - - description: filter by backend_group - in: query - name: backend_group - type: string - x-go-name: BackendGroup - - in: query - items: - type: string - name: listener_type - type: array - x-go-name: ListenerType - - in: query - items: - format: int64 - type: integer - name: listener_port - type: array - x-go-name: ListenerPort - - in: query - items: - type: string - name: scheduler - type: array - x-go-name: Scheduler - - in: query - items: - type: string - name: certificate_id - type: array - x-go-name: Certificate - - in: query - items: - type: string - name: send_proxy - type: array - x-go-name: SendProxy - - in: query - items: - type: string - name: acl_status - type: array - x-go-name: AclStatus - - in: query - items: - type: string - name: acl_type - type: array - x-go-name: AclType - responses: - "200": - $ref: '#/responses/loadbalancer_listener_ListItemFilterOutput' - summary: 负载均衡监听器Listener列表 - tags: - - loadbalancer_listener - post: - description: 新建 - operationId: loadbalancer_listener_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - loadbalancer_listener: - $ref: '#/definitions/LoadbalancerListenerCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_ValidateCreateDataOutput' - summary: 新建 - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}: - delete: - description: 删除 - operationId: loadbalancer_listener_CustomizeDelete - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_CustomizeDeleteOutput' - summary: 删除 - tags: - - loadbalancer_listener - get: - description: 获取详情 - operationId: loadbalancer_listener_FetchCustomizeColumns - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - loadbalancer_listener - put: - description: 更新 - operationId: loadbalancer_listener_ValidateUpdateData - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener: - $ref: '#/definitions/LoadbalancerListenerUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_ValidateUpdateDataOutput' - summary: 更新 - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}/backend-status: - get: - description: 获取指定信息BackendStatus - operationId: loadbalancer_listener_GetDetailsBackendStatus - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_GetDetailsBackendStatusOutput' - summary: 获取指定信息BackendStatus - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: loadbalancer_listener_GetDetailsClassMetadata - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - loadbalancer_listener - post: - description: 执行操作ClassMetadata - operationId: loadbalancer_listener_PerformClassMetadata - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: loadbalancer_listener_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 loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}/purge: - post: - description: 执行操作Purge - operationId: loadbalancer_listener_PerformPurge - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: loadbalancer_listener_PerformSetClassMetadata - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: loadbalancer_listener_PerformSetUserMetadata - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}/status: - get: - description: 获取指定信息Status - operationId: loadbalancer_listener_GetDetailsStatus - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - loadbalancer_listener - post: - description: 执行操作Status - operationId: loadbalancer_listener_PerformStatus - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer_listener: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_PerformStatusOutput' - summary: 执行操作Status - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}/sync: - post: - description: 执行操作Sync - operationId: loadbalancer_listener_PerformSync - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_PerformSyncOutput' - summary: 执行操作Sync - tags: - - loadbalancer_listener - /loadbalancer_listeners/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: loadbalancer_listener_PerformSyncstatus - parameters: - - description: The Id or Name of loadbalancer_listener - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_listener_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - loadbalancer_listener - /loadbalancer_listeners/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: loadbalancer_listener_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/loadbalancer_listener_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - loadbalancer_listener - /loadbalancer_listeners/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: loadbalancer_listener_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - loadbalancer_listener: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_listener_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - loadbalancer_listener - /loadbalancer_listeners/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: loadbalancer_listener_GetPropertySplitable - responses: - "200": - $ref: '#/responses/loadbalancer_listener_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - loadbalancer_listener - /loadbalancer_listeners/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: loadbalancer_listener_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/loadbalancer_listener_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - loadbalancer_listener - /loadbalancer_listeners/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: loadbalancer_listener_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_listener_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - loadbalancer_listener - /loadbalancer_listeners/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: loadbalancer_listener_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_listener_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - loadbalancer_listener - /loadbalancer_listeners/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: loadbalancer_listener_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_listener_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - loadbalancer_listener - /loadbalancers: - get: - description: 列表 - operationId: loadbalancer_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 是否禁止删除 - in: query - name: disable_delete - type: boolean - x-go-name: DisableDelete - - description: 计费类型，按需计费和预付费 - in: query - name: billing_type - pattern: prepaid|postpaid - type: string - x-go-name: BillingType - - description: 计费过期时间的查询起始时间 - format: date-time - in: query - name: billing_expire_since - type: string - x-go-name: BillingExpireSince - - description: 计费过期时间的查询终止时间 - format: date-time - in: query - name: billing_expire_before - type: string - x-go-name: BillingExpireBefore - - description: 计费周期 - example: 7d - in: query - name: billing_cycle - type: string - x-go-name: BillingCycle - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - description: filter by cluster - in: query - name: cluster - type: string - x-go-name: Cluster - - in: query - items: - type: string - name: address - type: array - x-go-name: Address - - description: 地址类型 - in: query - items: - type: string - name: address_type - type: array - x-go-name: AddressType - - description: 网络类型 - in: query - items: - type: string - name: network_type - type: array - x-go-name: NetworkType - - description: 计费类型 - in: query - items: - type: string - name: charge_type - type: array - x-go-name: ChargeType - - description: 套餐名称 - in: query - items: - type: string - name: loadbalancer_spec - type: array - x-go-name: LoadbalancerSpec - - description: filter for EIP - in: query - name: with_eip - type: boolean - x-go-name: WithEip - - in: query - name: without_eip - type: boolean - x-go-name: WithoutEip - - in: query - name: eip_associable - type: boolean - x-go-name: EipAssociable - - in: query - name: usable_loadbalancer_for_eip - type: string - x-go-name: UsableLoadbalancerForEip - responses: - "200": - $ref: '#/responses/loadbalancer_ListItemFilterOutput' - summary: 负载均衡实例列表 - tags: - - loadbalancer - post: - description: 新建 - operationId: loadbalancer_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - loadbalancer: - $ref: '#/definitions/LoadbalancerCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_ValidateCreateDataOutput' - summary: 新建 - tags: - - loadbalancer - /loadbalancers/{id}: - delete: - description: 删除 - operationId: loadbalancer_CustomizeDelete - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_CustomizeDeleteOutput' - summary: 删除 - tags: - - loadbalancer - get: - description: 获取详情 - operationId: loadbalancer_FetchCustomizeColumns - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - loadbalancer - put: - description: 更新 - operationId: loadbalancer_ValidateUpdateData - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_ValidateUpdateDataOutput' - summary: 更新 - tags: - - loadbalancer - /loadbalancers/{id}/associate-eip: - post: - description: 执行操作AssociateEip - operationId: loadbalancer_PerformAssociateEip - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - $ref: '#/definitions/LoadbalancerAssociateEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformAssociateEipOutput' - summary: 绑定弹性公网IP, 仅支持kvm - tags: - - loadbalancer - /loadbalancers/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: loadbalancer_PerformCancelDelete - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - loadbalancer - /loadbalancers/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: loadbalancer_PerformChangeOwner - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - loadbalancer - /loadbalancers/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: loadbalancer_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - loadbalancer - /loadbalancers/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: loadbalancer_GetDetailsClassMetadata - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - loadbalancer - post: - description: 执行操作ClassMetadata - operationId: loadbalancer_PerformClassMetadata - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - loadbalancer - /loadbalancers/{id}/create-eip: - post: - description: 执行操作CreateEip - operationId: loadbalancer_PerformCreateEip - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - $ref: '#/definitions/LoadbalancerCreateEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformCreateEipOutput' - summary: 执行操作CreateEip - tags: - - loadbalancer - /loadbalancers/{id}/dissociate-eip: - post: - description: 执行操作DissociateEip - operationId: loadbalancer_PerformDissociateEip - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - $ref: '#/definitions/LoadbalancerDissociateEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformDissociateEipOutput' - summary: 解绑弹性公网IP，仅支持kvm - tags: - - loadbalancer - /loadbalancers/{id}/freeze: - post: - description: 执行操作Freeze - operationId: loadbalancer_PerformFreeze - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - loadbalancer - /loadbalancers/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: loadbalancer_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 loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - loadbalancer - /loadbalancers/{id}/purge: - post: - description: 执行操作Purge - operationId: loadbalancer_PerformPurge - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - loadbalancer - /loadbalancers/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: loadbalancer_PerformRemoteUpdate - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - $ref: '#/definitions/LoadbalancerRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - loadbalancer - /loadbalancers/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: loadbalancer_PerformSetClassMetadata - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - loadbalancer - /loadbalancers/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: loadbalancer_PerformSetUserMetadata - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - loadbalancer - /loadbalancers/{id}/status: - get: - description: 获取指定信息Status - operationId: loadbalancer_GetDetailsStatus - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - loadbalancer - post: - description: 执行操作Status - operationId: loadbalancer_PerformStatus - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformStatusOutput' - summary: 执行操作Status - tags: - - loadbalancer - /loadbalancers/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: loadbalancer_PerformSyncstatus - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/loadbalancer_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - loadbalancer - /loadbalancers/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: loadbalancer_PerformUnfreeze - parameters: - - description: The Id or Name of loadbalancer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - loadbalancer: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - loadbalancer - /loadbalancers/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: loadbalancer_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/loadbalancer_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - loadbalancer - /loadbalancers/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: loadbalancer_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - loadbalancer - /loadbalancers/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: loadbalancer_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - loadbalancer - /loadbalancers/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: loadbalancer_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - loadbalancer - /loadbalancers/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: loadbalancer_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - loadbalancer - /loadbalancers/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: loadbalancer_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - loadbalancer: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/loadbalancer_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - loadbalancer - /loadbalancers/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: loadbalancer_GetPropertySplitable - responses: - "200": - $ref: '#/responses/loadbalancer_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - loadbalancer - /loadbalancers/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: loadbalancer_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/loadbalancer_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - loadbalancer - /loadbalancers/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: loadbalancer_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/loadbalancer_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - loadbalancer - /loadbalancers/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: loadbalancer_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/loadbalancer_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - loadbalancer - /loadbalancers/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: loadbalancer_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/loadbalancer_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - loadbalancer - /misc_resources: - get: - description: 列表 - operationId: misc_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 - - $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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - responses: - "200": - $ref: '#/responses/misc_resource_ListItemFilterOutput' - summary: 列出Misc Resource - tags: - - misc_resource - post: - description: 新建 - operationId: misc_resource_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - misc_resource: - $ref: '#/definitions/MiscResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_ValidateCreateDataOutput' - summary: 新建 - tags: - - misc_resource - /misc_resources/{id}: - delete: - description: 删除 - operationId: misc_resource_CustomizeDelete - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/misc_resource_CustomizeDeleteOutput' - summary: 删除 - tags: - - misc_resource - get: - description: 获取详情 - operationId: misc_resource_FetchCustomizeColumns - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/misc_resource_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - misc_resource - put: - description: 更新 - operationId: misc_resource_ValidateUpdateData - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - misc_resource: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_ValidateUpdateDataOutput' - summary: 更新 - tags: - - misc_resource - /misc_resources/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: misc_resource_PerformCancelDelete - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/misc_resource_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - misc_resource - /misc_resources/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: misc_resource_PerformChangeOwner - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - misc_resource: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - misc_resource - /misc_resources/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: misc_resource_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/misc_resource_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - misc_resource - /misc_resources/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: misc_resource_GetDetailsClassMetadata - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/misc_resource_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - misc_resource - post: - description: 执行操作ClassMetadata - operationId: misc_resource_PerformClassMetadata - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - misc_resource: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - misc_resource - /misc_resources/{id}/freeze: - post: - description: 执行操作Freeze - operationId: misc_resource_PerformFreeze - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - misc_resource: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - misc_resource - /misc_resources/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: misc_resource_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 misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/misc_resource_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - misc_resource - /misc_resources/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: misc_resource_PerformSetClassMetadata - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - misc_resource: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - misc_resource - /misc_resources/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: misc_resource_PerformSetUserMetadata - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - misc_resource: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - misc_resource - /misc_resources/{id}/status: - get: - description: 获取指定信息Status - operationId: misc_resource_GetDetailsStatus - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/misc_resource_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - misc_resource - post: - description: 执行操作Status - operationId: misc_resource_PerformStatus - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - misc_resource: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_PerformStatusOutput' - summary: 更新资源状态 - tags: - - misc_resource - /misc_resources/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: misc_resource_PerformUnfreeze - parameters: - - description: The Id or Name of misc_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - misc_resource: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - misc_resource - /misc_resources/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: misc_resource_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/misc_resource_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - misc_resource - /misc_resources/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: misc_resource_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/misc_resource_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - misc_resource - /misc_resources/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: misc_resource_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/misc_resource_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - misc_resource - /misc_resources/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: misc_resource_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/misc_resource_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - misc_resource - /misc_resources/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: misc_resource_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/misc_resource_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - misc_resource - /misc_resources/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: misc_resource_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - misc_resource: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/misc_resource_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - misc_resource - /misc_resources/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: misc_resource_GetPropertySplitable - responses: - "200": - $ref: '#/responses/misc_resource_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - misc_resource - /misc_resources/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: misc_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/misc_resource_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - misc_resource - /misc_resources/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: misc_resource_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/misc_resource_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - misc_resource - /misc_resources/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: misc_resource_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/misc_resource_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - misc_resource - /misc_resources/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: misc_resource_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/misc_resource_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - misc_resource - /modelarts_pool_skus: - get: - description: 列表 - operationId: modelarts_pool_sku_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - in: query - name: ProcessorType - type: string - - in: query - name: CpuArch - type: string - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_ListItemFilterOutput' - summary: 列表 - tags: - - modelarts_pool_sku - post: - description: 新建 - operationId: modelarts_pool_sku_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - modelarts_pool_sku: - $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_ValidateCreateDataOutput' - summary: 新建 - tags: - - modelarts_pool_sku - /modelarts_pool_skus/{id}: - delete: - description: 删除 - operationId: modelarts_pool_sku_CustomizeDelete - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_CustomizeDeleteOutput' - summary: 删除 - tags: - - modelarts_pool_sku - get: - description: 获取详情 - operationId: modelarts_pool_sku_FetchCustomizeColumns - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - modelarts_pool_sku - put: - description: 更新 - operationId: modelarts_pool_sku_ValidateUpdateData - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_ValidateUpdateDataOutput' - summary: 更新 - tags: - - modelarts_pool_sku - /modelarts_pool_skus/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: modelarts_pool_sku_GetDetailsClassMetadata - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - modelarts_pool_sku - post: - description: 执行操作ClassMetadata - operationId: modelarts_pool_sku_PerformClassMetadata - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - modelarts_pool_sku - /modelarts_pool_skus/{id}/disable: - post: - description: 执行操作Disable - operationId: modelarts_pool_sku_PerformDisable - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_PerformDisableOutput' - summary: 禁用资源 - tags: - - modelarts_pool_sku - /modelarts_pool_skus/{id}/enable: - post: - description: 执行操作Enable - operationId: modelarts_pool_sku_PerformEnable - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_PerformEnableOutput' - summary: 启用资源 - tags: - - modelarts_pool_sku - /modelarts_pool_skus/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: modelarts_pool_sku_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 modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - modelarts_pool_sku - /modelarts_pool_skus/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: modelarts_pool_sku_PerformSetClassMetadata - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - modelarts_pool_sku - /modelarts_pool_skus/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: modelarts_pool_sku_PerformSetUserMetadata - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - modelarts_pool_sku - /modelarts_pool_skus/{id}/status: - get: - description: 获取指定信息Status - operationId: modelarts_pool_sku_GetDetailsStatus - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - modelarts_pool_sku - post: - description: 执行操作Status - operationId: modelarts_pool_sku_PerformStatus - parameters: - - description: The Id or Name of modelarts_pool_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_PerformStatusOutput' - summary: 更新资源状态 - tags: - - modelarts_pool_sku - /modelarts_pool_skus/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: modelarts_pool_sku_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - modelarts_pool_sku - /modelarts_pool_skus/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: modelarts_pool_sku_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - modelarts_pool_sku - /modelarts_pool_skus/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: modelarts_pool_sku_GetPropertySplitable - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - modelarts_pool_sku - /modelarts_pool_skus/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: modelarts_pool_sku_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/modelarts_pool_sku_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - modelarts_pool_sku - /modelarts_pool_skus/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: modelarts_pool_sku_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - modelarts_pool_sku - /modelarts_pool_skus/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: modelarts_pool_sku_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - modelarts_pool_sku - /modelarts_pool_skus/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: modelarts_pool_sku_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/modelarts_pool_sku_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - modelarts_pool_sku - /modelarts_pools: - get: - description: 列表 - operationId: modelarts_pool_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 是否禁止删除 - in: query - name: disable_delete - type: boolean - x-go-name: DisableDelete - responses: - "200": - $ref: '#/responses/modelarts_pool_ListItemFilterOutput' - summary: Pool实例列表 - tags: - - modelarts_pool - post: - description: 新建 - operationId: modelarts_pool_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - modelarts_pool: - $ref: '#/definitions/ModelartsPoolCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_ValidateCreateDataOutput' - summary: 新建 - tags: - - modelarts_pool - /modelarts_pools/{id}: - delete: - description: 删除 - operationId: modelarts_pool_CustomizeDelete - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_CustomizeDeleteOutput' - summary: 进入删除任务 - tags: - - modelarts_pool - get: - description: 获取详情 - operationId: modelarts_pool_FetchCustomizeColumns - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - modelarts_pool - put: - description: 更新 - operationId: modelarts_pool_ValidateUpdateData - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_ValidateUpdateDataOutput' - summary: 更新 - tags: - - modelarts_pool - /modelarts_pools/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: modelarts_pool_PerformCancelDelete - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - modelarts_pool - /modelarts_pools/{id}/change-config: - post: - description: 执行操作ChangeConfig - operationId: modelarts_pool_PerformChangeConfig - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - $ref: '#/definitions/ModelartsPoolChangeConfigInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformChangeConfigOutput' - summary: 执行操作ChangeConfig - tags: - - modelarts_pool - /modelarts_pools/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: modelarts_pool_PerformChangeOwner - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - modelarts_pool - /modelarts_pools/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: modelarts_pool_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - modelarts_pool - /modelarts_pools/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: modelarts_pool_GetDetailsClassMetadata - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - modelarts_pool - post: - description: 执行操作ClassMetadata - operationId: modelarts_pool_PerformClassMetadata - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - modelarts_pool - /modelarts_pools/{id}/freeze: - post: - description: 执行操作Freeze - operationId: modelarts_pool_PerformFreeze - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - modelarts_pool - /modelarts_pools/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: modelarts_pool_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 modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - modelarts_pool - /modelarts_pools/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: modelarts_pool_PerformSetClassMetadata - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - modelarts_pool - /modelarts_pools/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: modelarts_pool_PerformSetUserMetadata - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - modelarts_pool - /modelarts_pools/{id}/status: - get: - description: 获取指定信息Status - operationId: modelarts_pool_GetDetailsStatus - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/modelarts_pool_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - modelarts_pool - post: - description: 执行操作Status - operationId: modelarts_pool_PerformStatus - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformStatusOutput' - summary: 更新资源状态 - tags: - - modelarts_pool - /modelarts_pools/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: modelarts_pool_PerformSyncstatus - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - $ref: '#/definitions/ModelartsPoolSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - modelarts_pool - /modelarts_pools/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: modelarts_pool_PerformUnfreeze - parameters: - - description: The Id or Name of modelarts_pool - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - modelarts_pool: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - modelarts_pool - /modelarts_pools/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: modelarts_pool_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/modelarts_pool_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - modelarts_pool - /modelarts_pools/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: modelarts_pool_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/modelarts_pool_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - modelarts_pool - /modelarts_pools/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: modelarts_pool_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/modelarts_pool_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - modelarts_pool - /modelarts_pools/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: modelarts_pool_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/modelarts_pool_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - modelarts_pool - /modelarts_pools/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: modelarts_pool_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/modelarts_pool_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - modelarts_pool - /modelarts_pools/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: modelarts_pool_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - modelarts_pool: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/modelarts_pool_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - modelarts_pool - /modelarts_pools/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: modelarts_pool_GetPropertySplitable - responses: - "200": - $ref: '#/responses/modelarts_pool_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - modelarts_pool - /modelarts_pools/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: modelarts_pool_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/modelarts_pool_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - modelarts_pool - /modelarts_pools/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: modelarts_pool_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/modelarts_pool_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - modelarts_pool - /modelarts_pools/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: modelarts_pool_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/modelarts_pool_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - modelarts_pool - /modelarts_pools/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: modelarts_pool_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/modelarts_pool_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - modelarts_pool - /mongo_dbs: - get: - description: 列表 - operationId: mongo_db_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 是否禁止删除 - in: query - name: disable_delete - type: boolean - x-go-name: DisableDelete - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - format: int64 - in: query - name: vcpu_count - type: integer - x-go-name: VcpuCount - - format: int64 - in: query - name: vmem_size_mb - type: integer - x-go-name: VmemSizeMb - - in: query - name: category - type: string - x-go-name: Category - - in: query - name: engine - type: string - x-go-name: Engine - - in: query - name: engine_version - type: string - x-go-name: EngineVersion - - in: query - name: instance_type - type: string - x-go-name: InstanceType - responses: - "200": - $ref: '#/responses/mongo_db_ListItemFilterOutput' - summary: MongoDB实例列表 - tags: - - mongo_db - post: - description: 新建 - operationId: mongo_db_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - mongo_db: - $ref: '#/definitions/MongoDBCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_ValidateCreateDataOutput' - summary: 新建 - tags: - - mongo_db - /mongo_dbs/{id}: - delete: - description: 删除 - operationId: mongo_db_CustomizeDelete - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_CustomizeDeleteOutput' - summary: 删除 - tags: - - mongo_db - get: - description: 获取详情 - operationId: mongo_db_FetchCustomizeColumns - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - mongo_db - put: - description: 更新 - operationId: mongo_db_ValidateUpdateData - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_ValidateUpdateDataOutput' - summary: 更新 - tags: - - mongo_db - /mongo_dbs/{id}/backups: - get: - description: 获取指定信息Backups - operationId: mongo_db_GetDetailsBackups - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_GetDetailsBackupsOutput' - summary: 获取备份列表 - tags: - - mongo_db - /mongo_dbs/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: mongo_db_PerformCancelDelete - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - mongo_db - /mongo_dbs/{id}/cancel-expire: - post: - description: 执行操作CancelExpire - operationId: mongo_db_PerformCancelExpire - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_PerformCancelExpireOutput' - summary: 执行操作CancelExpire - tags: - - mongo_db - /mongo_dbs/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: mongo_db_PerformChangeOwner - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - mongo_db - /mongo_dbs/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: mongo_db_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - mongo_db - /mongo_dbs/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: mongo_db_GetDetailsClassMetadata - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - mongo_db - post: - description: 执行操作ClassMetadata - operationId: mongo_db_PerformClassMetadata - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - mongo_db - /mongo_dbs/{id}/freeze: - post: - description: 执行操作Freeze - operationId: mongo_db_PerformFreeze - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - mongo_db - /mongo_dbs/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: mongo_db_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 mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - mongo_db - /mongo_dbs/{id}/postpaid-expire: - post: - description: 执行操作PostpaidExpire - operationId: mongo_db_PerformPostpaidExpire - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - $ref: '#/definitions/PostpaidExpireInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformPostpaidExpireOutput' - summary: 执行操作PostpaidExpire - tags: - - mongo_db - /mongo_dbs/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: mongo_db_PerformRemoteUpdate - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - $ref: '#/definitions/MongoDBRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - mongo_db - /mongo_dbs/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: mongo_db_PerformSetClassMetadata - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - mongo_db - /mongo_dbs/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: mongo_db_PerformSetUserMetadata - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - mongo_db - /mongo_dbs/{id}/status: - get: - description: 获取指定信息Status - operationId: mongo_db_GetDetailsStatus - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - mongo_db - post: - description: 执行操作Status - operationId: mongo_db_PerformStatus - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformStatusOutput' - summary: 更新资源状态 - tags: - - mongo_db - /mongo_dbs/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: mongo_db_PerformSyncstatus - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mongo_db_PerformSyncstatusOutput' - summary: 同步MongoDB实例状态 - tags: - - mongo_db - /mongo_dbs/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: mongo_db_PerformUnfreeze - parameters: - - description: The Id or Name of mongo_db - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mongo_db: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - mongo_db - /mongo_dbs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: mongo_db_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/mongo_db_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - mongo_db - /mongo_dbs/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: mongo_db_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/mongo_db_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - mongo_db - /mongo_dbs/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: mongo_db_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/mongo_db_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - mongo_db - /mongo_dbs/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: mongo_db_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/mongo_db_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - mongo_db - /mongo_dbs/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: mongo_db_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/mongo_db_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - mongo_db - /mongo_dbs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: mongo_db_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - mongo_db: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mongo_db_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - mongo_db - /mongo_dbs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: mongo_db_GetPropertySplitable - responses: - "200": - $ref: '#/responses/mongo_db_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - mongo_db - /mongo_dbs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: mongo_db_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/mongo_db_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - mongo_db - /mongo_dbs/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: mongo_db_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/mongo_db_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - mongo_db - /mongo_dbs/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: mongo_db_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/mongo_db_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - mongo_db - /mongo_dbs/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: mongo_db_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/mongo_db_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - mongo_db - /mount_targets: - get: - description: 列表 - operationId: mount_target_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 权限组Id - in: query - name: access_group_id - type: string - x-go-name: AccessGroupId - - description: 以权限组排序 - in: query - name: order_by_access_group - type: string - x-go-name: OrderByAccessGroup - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - description: 文件系统Id - in: query - name: file_system_id - type: string - x-go-name: FileSystemId - responses: - "200": - $ref: '#/responses/mount_target_ListItemFilterOutput' - summary: 列表 - tags: - - mount_target - post: - description: 新建 - operationId: mount_target_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - mount_target: - $ref: '#/definitions/MountTargetCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mount_target_ValidateCreateDataOutput' - summary: 新建 - tags: - - mount_target - /mount_targets/{id}: - delete: - description: 删除 - operationId: mount_target_CustomizeDelete - parameters: - - default: false - description: 是否越过回收站直接删除 - in: query - name: OverridePendingDelete - type: boolean - - default: false - description: 是否仅删除本地资源 - in: query - name: Purge - type: boolean - - default: false - description: 是否删除快照 - in: query - name: DeleteSnapshots - type: boolean - - default: false - description: 是否删除关联的EIP - in: query - name: DeleteEip - type: boolean - - default: false - description: 是否删除关联的数据盘 - in: query - name: DeleteDisks - type: boolean - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mount_target: - $ref: '#/definitions/NatgatewayDeleteInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mount_target_CustomizeDeleteOutput' - summary: 删除挂载点 - tags: - - mount_target - get: - description: 获取详情 - operationId: mount_target_FetchCustomizeColumns - parameters: - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mount_target_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - mount_target - put: - description: 更新 - operationId: mount_target_ValidateUpdateData - parameters: - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mount_target: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mount_target_ValidateUpdateDataOutput' - summary: 更新 - tags: - - mount_target - /mount_targets/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: mount_target_GetDetailsClassMetadata - parameters: - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mount_target_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - mount_target - post: - description: 执行操作ClassMetadata - operationId: mount_target_PerformClassMetadata - parameters: - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mount_target: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mount_target_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - mount_target - /mount_targets/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: mount_target_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 mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mount_target_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - mount_target - /mount_targets/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: mount_target_PerformSetClassMetadata - parameters: - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mount_target: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mount_target_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - mount_target - /mount_targets/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: mount_target_PerformSetUserMetadata - parameters: - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mount_target: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mount_target_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - mount_target - /mount_targets/{id}/status: - get: - description: 获取指定信息Status - operationId: mount_target_GetDetailsStatus - parameters: - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/mount_target_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - mount_target - post: - description: 执行操作Status - operationId: mount_target_PerformStatus - parameters: - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mount_target: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mount_target_PerformStatusOutput' - summary: 更新资源状态 - tags: - - mount_target - /mount_targets/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: mount_target_PerformSyncstatus - parameters: - - description: The Id or Name of mount_target - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - mount_target: - $ref: '#/definitions/MountTargetSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mount_target_PerformSyncstatusOutput' - summary: 同步挂载点状态 - tags: - - mount_target - /mount_targets/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: mount_target_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/mount_target_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - mount_target - /mount_targets/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: mount_target_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - mount_target: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/mount_target_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - mount_target - /mount_targets/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: mount_target_GetPropertySplitable - responses: - "200": - $ref: '#/responses/mount_target_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - mount_target - /mount_targets/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: mount_target_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/mount_target_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - mount_target - /mount_targets/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: mount_target_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/mount_target_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - mount_target - /mount_targets/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: mount_target_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/mount_target_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - mount_target - /mount_targets/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: mount_target_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/mount_target_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - mount_target - /nas_skus: - get: - description: 列表 - operationId: nas_sku_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - in: query - name: postpaid_stauts - type: string - x-go-name: PostpaidStatus - - in: query - name: prepaid_status - type: string - x-go-name: PrepaidStatus - - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - responses: - "200": - $ref: '#/responses/nas_sku_ListItemFilterOutput' - summary: 列表 - tags: - - nas_sku - post: - description: 新建 - operationId: nas_sku_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - nas_sku: - $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_ValidateCreateDataOutput' - summary: 新建 - tags: - - nas_sku - /nas_skus/{id}: - delete: - description: 删除 - operationId: nas_sku_CustomizeDelete - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nas_sku_CustomizeDeleteOutput' - summary: 删除 - tags: - - nas_sku - get: - description: 获取详情 - operationId: nas_sku_FetchCustomizeColumns - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nas_sku_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - nas_sku - put: - description: 更新 - operationId: nas_sku_ValidateUpdateData - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nas_sku: - $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_ValidateUpdateDataOutput' - summary: 更新 - tags: - - nas_sku - /nas_skus/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: nas_sku_GetDetailsClassMetadata - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nas_sku_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - nas_sku - post: - description: 执行操作ClassMetadata - operationId: nas_sku_PerformClassMetadata - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nas_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - nas_sku - /nas_skus/{id}/disable: - post: - description: 执行操作Disable - operationId: nas_sku_PerformDisable - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nas_sku: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_PerformDisableOutput' - summary: 禁用资源 - tags: - - nas_sku - /nas_skus/{id}/enable: - post: - description: 执行操作Enable - operationId: nas_sku_PerformEnable - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nas_sku: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_PerformEnableOutput' - summary: 启用资源 - tags: - - nas_sku - /nas_skus/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: nas_sku_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 nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nas_sku_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - nas_sku - /nas_skus/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: nas_sku_PerformSetClassMetadata - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nas_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - nas_sku - /nas_skus/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: nas_sku_PerformSetUserMetadata - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nas_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - nas_sku - /nas_skus/{id}/status: - get: - description: 获取指定信息Status - operationId: nas_sku_GetDetailsStatus - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nas_sku_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - nas_sku - post: - description: 执行操作Status - operationId: nas_sku_PerformStatus - parameters: - - description: The Id or Name of nas_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nas_sku: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_PerformStatusOutput' - summary: 更新资源状态 - tags: - - nas_sku - /nas_skus/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: nas_sku_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/nas_sku_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - nas_sku - /nas_skus/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: nas_sku_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - nas_sku: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - nas_sku - /nas_skus/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: nas_sku_GetPropertySplitable - responses: - "200": - $ref: '#/responses/nas_sku_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - nas_sku - /nas_skus/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: nas_sku_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/nas_sku_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - nas_sku - /nas_skus/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: nas_sku_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/nas_sku_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - nas_sku - /nas_skus/sync-skus: - post: - description: 执行操作SyncSkus - operationId: nas_sku_PerformSyncSkus - parameters: - - in: body - name: body - schema: - properties: - nas_sku: - $ref: '#/definitions/SkuSyncInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nas_sku_PerformSyncSkusOutput' - summary: 执行操作SyncSkus - tags: - - nas_sku - /nas_skus/sync-tasks: - get: - description: 获取指定资源类的信息SyncTasks - operationId: nas_sku_GetPropertySyncTasks - parameters: - - description: 异步任务ID - in: query - items: - type: string - name: task_ids - type: array - x-go-name: TaskIds - responses: - "200": - $ref: '#/responses/nas_sku_GetPropertySyncTasksOutput' - summary: 获取指定资源类的信息SyncTasks - tags: - - nas_sku - /nas_skus/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: nas_sku_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/nas_sku_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - nas_sku - /nas_skus/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: nas_sku_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/nas_sku_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - nas_sku - /nat_dentries: - get: - description: 列表 - operationId: nat_dentry_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: NAT网关ID or Name - in: query - name: natgateway_id - type: string - x-go-name: NatgatewayId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 以NAT网关名字排序 - in: query - name: order_by_natgateway - type: string - x-go-name: OrderByNatgateway - - in: query - items: - type: string - name: external_ip - type: array - x-go-name: ExternalIP - - in: query - items: - format: int64 - type: integer - name: external_port - type: array - x-go-name: ExternalPort - - in: query - items: - type: string - name: internal_ip - type: array - x-go-name: InternalIP - - in: query - items: - format: int64 - type: integer - name: internal_port - type: array - x-go-name: InternalPort - - in: query - items: - type: string - name: ip_protocol - type: array - x-go-name: IpProtocol - responses: - "200": - $ref: '#/responses/nat_dentry_ListItemFilterOutput' - summary: NAT网关的目的地址转换规则列表 - tags: - - nat_dentry - post: - description: 新建 - operationId: nat_dentry_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - nat_dentry: - $ref: '#/definitions/SNatDCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_ValidateCreateDataOutput' - summary: 新建 - tags: - - nat_dentry - /nat_dentries/{id}: - delete: - description: 删除 - operationId: nat_dentry_CustomizeDelete - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_dentry_CustomizeDeleteOutput' - summary: 删除 - tags: - - nat_dentry - get: - description: 获取详情 - operationId: nat_dentry_FetchCustomizeColumns - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_dentry_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - nat_dentry - put: - description: 更新 - operationId: nat_dentry_ValidateUpdateData - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_dentry: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_ValidateUpdateDataOutput' - summary: 更新 - tags: - - nat_dentry - /nat_dentries/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: nat_dentry_PerformChangeOwner - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_dentry: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - nat_dentry - /nat_dentries/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: nat_dentry_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_dentry_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - nat_dentry - /nat_dentries/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: nat_dentry_GetDetailsClassMetadata - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_dentry_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - nat_dentry - post: - description: 执行操作ClassMetadata - operationId: nat_dentry_PerformClassMetadata - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_dentry: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - nat_dentry - /nat_dentries/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: nat_dentry_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 nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_dentry_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - nat_dentry - /nat_dentries/{id}/private: - post: - description: 执行操作Private - operationId: nat_dentry_PerformPrivate - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_dentry: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_PerformPrivateOutput' - summary: 执行操作Private - tags: - - nat_dentry - /nat_dentries/{id}/public: - post: - description: 执行操作Public - operationId: nat_dentry_PerformPublic - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_dentry: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_PerformPublicOutput' - summary: 执行操作Public - tags: - - nat_dentry - /nat_dentries/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: nat_dentry_PerformSetClassMetadata - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_dentry: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - nat_dentry - /nat_dentries/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: nat_dentry_PerformSetUserMetadata - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_dentry: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - nat_dentry - /nat_dentries/{id}/status: - get: - description: 获取指定信息Status - operationId: nat_dentry_GetDetailsStatus - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_dentry_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - nat_dentry - post: - description: 执行操作Status - operationId: nat_dentry_PerformStatus - parameters: - - description: The Id or Name of nat_dentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_dentry: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_PerformStatusOutput' - summary: 更新资源状态 - tags: - - nat_dentry - /nat_dentries/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: nat_dentry_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/nat_dentry_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - nat_dentry - /nat_dentries/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: nat_dentry_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/nat_dentry_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - nat_dentry - /nat_dentries/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: nat_dentry_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/nat_dentry_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - nat_dentry - /nat_dentries/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: nat_dentry_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - nat_dentry: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_dentry_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - nat_dentry - /nat_dentries/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: nat_dentry_GetPropertySplitable - responses: - "200": - $ref: '#/responses/nat_dentry_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - nat_dentry - /nat_dentries/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: nat_dentry_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/nat_dentry_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - nat_dentry - /nat_dentries/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: nat_dentry_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/nat_dentry_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - nat_dentry - /nat_dentries/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: nat_dentry_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/nat_dentry_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - nat_dentry - /nat_dentries/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: nat_dentry_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/nat_dentry_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - nat_dentry - /nat_entries: - get: - description: 列表 - operationId: nat_entry_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: NAT网关ID or Name - in: query - name: natgateway_id - type: string - x-go-name: NatgatewayId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 以NAT网关名字排序 - in: query - name: order_by_natgateway - type: string - x-go-name: OrderByNatgateway - responses: - "200": - $ref: '#/responses/nat_entry_ListItemFilterOutput' - summary: NAT网关转发规则列表 - tags: - - nat_entry - post: - description: 新建 - operationId: nat_entry_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - nat_entry: - $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_ValidateCreateDataOutput' - summary: 新建 - tags: - - nat_entry - /nat_entries/{id}: - delete: - description: 删除 - operationId: nat_entry_CustomizeDelete - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_entry_CustomizeDeleteOutput' - summary: 删除 - tags: - - nat_entry - get: - description: 获取详情 - operationId: nat_entry_FetchCustomizeColumns - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_entry_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - nat_entry - put: - description: 更新 - operationId: nat_entry_ValidateUpdateData - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_entry: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_ValidateUpdateDataOutput' - summary: 更新 - tags: - - nat_entry - /nat_entries/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: nat_entry_PerformChangeOwner - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_entry: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - nat_entry - /nat_entries/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: nat_entry_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_entry_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - nat_entry - /nat_entries/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: nat_entry_GetDetailsClassMetadata - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_entry_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - nat_entry - post: - description: 执行操作ClassMetadata - operationId: nat_entry_PerformClassMetadata - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_entry: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - nat_entry - /nat_entries/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: nat_entry_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 nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_entry_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - nat_entry - /nat_entries/{id}/private: - post: - description: 执行操作Private - operationId: nat_entry_PerformPrivate - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_entry: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_PerformPrivateOutput' - summary: 执行操作Private - tags: - - nat_entry - /nat_entries/{id}/public: - post: - description: 执行操作Public - operationId: nat_entry_PerformPublic - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_entry: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_PerformPublicOutput' - summary: 执行操作Public - tags: - - nat_entry - /nat_entries/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: nat_entry_PerformSetClassMetadata - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_entry: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - nat_entry - /nat_entries/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: nat_entry_PerformSetUserMetadata - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_entry: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - nat_entry - /nat_entries/{id}/status: - get: - description: 获取指定信息Status - operationId: nat_entry_GetDetailsStatus - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_entry_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - nat_entry - post: - description: 执行操作Status - operationId: nat_entry_PerformStatus - parameters: - - description: The Id or Name of nat_entry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_entry: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_PerformStatusOutput' - summary: 更新资源状态 - tags: - - nat_entry - /nat_entries/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: nat_entry_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/nat_entry_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - nat_entry - /nat_entries/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: nat_entry_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/nat_entry_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - nat_entry - /nat_entries/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: nat_entry_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/nat_entry_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - nat_entry - /nat_entries/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: nat_entry_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - nat_entry: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_entry_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - nat_entry - /nat_entries/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: nat_entry_GetPropertySplitable - responses: - "200": - $ref: '#/responses/nat_entry_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - nat_entry - /nat_entries/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: nat_entry_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/nat_entry_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - nat_entry - /nat_entries/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: nat_entry_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/nat_entry_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - nat_entry - /nat_entries/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: nat_entry_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/nat_entry_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - nat_entry - /nat_entries/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: nat_entry_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/nat_entry_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - nat_entry - /nat_gateways: - get: - description: 列表 - operationId: nat_gateway_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 是否禁止删除 - in: query - name: disable_delete - type: boolean - x-go-name: DisableDelete - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/nat_gateway_ListItemFilterOutput' - summary: NAT网关列表 - tags: - - nat_gateway - post: - description: 新建 - operationId: nat_gateway_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - nat_gateway: - $ref: '#/definitions/NatgatewayCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_ValidateCreateDataOutput' - summary: 新建 - tags: - - nat_gateway - /nat_gateways/{id}: - delete: - description: 删除 - operationId: nat_gateway_CustomizeDelete - parameters: - - default: false - description: 是否越过回收站直接删除 - in: query - name: OverridePendingDelete - type: boolean - - default: false - description: 是否仅删除本地资源 - in: query - name: Purge - type: boolean - - default: false - description: 是否删除快照 - in: query - name: DeleteSnapshots - type: boolean - - default: false - description: 是否删除关联的EIP - in: query - name: DeleteEip - type: boolean - - default: false - description: 是否删除关联的数据盘 - in: query - name: DeleteDisks - type: boolean - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/NatgatewayDeleteInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_CustomizeDeleteOutput' - summary: 删除NAT - tags: - - nat_gateway - get: - description: 获取详情 - operationId: nat_gateway_FetchCustomizeColumns - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_gateway_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - nat_gateway - put: - description: 更新 - operationId: nat_gateway_ValidateUpdateData - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_ValidateUpdateDataOutput' - summary: 更新 - tags: - - nat_gateway - /nat_gateways/{id}/cancel-expire: - post: - description: 执行操作CancelExpire - operationId: nat_gateway_PerformCancelExpire - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_gateway_PerformCancelExpireOutput' - summary: 执行操作CancelExpire - tags: - - nat_gateway - /nat_gateways/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: nat_gateway_PerformChangeOwner - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - nat_gateway - /nat_gateways/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: nat_gateway_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_gateway_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - nat_gateway - /nat_gateways/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: nat_gateway_GetDetailsClassMetadata - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_gateway_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - nat_gateway - post: - description: 执行操作ClassMetadata - operationId: nat_gateway_PerformClassMetadata - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - nat_gateway - /nat_gateways/{id}/dnat-resources: - post: - description: 执行操作DnatResources - operationId: nat_gateway_PerformDnatResources - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_gateway_PerformDnatResourcesOutput' - summary: 执行操作DnatResources - tags: - - nat_gateway - /nat_gateways/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: nat_gateway_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 nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_gateway_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - nat_gateway - /nat_gateways/{id}/postpaid-expire: - post: - description: 执行操作PostpaidExpire - operationId: nat_gateway_PerformPostpaidExpire - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/PostpaidExpireInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformPostpaidExpireOutput' - summary: 执行操作PostpaidExpire - tags: - - nat_gateway - /nat_gateways/{id}/private: - post: - description: 执行操作Private - operationId: nat_gateway_PerformPrivate - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformPrivateOutput' - summary: 执行操作Private - tags: - - nat_gateway - /nat_gateways/{id}/public: - post: - description: 执行操作Public - operationId: nat_gateway_PerformPublic - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformPublicOutput' - summary: 执行操作Public - tags: - - nat_gateway - /nat_gateways/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: nat_gateway_PerformRemoteUpdate - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/MongoDBRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - nat_gateway - /nat_gateways/{id}/renew: - post: - description: 执行操作Renew - operationId: nat_gateway_PerformRenew - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/RenewInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformRenewOutput' - summary: 执行操作Renew - tags: - - nat_gateway - /nat_gateways/{id}/set-auto-renew: - post: - description: |- - 要求NAT状态为available - 要求NAT计费类型为包年包月(预付费) - operationId: nat_gateway_PerformSetAutoRenew - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/AutoRenewInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformSetAutoRenewOutput' - summary: 设置自动续费 - tags: - - nat_gateway - /nat_gateways/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: nat_gateway_PerformSetClassMetadata - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - nat_gateway - /nat_gateways/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: nat_gateway_PerformSetUserMetadata - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - nat_gateway - /nat_gateways/{id}/snat-resources: - post: - description: 执行操作SnatResources - operationId: nat_gateway_PerformSnatResources - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_gateway_PerformSnatResourcesOutput' - summary: 执行操作SnatResources - tags: - - nat_gateway - /nat_gateways/{id}/status: - get: - description: 获取指定信息Status - operationId: nat_gateway_GetDetailsStatus - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_gateway_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - nat_gateway - post: - description: 执行操作Status - operationId: nat_gateway_PerformStatus - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformStatusOutput' - summary: 更新资源状态 - tags: - - nat_gateway - /nat_gateways/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: nat_gateway_PerformSyncstatus - parameters: - - description: The Id or Name of nat_gateway - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/NatGatewaySyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformSyncstatusOutput' - summary: 同步NAT网关状态 - tags: - - nat_gateway - /nat_gateways/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: nat_gateway_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/nat_gateway_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - nat_gateway - /nat_gateways/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: nat_gateway_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/nat_gateway_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - nat_gateway - /nat_gateways/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: nat_gateway_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/nat_gateway_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - nat_gateway - /nat_gateways/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: nat_gateway_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - nat_gateway: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_gateway_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - nat_gateway - /nat_gateways/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: nat_gateway_GetPropertySplitable - responses: - "200": - $ref: '#/responses/nat_gateway_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - nat_gateway - /nat_gateways/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: nat_gateway_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/nat_gateway_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - nat_gateway - /nat_gateways/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: nat_gateway_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/nat_gateway_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - nat_gateway - /nat_gateways/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: nat_gateway_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/nat_gateway_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - nat_gateway - /nat_gateways/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: nat_gateway_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/nat_gateway_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - nat_gateway - /nat_sentries: - get: - description: 列表 - operationId: nat_sentry_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: NAT网关ID or Name - in: query - name: natgateway_id - type: string - x-go-name: NatgatewayId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 以NAT网关名字排序 - in: query - name: order_by_natgateway - type: string - x-go-name: OrderByNatgateway - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - in: query - items: - type: string - name: ip - type: array - x-go-name: IP - - in: query - items: - type: string - name: source_cidr - type: array - x-go-name: SourceCIDR - responses: - "200": - $ref: '#/responses/nat_sentry_ListItemFilterOutput' - summary: NAT网关的源地址转换规则列表 - tags: - - nat_sentry - post: - description: 新建 - operationId: nat_sentry_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - nat_sentry: - $ref: '#/definitions/SNatSCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_ValidateCreateDataOutput' - summary: 新建 - tags: - - nat_sentry - /nat_sentries/{id}: - delete: - description: 删除 - operationId: nat_sentry_CustomizeDelete - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sentry_CustomizeDeleteOutput' - summary: 删除 - tags: - - nat_sentry - get: - description: 获取详情 - operationId: nat_sentry_FetchCustomizeColumns - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sentry_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - nat_sentry - put: - description: 更新 - operationId: nat_sentry_ValidateUpdateData - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sentry: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_ValidateUpdateDataOutput' - summary: 更新 - tags: - - nat_sentry - /nat_sentries/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: nat_sentry_PerformChangeOwner - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sentry: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - nat_sentry - /nat_sentries/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: nat_sentry_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sentry_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - nat_sentry - /nat_sentries/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: nat_sentry_GetDetailsClassMetadata - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sentry_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - nat_sentry - post: - description: 执行操作ClassMetadata - operationId: nat_sentry_PerformClassMetadata - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sentry: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - nat_sentry - /nat_sentries/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: nat_sentry_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 nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sentry_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - nat_sentry - /nat_sentries/{id}/private: - post: - description: 执行操作Private - operationId: nat_sentry_PerformPrivate - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sentry: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_PerformPrivateOutput' - summary: 执行操作Private - tags: - - nat_sentry - /nat_sentries/{id}/public: - post: - description: 执行操作Public - operationId: nat_sentry_PerformPublic - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sentry: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_PerformPublicOutput' - summary: 执行操作Public - tags: - - nat_sentry - /nat_sentries/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: nat_sentry_PerformSetClassMetadata - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sentry: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - nat_sentry - /nat_sentries/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: nat_sentry_PerformSetUserMetadata - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sentry: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - nat_sentry - /nat_sentries/{id}/status: - get: - description: 获取指定信息Status - operationId: nat_sentry_GetDetailsStatus - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sentry_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - nat_sentry - post: - description: 执行操作Status - operationId: nat_sentry_PerformStatus - parameters: - - description: The Id or Name of nat_sentry - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sentry: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_PerformStatusOutput' - summary: 更新资源状态 - tags: - - nat_sentry - /nat_sentries/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: nat_sentry_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/nat_sentry_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - nat_sentry - /nat_sentries/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: nat_sentry_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/nat_sentry_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - nat_sentry - /nat_sentries/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: nat_sentry_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/nat_sentry_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - nat_sentry - /nat_sentries/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: nat_sentry_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - nat_sentry: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sentry_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - nat_sentry - /nat_sentries/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: nat_sentry_GetPropertySplitable - responses: - "200": - $ref: '#/responses/nat_sentry_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - nat_sentry - /nat_sentries/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: nat_sentry_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/nat_sentry_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - nat_sentry - /nat_sentries/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: nat_sentry_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/nat_sentry_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - nat_sentry - /nat_sentries/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: nat_sentry_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/nat_sentry_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - nat_sentry - /nat_sentries/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: nat_sentry_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/nat_sentry_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - nat_sentry - /nat_skus: - get: - description: 列表 - operationId: nat_sku_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - in: query - name: postpaid_stauts - type: string - x-go-name: PostpaidStatus - - in: query - name: prepaid_status - type: string - x-go-name: PrepaidStatus - - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - responses: - "200": - $ref: '#/responses/nat_sku_ListItemFilterOutput' - summary: 列表 - tags: - - nat_sku - post: - description: 新建 - operationId: nat_sku_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - nat_sku: - $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_ValidateCreateDataOutput' - summary: 新建 - tags: - - nat_sku - /nat_skus/{id}: - delete: - description: 删除 - operationId: nat_sku_CustomizeDelete - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sku_CustomizeDeleteOutput' - summary: 删除 - tags: - - nat_sku - get: - description: 获取详情 - operationId: nat_sku_FetchCustomizeColumns - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sku_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - nat_sku - put: - description: 更新 - operationId: nat_sku_ValidateUpdateData - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sku: - $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_ValidateUpdateDataOutput' - summary: 更新 - tags: - - nat_sku - /nat_skus/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: nat_sku_GetDetailsClassMetadata - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sku_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - nat_sku - post: - description: 执行操作ClassMetadata - operationId: nat_sku_PerformClassMetadata - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - nat_sku - /nat_skus/{id}/disable: - post: - description: 执行操作Disable - operationId: nat_sku_PerformDisable - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sku: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_PerformDisableOutput' - summary: 禁用资源 - tags: - - nat_sku - /nat_skus/{id}/enable: - post: - description: 执行操作Enable - operationId: nat_sku_PerformEnable - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sku: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_PerformEnableOutput' - summary: 启用资源 - tags: - - nat_sku - /nat_skus/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: nat_sku_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 nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sku_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - nat_sku - /nat_skus/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: nat_sku_PerformSetClassMetadata - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - nat_sku - /nat_skus/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: nat_sku_PerformSetUserMetadata - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - nat_sku - /nat_skus/{id}/status: - get: - description: 获取指定信息Status - operationId: nat_sku_GetDetailsStatus - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/nat_sku_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - nat_sku - post: - description: 执行操作Status - operationId: nat_sku_PerformStatus - parameters: - - description: The Id or Name of nat_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - nat_sku: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_PerformStatusOutput' - summary: 更新资源状态 - tags: - - nat_sku - /nat_skus/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: nat_sku_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/nat_sku_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - nat_sku - /nat_skus/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: nat_sku_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - nat_sku: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - nat_sku - /nat_skus/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: nat_sku_GetPropertySplitable - responses: - "200": - $ref: '#/responses/nat_sku_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - nat_sku - /nat_skus/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: nat_sku_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/nat_sku_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - nat_sku - /nat_skus/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: nat_sku_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/nat_sku_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - nat_sku - /nat_skus/sync-skus: - post: - description: 执行操作SyncSkus - operationId: nat_sku_PerformSyncSkus - parameters: - - in: body - name: body - schema: - properties: - nat_sku: - $ref: '#/definitions/SkuSyncInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/nat_sku_PerformSyncSkusOutput' - summary: 执行操作SyncSkus - tags: - - nat_sku - /nat_skus/sync-tasks: - get: - description: 获取指定资源类的信息SyncTasks - operationId: nat_sku_GetPropertySyncTasks - parameters: - - description: 异步任务ID - in: query - items: - type: string - name: task_ids - type: array - x-go-name: TaskIds - responses: - "200": - $ref: '#/responses/nat_sku_GetPropertySyncTasksOutput' - summary: 获取指定资源类的信息SyncTasks - tags: - - nat_sku - /nat_skus/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: nat_sku_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/nat_sku_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - nat_sku - /nat_skus/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: nat_sku_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/nat_sku_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - nat_sku - /net_tap_flows: - get: - description: 列表 - operationId: net_tap_flow_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 - - in: query - name: tap_id - type: string - x-go-name: TapId - - in: query - name: host_id - type: string - x-go-name: HostId - responses: - "200": - $ref: '#/responses/net_tap_flow_ListItemFilterOutput' - summary: 列表 - tags: - - net_tap_flow - post: - description: 新建 - operationId: net_tap_flow_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - net_tap_flow: - $ref: '#/definitions/NetTapFlowCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_flow_ValidateCreateDataOutput' - summary: 新建 - tags: - - net_tap_flow - /net_tap_flows/{id}: - delete: - description: 删除 - operationId: net_tap_flow_CustomizeDelete - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_flow_CustomizeDeleteOutput' - summary: 删除 - tags: - - net_tap_flow - get: - description: 获取详情 - operationId: net_tap_flow_FetchCustomizeColumns - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_flow_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - net_tap_flow - put: - description: 更新 - operationId: net_tap_flow_ValidateUpdateData - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_flow: - $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_flow_ValidateUpdateDataOutput' - summary: 更新 - tags: - - net_tap_flow - /net_tap_flows/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: net_tap_flow_GetDetailsClassMetadata - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_flow_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - net_tap_flow - post: - description: 执行操作ClassMetadata - operationId: net_tap_flow_PerformClassMetadata - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_flow: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_flow_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - net_tap_flow - /net_tap_flows/{id}/disable: - post: - description: 执行操作Disable - operationId: net_tap_flow_PerformDisable - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_flow: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_flow_PerformDisableOutput' - summary: 禁用资源 - tags: - - net_tap_flow - /net_tap_flows/{id}/enable: - post: - description: 执行操作Enable - operationId: net_tap_flow_PerformEnable - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_flow: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_flow_PerformEnableOutput' - summary: 启用资源 - tags: - - net_tap_flow - /net_tap_flows/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: net_tap_flow_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 net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_flow_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - net_tap_flow - /net_tap_flows/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: net_tap_flow_PerformSetClassMetadata - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_flow: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_flow_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - net_tap_flow - /net_tap_flows/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: net_tap_flow_PerformSetUserMetadata - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_flow: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_flow_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - net_tap_flow - /net_tap_flows/{id}/status: - get: - description: 获取指定信息Status - operationId: net_tap_flow_GetDetailsStatus - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_flow_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - net_tap_flow - post: - description: 执行操作Status - operationId: net_tap_flow_PerformStatus - parameters: - - description: The Id or Name of net_tap_flow - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_flow: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_flow_PerformStatusOutput' - summary: 更新资源状态 - tags: - - net_tap_flow - /net_tap_flows/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: net_tap_flow_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/net_tap_flow_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - net_tap_flow - /net_tap_flows/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: net_tap_flow_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - net_tap_flow: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_flow_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - net_tap_flow - /net_tap_flows/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: net_tap_flow_GetPropertySplitable - responses: - "200": - $ref: '#/responses/net_tap_flow_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - net_tap_flow - /net_tap_flows/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: net_tap_flow_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/net_tap_flow_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - net_tap_flow - /net_tap_flows/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: net_tap_flow_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/net_tap_flow_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - net_tap_flow - /net_tap_flows/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: net_tap_flow_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/net_tap_flow_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - net_tap_flow - /net_tap_flows/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: net_tap_flow_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/net_tap_flow_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - net_tap_flow - /net_tap_services: - get: - description: 列表 - operationId: net_tap_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: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - in: query - name: host_id - type: string - x-go-name: HostId - - description: 按目的ip地址排序 - in: query - name: order_by_ip - pattern: asc|desc - type: string - x-go-name: OrderByIp - - description: 按镜像源数量排序 - in: query - name: order_by_flow_count - pattern: asc|desc - type: string - x-go-name: OrderByFlowCount - responses: - "200": - $ref: '#/responses/net_tap_service_ListItemFilterOutput' - summary: 列表 - tags: - - net_tap_service - post: - description: 新建 - operationId: net_tap_service_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - net_tap_service: - $ref: '#/definitions/NetTapServiceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_service_ValidateCreateDataOutput' - summary: 新建 - tags: - - net_tap_service - /net_tap_services/{id}: - delete: - description: 删除 - operationId: net_tap_service_CustomizeDelete - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_service_CustomizeDeleteOutput' - summary: 删除 - tags: - - net_tap_service - get: - description: 获取详情 - operationId: net_tap_service_FetchCustomizeColumns - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_service_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - net_tap_service - put: - description: 更新 - operationId: net_tap_service_ValidateUpdateData - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_service: - $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_service_ValidateUpdateDataOutput' - summary: 更新 - tags: - - net_tap_service - /net_tap_services/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: net_tap_service_GetDetailsClassMetadata - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_service_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - net_tap_service - post: - description: 执行操作ClassMetadata - operationId: net_tap_service_PerformClassMetadata - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_service: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_service_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - net_tap_service - /net_tap_services/{id}/disable: - post: - description: 执行操作Disable - operationId: net_tap_service_PerformDisable - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_service: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_service_PerformDisableOutput' - summary: 执行操作Disable - tags: - - net_tap_service - /net_tap_services/{id}/enable: - post: - description: 执行操作Enable - operationId: net_tap_service_PerformEnable - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_service: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_service_PerformEnableOutput' - summary: 执行操作Enable - tags: - - net_tap_service - /net_tap_services/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: net_tap_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 net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_service_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - net_tap_service - /net_tap_services/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: net_tap_service_PerformSetClassMetadata - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_service: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_service_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - net_tap_service - /net_tap_services/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: net_tap_service_PerformSetUserMetadata - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_service: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_service_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - net_tap_service - /net_tap_services/{id}/status: - get: - description: 获取指定信息Status - operationId: net_tap_service_GetDetailsStatus - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/net_tap_service_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - net_tap_service - post: - description: 执行操作Status - operationId: net_tap_service_PerformStatus - parameters: - - description: The Id or Name of net_tap_service - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - net_tap_service: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_service_PerformStatusOutput' - summary: 更新资源状态 - tags: - - net_tap_service - /net_tap_services/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: net_tap_service_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/net_tap_service_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - net_tap_service - /net_tap_services/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: net_tap_service_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - net_tap_service: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/net_tap_service_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - net_tap_service - /net_tap_services/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: net_tap_service_GetPropertySplitable - responses: - "200": - $ref: '#/responses/net_tap_service_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - net_tap_service - /net_tap_services/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: net_tap_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/net_tap_service_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - net_tap_service - /net_tap_services/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: net_tap_service_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/net_tap_service_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - net_tap_service - /net_tap_services/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: net_tap_service_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/net_tap_service_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - net_tap_service - /net_tap_services/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: net_tap_service_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/net_tap_service_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - net_tap_service - /network_addresses: - get: - description: 列表 - operationId: network_address_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: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - in: query - items: - type: string - name: GuestId - type: array - responses: - "200": - $ref: '#/responses/network_address_ListItemFilterOutput' - summary: 列表 - tags: - - network_address - post: - description: 新建 - operationId: network_address_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - network_address: - $ref: '#/definitions/NetworkAddressCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_address_ValidateCreateDataOutput' - summary: 新建 - tags: - - network_address - /network_addresses/{id}: - delete: - description: 删除 - operationId: network_address_CustomizeDelete - parameters: - - description: The Id or Name of network_address - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_address_CustomizeDeleteOutput' - summary: 删除 - tags: - - network_address - get: - description: 获取详情 - operationId: network_address_FetchCustomizeColumns - parameters: - - description: The Id or Name of network_address - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_address_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - network_address - put: - description: 更新 - operationId: network_address_ValidateUpdateData - parameters: - - description: The Id or Name of network_address - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_address: - $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_address_ValidateUpdateDataOutput' - summary: 更新 - tags: - - network_address - /network_addresses/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: network_address_GetDetailsClassMetadata - parameters: - - description: The Id or Name of network_address - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_address_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - network_address - post: - description: 执行操作ClassMetadata - operationId: network_address_PerformClassMetadata - parameters: - - description: The Id or Name of network_address - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_address: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_address_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - network_address - /network_addresses/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: network_address_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 network_address - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_address_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - network_address - /network_addresses/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: network_address_PerformSetClassMetadata - parameters: - - description: The Id or Name of network_address - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_address: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_address_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - network_address - /network_addresses/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: network_address_PerformSetUserMetadata - parameters: - - description: The Id or Name of network_address - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_address: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_address_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - network_address - /network_addresses/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: network_address_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/network_address_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - network_address - /network_addresses/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: network_address_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - network_address: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_address_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - network_address - /network_addresses/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: network_address_GetPropertySplitable - responses: - "200": - $ref: '#/responses/network_address_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - network_address - /network_addresses/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: network_address_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/network_address_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - network_address - /network_addresses/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: network_address_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/network_address_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - network_address - /network_addresses/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: network_address_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/network_address_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - network_address - /network_interfaces: - get: - description: 列表 - operationId: network_interface_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: MAC地址 - in: query - items: - type: string - name: mac - type: array - x-go-name: Mac - - description: 绑定资源类型 - in: query - items: - type: string - name: associate_type - type: array - x-go-name: AssociateType - - description: 绑定资源Id - in: query - items: - type: string - name: associate_id - type: array - x-go-name: AssociateId - responses: - "200": - $ref: '#/responses/network_interface_ListItemFilterOutput' - summary: 虚拟网卡列表 - tags: - - network_interface - post: - description: 新建 - operationId: network_interface_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - network_interface: - $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_ValidateCreateDataOutput' - summary: 新建 - tags: - - network_interface - /network_interfaces/{id}: - delete: - description: 删除 - operationId: network_interface_CustomizeDelete - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_interface_CustomizeDeleteOutput' - summary: 删除 - tags: - - network_interface - get: - description: 获取详情 - operationId: network_interface_FetchCustomizeColumns - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_interface_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - network_interface - put: - description: 更新 - operationId: network_interface_ValidateUpdateData - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_interface: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_ValidateUpdateDataOutput' - summary: 更新 - tags: - - network_interface - /network_interfaces/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: network_interface_PerformChangeOwner - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_interface: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - network_interface - /network_interfaces/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: network_interface_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_interface_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - network_interface - /network_interfaces/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: network_interface_GetDetailsClassMetadata - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_interface_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - network_interface - post: - description: 执行操作ClassMetadata - operationId: network_interface_PerformClassMetadata - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_interface: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - network_interface - /network_interfaces/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: network_interface_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 network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_interface_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - network_interface - /network_interfaces/{id}/private: - post: - description: 执行操作Private - operationId: network_interface_PerformPrivate - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_interface: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_PerformPrivateOutput' - summary: 执行操作Private - tags: - - network_interface - /network_interfaces/{id}/public: - post: - description: 执行操作Public - operationId: network_interface_PerformPublic - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_interface: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_PerformPublicOutput' - summary: 执行操作Public - tags: - - network_interface - /network_interfaces/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: network_interface_PerformSetClassMetadata - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_interface: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - network_interface - /network_interfaces/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: network_interface_PerformSetUserMetadata - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_interface: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - network_interface - /network_interfaces/{id}/status: - get: - description: 获取指定信息Status - operationId: network_interface_GetDetailsStatus - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_interface_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - network_interface - post: - description: 执行操作Status - operationId: network_interface_PerformStatus - parameters: - - description: The Id or Name of network_interface - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_interface: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_PerformStatusOutput' - summary: 更新资源状态 - tags: - - network_interface - /network_interfaces/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: network_interface_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/network_interface_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - network_interface - /network_interfaces/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: network_interface_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/network_interface_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - network_interface - /network_interfaces/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: network_interface_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/network_interface_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - network_interface - /network_interfaces/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: network_interface_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - network_interface: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_interface_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - network_interface - /network_interfaces/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: network_interface_GetPropertySplitable - responses: - "200": - $ref: '#/responses/network_interface_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - network_interface - /network_interfaces/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: network_interface_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/network_interface_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - network_interface - /network_interfaces/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: network_interface_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/network_interface_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - network_interface - /network_interfaces/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: network_interface_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/network_interface_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - network_interface - /network_interfaces/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: network_interface_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/network_interface_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - network_interface - /network_ip_macs: - get: - description: 列表 - operationId: network_ip_mac_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 - - in: query - name: network_id - type: string - x-go-name: NetworkId - - in: query - items: - type: string - name: mac_addr - type: array - x-go-name: MacAddr - - in: query - items: - type: string - name: ip_addr - type: array - x-go-name: IpAddr - responses: - "200": - $ref: '#/responses/network_ip_mac_ListItemFilterOutput' - summary: 列表 - tags: - - network_ip_mac - post: - description: 新建 - operationId: network_ip_mac_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - network_ip_mac: - $ref: '#/definitions/NetworkIpMacCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_ip_mac_ValidateCreateDataOutput' - summary: 新建 - tags: - - network_ip_mac - /network_ip_macs/{id}: - delete: - description: 删除 - operationId: network_ip_mac_CustomizeDelete - parameters: - - description: The Id or Name of network_ip_mac - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_ip_mac_CustomizeDeleteOutput' - summary: 删除 - tags: - - network_ip_mac - get: - description: 获取详情 - operationId: network_ip_mac_FetchCustomizeColumns - parameters: - - description: The Id or Name of network_ip_mac - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_ip_mac_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - network_ip_mac - put: - description: 更新 - operationId: network_ip_mac_ValidateUpdateData - parameters: - - description: The Id or Name of network_ip_mac - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_ip_mac: - $ref: '#/definitions/NetworkIpMacUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_ip_mac_ValidateUpdateDataOutput' - summary: 更新 - tags: - - network_ip_mac - /network_ip_macs/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: network_ip_mac_GetDetailsClassMetadata - parameters: - - description: The Id or Name of network_ip_mac - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_ip_mac_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - network_ip_mac - post: - description: 执行操作ClassMetadata - operationId: network_ip_mac_PerformClassMetadata - parameters: - - description: The Id or Name of network_ip_mac - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_ip_mac: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_ip_mac_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - network_ip_mac - /network_ip_macs/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: network_ip_mac_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 network_ip_mac - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_ip_mac_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - network_ip_mac - /network_ip_macs/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: network_ip_mac_PerformSetClassMetadata - parameters: - - description: The Id or Name of network_ip_mac - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_ip_mac: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_ip_mac_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - network_ip_mac - /network_ip_macs/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: network_ip_mac_PerformSetUserMetadata - parameters: - - description: The Id or Name of network_ip_mac - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network_ip_mac: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_ip_mac_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - network_ip_mac - /network_ip_macs/batch-create: - post: - description: 执行操作BatchCreate - operationId: network_ip_mac_PerformBatchCreate - parameters: - - in: body - name: body - schema: - properties: - network_ip_mac: - $ref: '#/definitions/NetworkIpMacBatchCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_ip_mac_PerformBatchCreateOutput' - summary: 执行操作BatchCreate - tags: - - network_ip_mac - /network_ip_macs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: network_ip_mac_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/network_ip_mac_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - network_ip_mac - /network_ip_macs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: network_ip_mac_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - network_ip_mac: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_ip_mac_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - network_ip_mac - /network_ip_macs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: network_ip_mac_GetPropertySplitable - responses: - "200": - $ref: '#/responses/network_ip_mac_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - network_ip_mac - /network_ip_macs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: network_ip_mac_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/network_ip_mac_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - network_ip_mac - /network_ip_macs/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: network_ip_mac_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/network_ip_mac_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - network_ip_mac - /network_ip_macs/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: network_ip_mac_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/network_ip_mac_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - network_ip_mac - /networkinterfacenetworks: - get: - description: 列表 - operationId: networkinterfacenetwork_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/networkinterfacenetwork_ListItemFilterOutput' - summary: 列表 - tags: - - networkinterfacenetwork - post: - description: 新建 - operationId: networkinterfacenetwork_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - networkinterfacenetwork: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/networkinterfacenetwork_ValidateCreateDataOutput' - summary: 新建 - tags: - - networkinterfacenetwork - /networkinterfacenetworks/{id}: - delete: - description: 删除 - operationId: networkinterfacenetwork_CustomizeDelete - parameters: - - description: The Id or Name of networkinterfacenetwork - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/networkinterfacenetwork_CustomizeDeleteOutput' - summary: 删除 - tags: - - networkinterfacenetwork - get: - description: 获取详情 - operationId: networkinterfacenetwork_FetchCustomizeColumns - parameters: - - description: The Id or Name of networkinterfacenetwork - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/networkinterfacenetwork_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - networkinterfacenetwork - put: - description: 更新 - operationId: networkinterfacenetwork_ValidateUpdateData - parameters: - - description: The Id or Name of networkinterfacenetwork - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - networkinterfacenetwork: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/networkinterfacenetwork_ValidateUpdateDataOutput' - summary: 更新 - tags: - - networkinterfacenetwork - /networkinterfacenetworks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: networkinterfacenetwork_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/networkinterfacenetwork_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - networkinterfacenetwork - /networkinterfacenetworks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: networkinterfacenetwork_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - networkinterfacenetwork: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/networkinterfacenetwork_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - networkinterfacenetwork - /networkinterfacenetworks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: networkinterfacenetwork_GetPropertySplitable - responses: - "200": - $ref: '#/responses/networkinterfacenetwork_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - networkinterfacenetwork - /networkinterfacenetworks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: networkinterfacenetwork_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/networkinterfacenetwork_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - networkinterfacenetwork - /networks: - get: - description: 列表 - operationId: network_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 以关联的调度标签（ID或Name）过滤列表 - in: query - name: schedtag_id - type: string - x-go-name: SchedtagId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 存储（ID或Name） - in: query - name: storage_id - type: string - x-go-name: StorageId - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: filter by route table which associate with it - in: query - name: route_table_id - type: string - x-go-name: RouteTableId - - description: 'description: Exact matching ip address in network.' - example: 10.168.222.1 - in: query - name: ip - type: string - x-go-name: Ip - - description: 'description: Fuzzy matching ip address in network.' - example: 10.168.222.1 - in: query - name: ip_match - type: string - x-go-name: IpMatch - - in: query - items: - type: string - name: ifname_hint - type: array - x-go-name: IfnameHint - - description: 起始IP地址 - in: query - items: - type: string - name: guest_ip_start - type: array - x-go-name: GuestIpStart - - description: 接收IP地址 - in: query - items: - type: string - name: guest_ip_end - type: array - x-go-name: GuestIpEnd - - description: 掩码 - in: query - items: - format: int8 - type: integer - name: guest_ip_mask - type: array - x-go-name: GuestIpMask - - description: 网关地址 - in: query - name: guest_gateway - type: string - x-go-name: GuestGateway - - description: DNS - in: query - items: - type: string - name: guest_dns - type: array - x-go-name: GuestDns - - description: allow multiple dhcp, seperated by "," - in: query - items: - type: string - name: guest_dhcp - type: array - x-go-name: GuestDhcp - - description: NTP - in: query - items: - type: string - name: guest_ntp - type: array - x-go-name: GuestNtp - - in: query - items: - type: string - name: guest_domain - type: array - x-go-name: GuestDomain - - in: query - items: - type: string - name: guest_ip6_start - type: array - x-go-name: GuestIp6Start - - in: query - items: - type: string - name: guest_ip6_end - type: array - x-go-name: GuestIp6End - - in: query - items: - format: int8 - type: integer - name: guest_ip6_mask - type: array - x-go-name: GuestIp6Mask - - in: query - items: - type: string - name: guest_gateway6 - type: array - x-go-name: GuestGateway6 - - in: query - items: - type: string - name: guest_dns6 - type: array - x-go-name: GuestDns6 - - in: query - items: - type: string - name: guest_domain6 - type: array - x-go-name: GuestDomain6 - - description: vlanId 1~4096 - in: query - items: - format: int64 - type: integer - name: vlan_id - type: array - x-go-name: VlanId - - description: 服务器类型 - example: server - in: query - items: - type: string - name: server_type - type: array - x-go-name: ServerType - - description: 分配策略 - in: query - items: - type: string - name: alloc_policy - type: array - x-go-name: AllocPolicy - - description: 是否加入自动分配地址池 - in: query - name: is_auto_alloc - type: boolean - x-go-name: IsAutoAlloc - - description: 是否为基础网络（underlay） - in: query - name: is_classic - type: boolean - x-go-name: IsClassic - - description: filter by Host schedtag - in: query - name: host_schedtag_id - type: string - x-go-name: HostSchedtagId - - description: filter by BGP types - in: query - items: - type: string - name: bgp_type - type: array - x-go-name: BgpType - - in: query - name: host_type - type: string - x-go-name: HostType - - description: 按起始ip地址排序 - in: query - name: order_by_ip_start - pattern: asc|desc - type: string - x-go-name: OrderByIpStart - - description: 按终止ip地址排序 - in: query - name: order_by_ip_end - pattern: asc|desc - type: string - x-go-name: OrderByIpEnd - responses: - "200": - $ref: '#/responses/network_ListItemFilterOutput' - summary: IP子网列表 - tags: - - network - post: - description: 新建 - operationId: network_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - network: - $ref: '#/definitions/NetworkCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_ValidateCreateDataOutput' - summary: 新建 - tags: - - network - /networks/{id}: - delete: - description: 删除 - operationId: network_CustomizeDelete - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_CustomizeDeleteOutput' - summary: 删除 - tags: - - network - get: - description: 获取详情 - operationId: network_FetchCustomizeColumns - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - network - put: - description: 更新 - operationId: network_ValidateUpdateData - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_ValidateUpdateDataOutput' - summary: 更新 - tags: - - network - /networks/{id}/addresses: - get: - description: 获取指定信息Addresses - operationId: network_GetDetailsAddresses - parameters: - - description: 获取资源的范围，例如 project|domain|system - in: query - name: scope - type: string - x-go-name: Scope - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_GetDetailsAddressesOutput' - summary: 获取指定信息Addresses - tags: - - network - /networks/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: network_PerformCancelDelete - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - network - /networks/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: network_PerformChangeOwner - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - network - /networks/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: network_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - network - /networks/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: network_GetDetailsClassMetadata - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - network - post: - description: 执行操作ClassMetadata - operationId: network_PerformClassMetadata - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - network - /networks/{id}/freeze: - post: - description: 执行操作Freeze - operationId: network_PerformFreeze - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - network - /networks/{id}/merge: - post: - description: 将两个相连的IP子网合并成一个IP子网 - operationId: network_PerformMerge - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkMergeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformMergeOutput' - summary: 合并IP子网 - tags: - - network - /networks/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: network_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 network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - network - /networks/{id}/private: - post: - description: 执行操作Private - operationId: network_PerformPrivate - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformPrivateOutput' - summary: 执行操作Private - tags: - - network - /networks/{id}/public: - post: - description: 执行操作Public - operationId: network_PerformPublic - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformPublicOutput' - summary: 执行操作Public - tags: - - network - /networks/{id}/purge: - post: - description: 要求IP子网内没有被分配IP,若清除接入云,要求接入云账号处于禁用状态 - operationId: network_PerformPurge - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkPurgeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformPurgeOutput' - summary: 清除IP子网数据 - tags: - - network - /networks/{id}/release-reserved-ip: - post: - description: 执行操作ReleaseReservedIp - operationId: network_PerformReleaseReservedIp - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkReleaseReservedIpInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformReleaseReservedIpOutput' - summary: 释放预留IP - tags: - - network - /networks/{id}/reserve-ip: - post: - description: 预留的IP不会被调度使用 - operationId: network_PerformReserveIp - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkReserveIpInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformReserveIpOutput' - summary: 预留IP - tags: - - network - /networks/{id}/reserved-ips: - get: - description: 获取指定信息ReservedIps - operationId: network_GetDetailsReservedIps - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_GetDetailsReservedIpsOutput' - summary: 获取指定信息ReservedIps - tags: - - network - /networks/{id}/set-bgp-type: - post: - description: 执行操作SetBgpType - operationId: network_PerformSetBgpType - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkSetBgpTypeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformSetBgpTypeOutput' - summary: 执行操作SetBgpType - tags: - - network - /networks/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: network_PerformSetClassMetadata - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - network - /networks/{id}/set-schedtag: - post: - description: 执行操作SetSchedtag - operationId: network_PerformSetSchedtag - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_PerformSetSchedtagOutput' - summary: 执行操作SetSchedtag - tags: - - network - /networks/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: network_PerformSetUserMetadata - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - network - /networks/{id}/split: - post: - description: 将一个IP子网分割成两个子网,仅本地IDC支持此操作 - operationId: network_PerformSplit - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkSplitInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformSplitOutput' - summary: 分割IP子网 - tags: - - network - /networks/{id}/status: - get: - description: 获取指定信息Status - operationId: network_GetDetailsStatus - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/network_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - network - post: - description: 执行操作Status - operationId: network_PerformStatus - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformStatusOutput' - summary: 更改IP子网状态 - tags: - - network - /networks/{id}/switch-wire: - post: - description: 执行操作SwitchWire - operationId: network_PerformSwitchWire - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkSwitchWireInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformSwitchWireOutput' - summary: 执行操作SwitchWire - tags: - - network - /networks/{id}/sync: - post: - description: 本地IDC不支持此操作 - operationId: network_PerformSync - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkSyncInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformSyncOutput' - summary: 同步接入云IP子网状态 - tags: - - network - /networks/{id}/syncstatus: - post: - description: 本地IDC不支持此操作 - operationId: network_PerformSyncstatus - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkSyncInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformSyncstatusOutput' - summary: 同步接入云IP子网状态 - tags: - - network - /networks/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: network_PerformUnfreeze - parameters: - - description: The Id or Name of network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - network - /networks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: network_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/network_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - network - /networks/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: network_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/network_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - network - /networks/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: network_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/network_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - network - /networks/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: network_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/network_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - network - /networks/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: network_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/network_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - network - /networks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: network_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - network - /networks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: network_GetPropertySplitable - responses: - "200": - $ref: '#/responses/network_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - network - /networks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: network_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/network_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - network - /networks/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: network_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/network_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - network - /networks/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: network_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/network_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - network - /networks/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: network_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/network_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - network - /networks/try-create-network: - post: - description: 执行操作TryCreateNetwork - operationId: network_PerformTryCreateNetwork - parameters: - - in: body - name: body - schema: - properties: - network: - $ref: '#/definitions/NetworkTryCreateNetworkInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/network_PerformTryCreateNetworkOutput' - summary: 执行操作TryCreateNetwork - tags: - - network - /policy_assignments: - get: - description: 列表 - operationId: policy_assignment_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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - in: query - name: Policydefinition - type: string - responses: - "200": - $ref: '#/responses/policy_assignment_ListItemFilterOutput' - summary: 策略分配列表 - tags: - - policy_assignment - post: - description: 新建 - operationId: policy_assignment_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - policy_assignment: - $ref: '#/definitions/PolicyAssignmentCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_assignment_ValidateCreateDataOutput' - summary: 新建 - tags: - - policy_assignment - /policy_assignments/{id}: - delete: - description: 删除 - operationId: policy_assignment_CustomizeDelete - parameters: - - description: The Id or Name of policy_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_assignment_CustomizeDeleteOutput' - summary: 删除 - tags: - - policy_assignment - get: - description: 获取详情 - operationId: policy_assignment_FetchCustomizeColumns - parameters: - - description: The Id or Name of policy_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_assignment_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - policy_assignment - put: - description: 更新 - operationId: policy_assignment_ValidateUpdateData - parameters: - - description: The Id or Name of policy_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_assignment: - $ref: '#/definitions/DomainLevelResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_assignment_ValidateUpdateDataOutput' - summary: 更新 - tags: - - policy_assignment - /policy_assignments/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: policy_assignment_PerformChangeOwner - parameters: - - description: The Id or Name of policy_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_assignment: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_assignment_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - policy_assignment - /policy_assignments/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: policy_assignment_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of policy_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_assignment_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - policy_assignment - /policy_assignments/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: policy_assignment_GetDetailsClassMetadata - parameters: - - description: The Id or Name of policy_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_assignment_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - policy_assignment - post: - description: 执行操作ClassMetadata - operationId: policy_assignment_PerformClassMetadata - parameters: - - description: The Id or Name of policy_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_assignment: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_assignment_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - policy_assignment - /policy_assignments/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: policy_assignment_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_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_assignment_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - policy_assignment - /policy_assignments/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: policy_assignment_PerformSetClassMetadata - parameters: - - description: The Id or Name of policy_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_assignment: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_assignment_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - policy_assignment - /policy_assignments/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: policy_assignment_PerformSetUserMetadata - parameters: - - description: The Id or Name of policy_assignment - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_assignment: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_assignment_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - policy_assignment - /policy_assignments/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: policy_assignment_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/policy_assignment_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - policy_assignment - /policy_assignments/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: policy_assignment_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/policy_assignment_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - policy_assignment - /policy_assignments/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: policy_assignment_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/policy_assignment_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - policy_assignment - /policy_assignments/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: policy_assignment_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - policy_assignment: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_assignment_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - policy_assignment - /policy_assignments/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: policy_assignment_GetPropertySplitable - responses: - "200": - $ref: '#/responses/policy_assignment_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - policy_assignment - /policy_assignments/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: policy_assignment_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_assignment_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - policy_assignment - /policy_assignments/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: policy_assignment_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/policy_assignment_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - policy_assignment - /policy_assignments/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: policy_assignment_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/policy_assignment_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - policy_assignment - /policy_definitions: - get: - description: 列表 - operationId: policy_definition_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: 指定查询的权限范围，可能值为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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/policy_definition_ListItemFilterOutput' - summary: 策略列表 - tags: - - policy_definition - post: - description: 新建 - operationId: policy_definition_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - policy_definition: - $ref: '#/definitions/PolicyDefinitionCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_definition_ValidateCreateDataOutput' - summary: 新建 - tags: - - policy_definition - /policy_definitions/{id}: - delete: - description: 删除 - operationId: policy_definition_CustomizeDelete - parameters: - - description: The Id or Name of policy_definition - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_definition_CustomizeDeleteOutput' - summary: 删除 - tags: - - policy_definition - get: - description: 获取详情 - operationId: policy_definition_FetchCustomizeColumns - parameters: - - description: The Id or Name of policy_definition - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_definition_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - policy_definition - put: - description: 更新 - operationId: policy_definition_ValidateUpdateData - parameters: - - description: The Id or Name of policy_definition - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_definition: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_definition_ValidateUpdateDataOutput' - summary: 更新 - tags: - - policy_definition - /policy_definitions/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: policy_definition_GetDetailsClassMetadata - parameters: - - description: The Id or Name of policy_definition - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_definition_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - policy_definition - post: - description: 执行操作ClassMetadata - operationId: policy_definition_PerformClassMetadata - parameters: - - description: The Id or Name of policy_definition - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_definition: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_definition_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - policy_definition - /policy_definitions/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: policy_definition_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_definition - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_definition_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - policy_definition - /policy_definitions/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: policy_definition_PerformSetClassMetadata - parameters: - - description: The Id or Name of policy_definition - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_definition: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_definition_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - policy_definition - /policy_definitions/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: policy_definition_PerformSetUserMetadata - parameters: - - description: The Id or Name of policy_definition - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_definition: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_definition_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - policy_definition - /policy_definitions/{id}/status: - get: - description: 获取指定信息Status - operationId: policy_definition_GetDetailsStatus - parameters: - - description: The Id or Name of policy_definition - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/policy_definition_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - policy_definition - post: - description: 执行操作Status - operationId: policy_definition_PerformStatus - parameters: - - description: The Id or Name of policy_definition - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - policy_definition: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_definition_PerformStatusOutput' - summary: 更新资源状态 - tags: - - policy_definition - /policy_definitions/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: policy_definition_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/policy_definition_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - policy_definition - /policy_definitions/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: policy_definition_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - policy_definition: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/policy_definition_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - policy_definition - /policy_definitions/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: policy_definition_GetPropertySplitable - responses: - "200": - $ref: '#/responses/policy_definition_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - policy_definition - /policy_definitions/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: policy_definition_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_definition_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - policy_definition - /policy_definitions/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: policy_definition_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/policy_definition_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - policy_definition - /policy_definitions/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: policy_definition_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/policy_definition_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - policy_definition - /policy_definitions/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: policy_definition_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/policy_definition_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - policy_definition - /project_mappings: - get: - description: 列表 - operationId: project_mapping_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - responses: - "200": - $ref: '#/responses/project_mapping_ListItemFilterOutput' - summary: 列出项目映射表 - tags: - - project_mapping - post: - description: 新建 - operationId: project_mapping_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - project_mapping: - $ref: '#/definitions/ProjectMappingCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_ValidateCreateDataOutput' - summary: 新建 - tags: - - project_mapping - /project_mappings/{id}: - delete: - description: 删除 - operationId: project_mapping_CustomizeDelete - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/project_mapping_CustomizeDeleteOutput' - summary: 删除 - tags: - - project_mapping - get: - description: 获取详情 - operationId: project_mapping_FetchCustomizeColumns - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/project_mapping_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - project_mapping - put: - description: 更新 - operationId: project_mapping_ValidateUpdateData - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - $ref: '#/definitions/ProjectMappingUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_ValidateUpdateDataOutput' - summary: 更新 - tags: - - project_mapping - /project_mappings/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: project_mapping_PerformChangeOwner - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - project_mapping - /project_mappings/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: project_mapping_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/project_mapping_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - project_mapping - /project_mappings/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: project_mapping_GetDetailsClassMetadata - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/project_mapping_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - project_mapping - post: - description: 执行操作ClassMetadata - operationId: project_mapping_PerformClassMetadata - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - project_mapping - /project_mappings/{id}/disable: - post: - description: 执行操作Disable - operationId: project_mapping_PerformDisable - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformDisableOutput' - summary: 禁用资源映射 - tags: - - project_mapping - /project_mappings/{id}/enable: - post: - description: 执行操作Enable - operationId: project_mapping_PerformEnable - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformEnableOutput' - summary: 启用资源映射 - tags: - - project_mapping - /project_mappings/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: project_mapping_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_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/project_mapping_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - project_mapping - /project_mappings/{id}/private: - post: - description: 执行操作Private - operationId: project_mapping_PerformPrivate - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformPrivateOutput' - summary: 执行操作Private - tags: - - project_mapping - /project_mappings/{id}/public: - post: - description: 执行操作Public - operationId: project_mapping_PerformPublic - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformPublicOutput' - summary: 执行操作Public - tags: - - project_mapping - /project_mappings/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: project_mapping_PerformSetClassMetadata - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - project_mapping - /project_mappings/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: project_mapping_PerformSetUserMetadata - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - project_mapping - /project_mappings/{id}/status: - get: - description: 获取指定信息Status - operationId: project_mapping_GetDetailsStatus - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/project_mapping_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - project_mapping - post: - description: 执行操作Status - operationId: project_mapping_PerformStatus - parameters: - - description: The Id or Name of project_mapping - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - project_mapping: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformStatusOutput' - summary: 更新资源状态 - tags: - - project_mapping - /project_mappings/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: project_mapping_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/project_mapping_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - project_mapping - /project_mappings/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: project_mapping_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/project_mapping_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - project_mapping - /project_mappings/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: project_mapping_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/project_mapping_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - project_mapping - /project_mappings/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: project_mapping_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - project_mapping: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/project_mapping_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - project_mapping - /project_mappings/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: project_mapping_GetPropertySplitable - responses: - "200": - $ref: '#/responses/project_mapping_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - project_mapping - /project_mappings/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: project_mapping_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_mapping_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - project_mapping - /project_mappings/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: project_mapping_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/project_mapping_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - project_mapping - /project_mappings/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: project_mapping_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/project_mapping_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - project_mapping - /project_mappings/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: project_mapping_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/project_mapping_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - project_mapping - /project_quotas/{scope}: - get: - description: 获取所有项目或者域的项目配额 - operationId: models_ListProjectQuotas - 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/models_ListProjectQuotasOutput' - summary: 获取所有项目或者域的项目配额 - tags: - - project_quota - /project_quotas/{scope}/{scopeId}: - get: - description: 获取指定项目或者域的项目配额 - operationId: models_GetProjectQuota - 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: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - - description: 指定项目或者域的ID - in: path - name: scopeId - required: true - type: string - x-go-name: ScopeId - responses: - "200": - $ref: '#/responses/models_GetProjectQuotaOutput' - summary: 获取指定项目或者域的项目配额 - tags: - - project_quota - post: - description: 设置指定项目或者域的项目配额 - operationId: models_SetProjectQuotas - parameters: - - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - - description: 指定项目或者域的ID - in: path - name: scopeId - required: true - type: string - x-go-name: ScopeId - - in: body - name: body - schema: - properties: - project_quotas: - $ref: '#/definitions/SetProjectQuotaInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/models_SetProjectQuotasOutput' - summary: 设置指定项目或者域的项目配额 - tags: - - project_quota - /quotas/{scope}: - get: - description: 获取所有项目或者域的主机配额 - operationId: models_ListQuotas - 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/models_ListQuotasOutput' - summary: 获取所有项目或者域的主机配额 - tags: - - quota - /quotas/{scope}/{scopeId}: - get: - description: 获取指定项目或者域的主机配额 - operationId: models_GetQuota - 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: scopeId - required: true - type: string - x-go-name: ScopeId - - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/models_GetQuotaOutput' - summary: 获取指定项目或者域的主机配额 - tags: - - quota - post: - description: 设置指定项目或者域的主机配额 - operationId: models_SetQuotas - parameters: - - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - - description: 指定项目或者域的ID - in: path - name: scopeId - required: true - type: string - x-go-name: ScopeId - - in: body - name: body - schema: - properties: - quotas: - $ref: '#/definitions/SetQuotaInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/models_SetQuotasOutput' - summary: 设置指定项目或者域的主机配额 - tags: - - quota - /region_quotas/{scope}: - get: - description: 获取所有项目或者域的区域配额 - operationId: models_ListRegionQuotas - 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/models_ListRegionQuotasOutput' - summary: 获取所有项目或者域的区域配额 - tags: - - region_quota - /region_quotas/{scope}/{scopeId}: - get: - description: 获取指定项目或者域的区域配额 - operationId: models_GetRegionQuota - 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: scopeId - required: true - type: string - x-go-name: ScopeId - - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/models_GetRegionQuotaOutput' - summary: 获取指定项目或者域的区域配额 - tags: - - region_quota - post: - description: 设置指定项目或者域的区域配额 - operationId: models_SetRegionQuotas - parameters: - - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - - description: 指定项目或者域的ID - in: path - name: scopeId - required: true - type: string - x-go-name: ScopeId - - in: body - name: body - schema: - properties: - region_quotas: - $ref: '#/definitions/SetRegionQuotaInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/models_SetRegionQuotasOutput' - summary: 设置指定项目或者域的区域配额 - tags: - - region_quota - /reservedips: - get: - description: 列表 - operationId: reservedip_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - description: list all reserved ips, including expired ones - in: query - name: all - type: boolean - x-go-name: All - - description: ip_addr - in: query - items: - type: string - name: ip_addr - type: array - x-go-name: IpAddr - - description: 状态 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - responses: - "200": - $ref: '#/responses/reservedip_ListItemFilterOutput' - summary: 预留IP地址列表 - tags: - - reservedip - post: - description: 新建 - operationId: reservedip_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - reservedip: - $ref: '#/definitions/ResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/reservedip_ValidateCreateDataOutput' - summary: 新建 - tags: - - reservedip - /reservedips/{id}: - delete: - description: 删除 - operationId: reservedip_CustomizeDelete - parameters: - - description: The Id or Name of reservedip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/reservedip_CustomizeDeleteOutput' - summary: 删除 - tags: - - reservedip - get: - description: 获取详情 - operationId: reservedip_FetchCustomizeColumns - parameters: - - description: The Id or Name of reservedip - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/reservedip_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - reservedip - put: - description: 更新 - operationId: reservedip_ValidateUpdateData - parameters: - - description: The Id or Name of reservedip - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - reservedip: - $ref: '#/definitions/ResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/reservedip_ValidateUpdateDataOutput' - summary: 更新 - tags: - - reservedip - /reservedips/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: reservedip_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/reservedip_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - reservedip - /reservedips/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: reservedip_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - reservedip: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/reservedip_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - reservedip - /reservedips/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: reservedip_GetPropertySplitable - responses: - "200": - $ref: '#/responses/reservedip_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - reservedip - /reservedips/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: reservedip_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/reservedip_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - reservedip - /route_table_associations: - get: - description: 列表 - operationId: route_table_association_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - in: query - name: RouteTableId - type: string - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/route_table_association_ListItemFilterOutput' - summary: 列表 - tags: - - route_table_association - post: - description: 新建 - operationId: route_table_association_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - route_table_association: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_association_ValidateCreateDataOutput' - summary: 新建 - tags: - - route_table_association - /route_table_associations/{id}: - delete: - description: 删除 - operationId: route_table_association_CustomizeDelete - parameters: - - description: The Id or Name of route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_association_CustomizeDeleteOutput' - summary: 删除 - tags: - - route_table_association - get: - description: 获取详情 - operationId: route_table_association_FetchCustomizeColumns - parameters: - - description: The Id or Name of route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_association_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - route_table_association - put: - description: 更新 - operationId: route_table_association_ValidateUpdateData - parameters: - - description: The Id or Name of route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_association: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_association_ValidateUpdateDataOutput' - summary: 更新 - tags: - - route_table_association - /route_table_associations/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: route_table_association_GetDetailsClassMetadata - parameters: - - description: The Id or Name of route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_association_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - route_table_association - post: - description: 执行操作ClassMetadata - operationId: route_table_association_PerformClassMetadata - parameters: - - description: The Id or Name of route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_association: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_association_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - route_table_association - /route_table_associations/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: route_table_association_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 route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_association_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - route_table_association - /route_table_associations/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: route_table_association_PerformSetClassMetadata - parameters: - - description: The Id or Name of route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_association: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_association_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - route_table_association - /route_table_associations/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: route_table_association_PerformSetUserMetadata - parameters: - - description: The Id or Name of route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_association: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_association_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - route_table_association - /route_table_associations/{id}/status: - get: - description: 获取指定信息Status - operationId: route_table_association_GetDetailsStatus - parameters: - - description: The Id or Name of route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_association_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - route_table_association - post: - description: 执行操作Status - operationId: route_table_association_PerformStatus - parameters: - - description: The Id or Name of route_table_association - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_association: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_association_PerformStatusOutput' - summary: 更新资源状态 - tags: - - route_table_association - /route_table_associations/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: route_table_association_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/route_table_association_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - route_table_association - /route_table_associations/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: route_table_association_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - route_table_association: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_association_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - route_table_association - /route_table_associations/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: route_table_association_GetPropertySplitable - responses: - "200": - $ref: '#/responses/route_table_association_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - route_table_association - /route_table_associations/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: route_table_association_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/route_table_association_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - route_table_association - /route_table_associations/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: route_table_association_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/route_table_association_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - route_table_association - /route_table_associations/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: route_table_association_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/route_table_association_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - route_table_association - /route_table_associations/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: route_table_association_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/route_table_association_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - route_table_association - /route_table_route_sets: - get: - description: 列表 - operationId: route_table_route_set_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - in: query - name: RouteTableId - type: string - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - in: query - name: type - type: string - x-go-name: Type - - in: query - name: next_hop_type - type: string - x-go-name: NextHopType - - in: query - name: next_hop_id - type: string - x-go-name: NextHopId - - in: query - name: cidr - type: string - x-go-name: Cidr - responses: - "200": - $ref: '#/responses/route_table_route_set_ListItemFilterOutput' - summary: 列表 - tags: - - route_table_route_set - post: - description: 新建 - operationId: route_table_route_set_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - route_table_route_set: - $ref: '#/definitions/RouteTableRouteSetCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_route_set_ValidateCreateDataOutput' - summary: 新建 - tags: - - route_table_route_set - /route_table_route_sets/{id}: - delete: - description: 删除 - operationId: route_table_route_set_CustomizeDelete - parameters: - - description: The Id or Name of route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_route_set_CustomizeDeleteOutput' - summary: 删除 - tags: - - route_table_route_set - get: - description: 获取详情 - operationId: route_table_route_set_FetchCustomizeColumns - parameters: - - description: The Id or Name of route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_route_set_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - route_table_route_set - put: - description: 更新 - operationId: route_table_route_set_ValidateUpdateData - parameters: - - description: The Id or Name of route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_route_set: - $ref: '#/definitions/RouteTableRouteSetUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_route_set_ValidateUpdateDataOutput' - summary: 更新 - tags: - - route_table_route_set - /route_table_route_sets/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: route_table_route_set_GetDetailsClassMetadata - parameters: - - description: The Id or Name of route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_route_set_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - route_table_route_set - post: - description: 执行操作ClassMetadata - operationId: route_table_route_set_PerformClassMetadata - parameters: - - description: The Id or Name of route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_route_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_route_set_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - route_table_route_set - /route_table_route_sets/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: route_table_route_set_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 route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_route_set_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - route_table_route_set - /route_table_route_sets/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: route_table_route_set_PerformSetClassMetadata - parameters: - - description: The Id or Name of route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_route_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_route_set_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - route_table_route_set - /route_table_route_sets/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: route_table_route_set_PerformSetUserMetadata - parameters: - - description: The Id or Name of route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_route_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_route_set_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - route_table_route_set - /route_table_route_sets/{id}/status: - get: - description: 获取指定信息Status - operationId: route_table_route_set_GetDetailsStatus - parameters: - - description: The Id or Name of route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_route_set_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - route_table_route_set - post: - description: 执行操作Status - operationId: route_table_route_set_PerformStatus - parameters: - - description: The Id or Name of route_table_route_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table_route_set: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_route_set_PerformStatusOutput' - summary: 更新资源状态 - tags: - - route_table_route_set - /route_table_route_sets/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: route_table_route_set_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/route_table_route_set_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - route_table_route_set - /route_table_route_sets/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: route_table_route_set_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - route_table_route_set: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_route_set_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - route_table_route_set - /route_table_route_sets/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: route_table_route_set_GetPropertySplitable - responses: - "200": - $ref: '#/responses/route_table_route_set_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - route_table_route_set - /route_table_route_sets/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: route_table_route_set_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/route_table_route_set_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - route_table_route_set - /route_table_route_sets/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: route_table_route_set_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/route_table_route_set_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - route_table_route_set - /route_table_route_sets/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: route_table_route_set_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/route_table_route_set_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - route_table_route_set - /route_table_route_sets/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: route_table_route_set_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/route_table_route_set_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - route_table_route_set - /route_tables: - get: - description: 列表 - operationId: route_table_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: filter by type - in: query - items: - type: string - name: type - type: array - x-go-name: Type - responses: - "200": - $ref: '#/responses/route_table_ListItemFilterOutput' - summary: VPC虚拟路由表列表 - tags: - - route_table - post: - description: 新建 - operationId: route_table_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - route_table: - $ref: '#/definitions/RouteTableCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_ValidateCreateDataOutput' - summary: 新建 - tags: - - route_table - /route_tables/{id}: - delete: - description: 删除 - operationId: route_table_CustomizeDelete - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_CustomizeDeleteOutput' - summary: 删除 - tags: - - route_table - get: - description: 获取详情 - operationId: route_table_FetchCustomizeColumns - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - route_table - put: - description: 更新 - operationId: route_table_ValidateUpdateData - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table: - $ref: '#/definitions/RouteTableUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_ValidateUpdateDataOutput' - summary: 更新 - tags: - - route_table - /route_tables/{id}/add-routes: - post: - description: This is intended mainly for command line operations. - operationId: route_table_PerformAddRoutes - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_PerformAddRoutesOutput' - summary: PerformAddRoutes patches acl entries by adding then deleting the specified - acls. - tags: - - route_table - /route_tables/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: route_table_PerformChangeOwner - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - route_table - /route_tables/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: route_table_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - route_table - /route_tables/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: route_table_GetDetailsClassMetadata - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - route_table - post: - description: 执行操作ClassMetadata - operationId: route_table_PerformClassMetadata - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - route_table - /route_tables/{id}/del-routes: - post: - description: 执行操作DelRoutes - operationId: route_table_PerformDelRoutes - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_PerformDelRoutesOutput' - summary: 执行操作DelRoutes - tags: - - route_table - /route_tables/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: route_table_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 route_table - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - route_table - /route_tables/{id}/private: - post: - description: 执行操作Private - operationId: route_table_PerformPrivate - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_PerformPrivateOutput' - summary: 执行操作Private - tags: - - route_table - /route_tables/{id}/public: - post: - description: 执行操作Public - operationId: route_table_PerformPublic - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_PerformPublicOutput' - summary: 执行操作Public - tags: - - route_table - /route_tables/{id}/purge: - post: - description: 执行操作Purge - operationId: route_table_PerformPurge - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - route_table - /route_tables/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: route_table_PerformSetClassMetadata - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - route_table - /route_tables/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: route_table_PerformSetUserMetadata - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - route_table - /route_tables/{id}/status: - get: - description: 获取指定信息Status - operationId: route_table_GetDetailsStatus - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/route_table_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - route_table - post: - description: 执行操作Status - operationId: route_table_PerformStatus - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_PerformStatusOutput' - summary: 更新资源状态 - tags: - - route_table - /route_tables/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: route_table_PerformSyncstatus - parameters: - - description: The Id or Name of route_table - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - route_table: - $ref: '#/definitions/VpcSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_PerformSyncstatusOutput' - summary: 执行操作Syncstatus - tags: - - route_table - /route_tables/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: route_table_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/route_table_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - route_table - /route_tables/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: route_table_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/route_table_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - route_table - /route_tables/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: route_table_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/route_table_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - route_table - /route_tables/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: route_table_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - route_table: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/route_table_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - route_table - /route_tables/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: route_table_GetPropertySplitable - responses: - "200": - $ref: '#/responses/route_table_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - route_table - /route_tables/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: route_table_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/route_table_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - route_table - /route_tables/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: route_table_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/route_table_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - route_table - /route_tables/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: route_table_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/route_table_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - route_table - /route_tables/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: route_table_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/route_table_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - route_table - /scaling_activities: - get: - description: 列表 - operationId: scaling_activity_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: 'description: 伸缩组 Id or Name' - example: sg-1234 - in: query - name: scaling_group - type: string - x-go-name: ScalingGroup - responses: - "200": - $ref: '#/responses/scaling_activity_ListItemFilterOutput' - summary: 列表 - tags: - - scaling_activity - post: - description: 新建 - operationId: scaling_activity_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - scaling_activity: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_activity_ValidateCreateDataOutput' - summary: 新建 - tags: - - scaling_activity - /scaling_activities/{id}: - delete: - description: 删除 - operationId: scaling_activity_CustomizeDelete - parameters: - - description: The Id or Name of scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_activity_CustomizeDeleteOutput' - summary: 删除 - tags: - - scaling_activity - get: - description: 获取详情 - operationId: scaling_activity_FetchCustomizeColumns - parameters: - - description: The Id or Name of scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_activity_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - scaling_activity - put: - description: 更新 - operationId: scaling_activity_ValidateUpdateData - parameters: - - description: The Id or Name of scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_activity: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_activity_ValidateUpdateDataOutput' - summary: 更新 - tags: - - scaling_activity - /scaling_activities/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: scaling_activity_GetDetailsClassMetadata - parameters: - - description: The Id or Name of scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_activity_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - scaling_activity - post: - description: 执行操作ClassMetadata - operationId: scaling_activity_PerformClassMetadata - parameters: - - description: The Id or Name of scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_activity: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_activity_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - scaling_activity - /scaling_activities/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: scaling_activity_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 scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_activity_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - scaling_activity - /scaling_activities/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: scaling_activity_PerformSetClassMetadata - parameters: - - description: The Id or Name of scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_activity: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_activity_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - scaling_activity - /scaling_activities/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: scaling_activity_PerformSetUserMetadata - parameters: - - description: The Id or Name of scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_activity: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_activity_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - scaling_activity - /scaling_activities/{id}/status: - get: - description: 获取指定信息Status - operationId: scaling_activity_GetDetailsStatus - parameters: - - description: The Id or Name of scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_activity_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - scaling_activity - post: - description: 执行操作Status - operationId: scaling_activity_PerformStatus - parameters: - - description: The Id or Name of scaling_activity - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_activity: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_activity_PerformStatusOutput' - summary: 更新资源状态 - tags: - - scaling_activity - /scaling_activities/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: scaling_activity_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/scaling_activity_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - scaling_activity - /scaling_activities/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: scaling_activity_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - scaling_activity: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_activity_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - scaling_activity - /scaling_activities/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: scaling_activity_GetPropertySplitable - responses: - "200": - $ref: '#/responses/scaling_activity_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - scaling_activity - /scaling_activities/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: scaling_activity_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/scaling_activity_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - scaling_activity - /scaling_activities/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: scaling_activity_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/scaling_activity_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - scaling_activity - /scaling_activities/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: scaling_activity_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/scaling_activity_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - scaling_activity - /scaling_activities/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: scaling_activity_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/scaling_activity_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - scaling_activity - /scaling_alarms: - get: - description: 列表 - operationId: scaling_alarm_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/scaling_alarm_ListItemFilterOutput' - summary: 列表 - tags: - - scaling_alarm - post: - description: 新建 - operationId: scaling_alarm_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - scaling_alarm: - $ref: '#/definitions/StandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_alarm_ValidateCreateDataOutput' - summary: 新建 - tags: - - scaling_alarm - /scaling_alarms/{id}: - delete: - description: 删除 - operationId: scaling_alarm_CustomizeDelete - parameters: - - description: The Id or Name of scaling_alarm - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_alarm_CustomizeDeleteOutput' - summary: 删除 - tags: - - scaling_alarm - get: - description: 获取详情 - operationId: scaling_alarm_FetchCustomizeColumns - parameters: - - description: The Id or Name of scaling_alarm - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_alarm_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - scaling_alarm - put: - description: 更新 - operationId: scaling_alarm_ValidateUpdateData - parameters: - - description: The Id or Name of scaling_alarm - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_alarm: - $ref: '#/definitions/StandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_alarm_ValidateUpdateDataOutput' - summary: 更新 - tags: - - scaling_alarm - /scaling_alarms/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: scaling_alarm_GetDetailsClassMetadata - parameters: - - description: The Id or Name of scaling_alarm - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_alarm_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - scaling_alarm - post: - description: 执行操作ClassMetadata - operationId: scaling_alarm_PerformClassMetadata - parameters: - - description: The Id or Name of scaling_alarm - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_alarm: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_alarm_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - scaling_alarm - /scaling_alarms/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: scaling_alarm_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 scaling_alarm - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_alarm_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - scaling_alarm - /scaling_alarms/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: scaling_alarm_PerformSetClassMetadata - parameters: - - description: The Id or Name of scaling_alarm - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_alarm: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_alarm_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - scaling_alarm - /scaling_alarms/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: scaling_alarm_PerformSetUserMetadata - parameters: - - description: The Id or Name of scaling_alarm - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_alarm: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_alarm_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - scaling_alarm - /scaling_alarms/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: scaling_alarm_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/scaling_alarm_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - scaling_alarm - /scaling_alarms/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: scaling_alarm_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - scaling_alarm: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_alarm_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - scaling_alarm - /scaling_alarms/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: scaling_alarm_GetPropertySplitable - responses: - "200": - $ref: '#/responses/scaling_alarm_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - scaling_alarm - /scaling_alarms/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: scaling_alarm_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/scaling_alarm_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - scaling_alarm - /scaling_alarms/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: scaling_alarm_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/scaling_alarm_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - scaling_alarm - /scaling_alarms/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: scaling_alarm_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/scaling_alarm_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - scaling_alarm - /scaling_group_guests: - get: - description: 列表 - operationId: scaling_group_guest_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: 以主机名称排序 - in: query - name: order_by_server - type: string - x-go-name: OrderByServer - responses: - "200": - $ref: '#/responses/scaling_group_guest_ListItemFilterOutput' - summary: 列表 - tags: - - scaling_group_guest - post: - description: 新建 - operationId: scaling_group_guest_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - scaling_group_guest: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_guest_ValidateCreateDataOutput' - summary: 新建 - tags: - - scaling_group_guest - /scaling_group_guests/{id}: - delete: - description: 删除 - operationId: scaling_group_guest_CustomizeDelete - parameters: - - description: The Id or Name of scaling_group_guest - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_guest_CustomizeDeleteOutput' - summary: 删除 - tags: - - scaling_group_guest - get: - description: 获取详情 - operationId: scaling_group_guest_FetchCustomizeColumns - parameters: - - description: The Id or Name of scaling_group_guest - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_guest_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - scaling_group_guest - put: - description: 更新 - operationId: scaling_group_guest_ValidateUpdateData - parameters: - - description: The Id or Name of scaling_group_guest - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group_guest: - $ref: '#/definitions/GuestJointBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_guest_ValidateUpdateDataOutput' - summary: 更新 - tags: - - scaling_group_guest - /scaling_group_guests/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: scaling_group_guest_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/scaling_group_guest_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - scaling_group_guest - /scaling_group_guests/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: scaling_group_guest_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - scaling_group_guest: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_guest_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - scaling_group_guest - /scaling_group_guests/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: scaling_group_guest_GetPropertySplitable - responses: - "200": - $ref: '#/responses/scaling_group_guest_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - scaling_group_guest - /scaling_group_guests/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: scaling_group_guest_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/scaling_group_guest_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - scaling_group_guest - /scaling_group_networks: - get: - description: 列表 - operationId: scaling_group_network_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/scaling_group_network_ListItemFilterOutput' - summary: 列表 - tags: - - scaling_group_network - post: - description: 新建 - operationId: scaling_group_network_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - scaling_group_network: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_network_ValidateCreateDataOutput' - summary: 新建 - tags: - - scaling_group_network - /scaling_group_networks/{id}: - delete: - description: 删除 - operationId: scaling_group_network_CustomizeDelete - parameters: - - description: The Id or Name of scaling_group_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_network_CustomizeDeleteOutput' - summary: 删除 - tags: - - scaling_group_network - get: - description: 获取详情 - operationId: scaling_group_network_FetchCustomizeColumns - parameters: - - description: The Id or Name of scaling_group_network - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_network_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - scaling_group_network - put: - description: 更新 - operationId: scaling_group_network_ValidateUpdateData - parameters: - - description: The Id or Name of scaling_group_network - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group_network: - $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_network_ValidateUpdateDataOutput' - summary: 更新 - tags: - - scaling_group_network - /scaling_group_networks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: scaling_group_network_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/scaling_group_network_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - scaling_group_network - /scaling_group_networks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: scaling_group_network_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - scaling_group_network: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_network_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - scaling_group_network - /scaling_group_networks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: scaling_group_network_GetPropertySplitable - responses: - "200": - $ref: '#/responses/scaling_group_network_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - scaling_group_network - /scaling_group_networks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: scaling_group_network_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/scaling_group_network_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - scaling_group_network - /scaling_groups: - get: - description: 列表 - operationId: scaling_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: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 负载均衡名称 - in: query - name: loadbalancer_id - type: string - x-go-name: LoadbalancerId - - description: 以负载均衡名称排序 - in: query - name: order_by_loadbalancer - type: string - x-go-name: OrderByLoadbalancer - - description: 负载均衡后端组ID或名称 - in: query - name: backend_group_id - type: string - x-go-name: BackendGroupId - - description: 以负载均衡后端组名称排序 - in: query - name: order_by_backend_group - type: string - x-go-name: OrderByBackendGroup - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 实例组（ID或Name） - in: query - name: group_id - type: string - x-go-name: GroupId - - description: 按组名排序 - in: query - name: order_by_group - type: string - x-go-name: OrderByGroup - - description: 主机镜像 - in: query - name: guest_template_id - type: string - x-go-name: GuestTemplateId - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 'description: hypervisor' - example: kvm - in: query - name: hypervisor - type: string - x-go-name: Hypervisor - - description: 'desription: 平台' - example: OneCloud - in: query - name: brand - type: string - x-go-name: Brand - responses: - "200": - $ref: '#/responses/scaling_group_ListItemFilterOutput' - summary: 列表 - tags: - - scaling_group - post: - description: 新建 - operationId: scaling_group_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - scaling_group: - $ref: '#/definitions/ScalingGroupCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_ValidateCreateDataOutput' - summary: 新建 - tags: - - scaling_group - /scaling_groups/{id}: - delete: - description: 删除 - operationId: scaling_group_CustomizeDelete - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_CustomizeDeleteOutput' - summary: 删除 - tags: - - scaling_group - get: - description: 获取详情 - operationId: scaling_group_FetchCustomizeColumns - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - scaling_group - put: - description: 更新 - operationId: scaling_group_ValidateUpdateData - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_ValidateUpdateDataOutput' - summary: 更新 - tags: - - scaling_group - /scaling_groups/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: scaling_group_PerformCancelDelete - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - scaling_group - /scaling_groups/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: scaling_group_PerformChangeOwner - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - scaling_group - /scaling_groups/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: scaling_group_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - scaling_group - /scaling_groups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: scaling_group_GetDetailsClassMetadata - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - scaling_group - post: - description: 执行操作ClassMetadata - operationId: scaling_group_PerformClassMetadata - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - scaling_group - /scaling_groups/{id}/disable: - post: - description: 执行操作Disable - operationId: scaling_group_PerformDisable - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformDisableOutput' - summary: 执行操作Disable - tags: - - scaling_group - /scaling_groups/{id}/enable: - post: - description: 执行操作Enable - operationId: scaling_group_PerformEnable - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformEnableOutput' - summary: 执行操作Enable - tags: - - scaling_group - /scaling_groups/{id}/freeze: - post: - description: 执行操作Freeze - operationId: scaling_group_PerformFreeze - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - scaling_group - /scaling_groups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: scaling_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 scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - scaling_group - /scaling_groups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: scaling_group_PerformSetClassMetadata - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - scaling_group - /scaling_groups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: scaling_group_PerformSetUserMetadata - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - scaling_group - /scaling_groups/{id}/status: - get: - description: 获取指定信息Status - operationId: scaling_group_GetDetailsStatus - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_group_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - scaling_group - post: - description: 执行操作Status - operationId: scaling_group_PerformStatus - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformStatusOutput' - summary: 更新资源状态 - tags: - - scaling_group - /scaling_groups/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: scaling_group_PerformUnfreeze - parameters: - - description: The Id or Name of scaling_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_group: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - scaling_group - /scaling_groups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: scaling_group_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/scaling_group_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - scaling_group - /scaling_groups/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: scaling_group_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/scaling_group_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - scaling_group - /scaling_groups/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: scaling_group_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/scaling_group_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - scaling_group - /scaling_groups/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: scaling_group_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/scaling_group_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - scaling_group - /scaling_groups/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: scaling_group_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/scaling_group_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - scaling_group - /scaling_groups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: scaling_group_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - scaling_group: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_group_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - scaling_group - /scaling_groups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: scaling_group_GetPropertySplitable - responses: - "200": - $ref: '#/responses/scaling_group_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - scaling_group - /scaling_groups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: scaling_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/scaling_group_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - scaling_group - /scaling_groups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: scaling_group_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/scaling_group_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - scaling_group - /scaling_groups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: scaling_group_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/scaling_group_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - scaling_group - /scaling_groups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: scaling_group_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/scaling_group_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - scaling_group - /scaling_policies: - get: - description: 列表 - operationId: scaling_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: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 'description: 伸缩组 Id or Name' - example: sg-1234 - in: query - name: scaling_group - type: string - x-go-name: ScalingGroup - - description: 'description: trigger type' - enum: - - timing - - cycel - - alarm - example: alarm - in: query - name: trigger_type - type: string - x-go-name: TriggerType - responses: - "200": - $ref: '#/responses/scaling_policy_ListItemFilterOutput' - summary: 列表 - tags: - - scaling_policy - post: - description: 新建 - operationId: scaling_policy_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - scaling_policy: - $ref: '#/definitions/ScalingPolicyCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_ValidateCreateDataOutput' - summary: 新建 - tags: - - scaling_policy - /scaling_policies/{id}: - delete: - description: 删除 - operationId: scaling_policy_CustomizeDelete - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_policy_CustomizeDeleteOutput' - summary: 删除 - tags: - - scaling_policy - get: - description: 获取详情 - operationId: scaling_policy_FetchCustomizeColumns - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_policy_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - scaling_policy - put: - description: 更新 - operationId: scaling_policy_ValidateUpdateData - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_ValidateUpdateDataOutput' - summary: 更新 - tags: - - scaling_policy - /scaling_policies/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: scaling_policy_PerformCancelDelete - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_policy_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - scaling_policy - /scaling_policies/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: scaling_policy_PerformChangeOwner - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - scaling_policy - /scaling_policies/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: scaling_policy_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_policy_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - scaling_policy - /scaling_policies/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: scaling_policy_GetDetailsClassMetadata - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_policy_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - scaling_policy - post: - description: 执行操作ClassMetadata - operationId: scaling_policy_PerformClassMetadata - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - scaling_policy - /scaling_policies/{id}/disable: - post: - description: 执行操作Disable - operationId: scaling_policy_PerformDisable - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformDisableOutput' - summary: 执行操作Disable - tags: - - scaling_policy - /scaling_policies/{id}/enable: - post: - description: 执行操作Enable - operationId: scaling_policy_PerformEnable - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformEnableOutput' - summary: 执行操作Enable - tags: - - scaling_policy - /scaling_policies/{id}/freeze: - post: - description: 执行操作Freeze - operationId: scaling_policy_PerformFreeze - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - scaling_policy - /scaling_policies/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: scaling_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 scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_policy_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - scaling_policy - /scaling_policies/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: scaling_policy_PerformSetClassMetadata - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - scaling_policy - /scaling_policies/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: scaling_policy_PerformSetUserMetadata - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - scaling_policy - /scaling_policies/{id}/status: - get: - description: 获取指定信息Status - operationId: scaling_policy_GetDetailsStatus - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_policy_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - scaling_policy - post: - description: 执行操作Status - operationId: scaling_policy_PerformStatus - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformStatusOutput' - summary: 更新资源状态 - tags: - - scaling_policy - /scaling_policies/{id}/trigger: - post: - description: 执行操作Trigger - operationId: scaling_policy_PerformTrigger - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_policy_PerformTriggerOutput' - summary: 执行操作Trigger - tags: - - scaling_policy - /scaling_policies/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: scaling_policy_PerformUnfreeze - parameters: - - description: The Id or Name of scaling_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_policy: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - scaling_policy - /scaling_policies/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: scaling_policy_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/scaling_policy_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - scaling_policy - /scaling_policies/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: scaling_policy_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/scaling_policy_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - scaling_policy - /scaling_policies/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: scaling_policy_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/scaling_policy_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - scaling_policy - /scaling_policies/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: scaling_policy_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/scaling_policy_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - scaling_policy - /scaling_policies/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: scaling_policy_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/scaling_policy_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - scaling_policy - /scaling_policies/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: scaling_policy_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - scaling_policy: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_policy_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - scaling_policy - /scaling_policies/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: scaling_policy_GetPropertySplitable - responses: - "200": - $ref: '#/responses/scaling_policy_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - scaling_policy - /scaling_policies/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: scaling_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/scaling_policy_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - scaling_policy - /scaling_policies/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: scaling_policy_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/scaling_policy_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - scaling_policy - /scaling_policies/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: scaling_policy_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/scaling_policy_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - scaling_policy - /scaling_policies/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: scaling_policy_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/scaling_policy_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - scaling_policy - /scaling_timers: - get: - description: 列表 - operationId: scaling_timer_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/scaling_timer_ListItemFilterOutput' - summary: 列表 - tags: - - scaling_timer - post: - description: 新建 - operationId: scaling_timer_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - scaling_timer: - $ref: '#/definitions/StandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_timer_ValidateCreateDataOutput' - summary: 新建 - tags: - - scaling_timer - /scaling_timers/{id}: - delete: - description: 删除 - operationId: scaling_timer_CustomizeDelete - parameters: - - description: The Id or Name of scaling_timer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_timer_CustomizeDeleteOutput' - summary: 删除 - tags: - - scaling_timer - get: - description: 获取详情 - operationId: scaling_timer_FetchCustomizeColumns - parameters: - - description: The Id or Name of scaling_timer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_timer_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - scaling_timer - put: - description: 更新 - operationId: scaling_timer_ValidateUpdateData - parameters: - - description: The Id or Name of scaling_timer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_timer: - $ref: '#/definitions/StandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_timer_ValidateUpdateDataOutput' - summary: 更新 - tags: - - scaling_timer - /scaling_timers/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: scaling_timer_GetDetailsClassMetadata - parameters: - - description: The Id or Name of scaling_timer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_timer_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - scaling_timer - post: - description: 执行操作ClassMetadata - operationId: scaling_timer_PerformClassMetadata - parameters: - - description: The Id or Name of scaling_timer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_timer: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_timer_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - scaling_timer - /scaling_timers/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: scaling_timer_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 scaling_timer - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scaling_timer_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - scaling_timer - /scaling_timers/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: scaling_timer_PerformSetClassMetadata - parameters: - - description: The Id or Name of scaling_timer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_timer: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_timer_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - scaling_timer - /scaling_timers/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: scaling_timer_PerformSetUserMetadata - parameters: - - description: The Id or Name of scaling_timer - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scaling_timer: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_timer_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - scaling_timer - /scaling_timers/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: scaling_timer_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/scaling_timer_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - scaling_timer - /scaling_timers/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: scaling_timer_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - scaling_timer: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scaling_timer_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - scaling_timer - /scaling_timers/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: scaling_timer_GetPropertySplitable - responses: - "200": - $ref: '#/responses/scaling_timer_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - scaling_timer - /scaling_timers/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: scaling_timer_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/scaling_timer_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - scaling_timer - /scaling_timers/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: scaling_timer_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/scaling_timer_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - scaling_timer - /scaling_timers/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: scaling_timer_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/scaling_timer_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - scaling_timer - /schedpolicies: - get: - description: 列表 - operationId: schedpolicy_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: 以关联的调度标签（ID或Name）过滤列表 - in: query - name: schedtag_id - type: string - x-go-name: SchedtagId - - description: 按调度标签名称排序 - in: query - name: order_by_schedtag - pattern: asc|desc - type: string - x-go-name: OrderBySchedtag - - description: 按调度标签资源类型排序 - in: query - name: order_by_resource_type - pattern: asc|desc - type: string - x-go-name: OrderByResourceType - - in: query - items: - type: string - name: strategy - type: array - x-go-name: Strategy - - in: query - name: enabled - type: boolean - x-go-name: Enabled - responses: - "200": - $ref: '#/responses/schedpolicy_ListItemFilterOutput' - summary: 动态调度策略列表 - tags: - - schedpolicy - post: - description: 新建 - operationId: schedpolicy_ValidateCreateData - responses: - "200": - $ref: '#/responses/schedpolicy_ValidateCreateDataOutput' - summary: 新建 - tags: - - schedpolicy - /schedpolicies/{id}: - delete: - description: 删除 - operationId: schedpolicy_CustomizeDelete - parameters: - - description: The Id or Name of schedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedpolicy_CustomizeDeleteOutput' - summary: 删除 - tags: - - schedpolicy - get: - description: 获取详情 - operationId: schedpolicy_FetchCustomizeColumns - parameters: - - description: The Id or Name of schedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedpolicy_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - schedpolicy - put: - description: 更新 - operationId: schedpolicy_ValidateUpdateData - parameters: - - description: The Id or Name of schedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedpolicy_ValidateUpdateDataOutput' - summary: 更新 - tags: - - schedpolicy - /schedpolicies/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: schedpolicy_GetDetailsClassMetadata - parameters: - - description: The Id or Name of schedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedpolicy_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - schedpolicy - post: - description: 执行操作ClassMetadata - operationId: schedpolicy_PerformClassMetadata - parameters: - - description: The Id or Name of schedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - schedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedpolicy_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - schedpolicy - /schedpolicies/{id}/evaluate: - post: - description: 执行操作Evaluate - operationId: schedpolicy_PerformEvaluate - parameters: - - description: The Id or Name of schedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedpolicy_PerformEvaluateOutput' - summary: 执行操作Evaluate - tags: - - schedpolicy - /schedpolicies/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: schedpolicy_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 schedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedpolicy_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - schedpolicy - /schedpolicies/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: schedpolicy_PerformSetClassMetadata - parameters: - - description: The Id or Name of schedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - schedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedpolicy_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - schedpolicy - /schedpolicies/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: schedpolicy_PerformSetUserMetadata - parameters: - - description: The Id or Name of schedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - schedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedpolicy_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - schedpolicy - /schedpolicies/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: schedpolicy_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/schedpolicy_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - schedpolicy - /schedpolicies/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: schedpolicy_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - schedpolicy: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedpolicy_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - schedpolicy - /schedpolicies/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: schedpolicy_GetPropertySplitable - responses: - "200": - $ref: '#/responses/schedpolicy_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - schedpolicy - /schedpolicies/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: schedpolicy_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/schedpolicy_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - schedpolicy - /schedpolicies/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: schedpolicy_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/schedpolicy_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - schedpolicy - /schedpolicies/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: schedpolicy_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/schedpolicy_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - schedpolicy - /schedtags: - get: - description: 列表 - operationId: schedtag_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: fitler by resource_type - in: query - items: - type: string - name: resource_type - type: array - x-go-name: ResourceType - - in: query - items: - type: string - name: default_strategy - type: array - x-go-name: DefaultStrategy - responses: - "200": - $ref: '#/responses/schedtag_ListItemFilterOutput' - summary: 调度标签列表 - tags: - - schedtag - post: - description: 新建 - operationId: schedtag_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - schedtag: - $ref: '#/definitions/SchedtagCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedtag_ValidateCreateDataOutput' - summary: 新建 - tags: - - schedtag - /schedtags/{id}: - delete: - description: 删除 - operationId: schedtag_CustomizeDelete - parameters: - - description: The Id or Name of schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedtag_CustomizeDeleteOutput' - summary: 删除 - tags: - - schedtag - get: - description: 获取详情 - operationId: schedtag_FetchCustomizeColumns - parameters: - - description: The Id or Name of schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedtag_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - schedtag - put: - description: 更新 - operationId: schedtag_ValidateUpdateData - parameters: - - description: The Id or Name of schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedtag_ValidateUpdateDataOutput' - summary: 更新 - tags: - - schedtag - /schedtags/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: schedtag_GetDetailsClassMetadata - parameters: - - description: The Id or Name of schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedtag_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - schedtag - post: - description: 执行操作ClassMetadata - operationId: schedtag_PerformClassMetadata - parameters: - - description: The Id or Name of schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - schedtag: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedtag_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - schedtag - /schedtags/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: schedtag_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 schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedtag_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - schedtag - /schedtags/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: schedtag_PerformSetClassMetadata - parameters: - - description: The Id or Name of schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - schedtag: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedtag_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - schedtag - /schedtags/{id}/set-resource: - post: - description: 执行操作SetResource - operationId: schedtag_PerformSetResource - parameters: - - description: The Id or Name of schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - schedtag: - $ref: '#/definitions/SchedtagSetResourceInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedtag_PerformSetResourceOutput' - summary: 执行操作SetResource - tags: - - schedtag - /schedtags/{id}/set-scope: - post: - description: 执行操作SetScope - operationId: schedtag_PerformSetScope - parameters: - - description: The Id or Name of schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/schedtag_PerformSetScopeOutput' - summary: 执行操作SetScope - tags: - - schedtag - /schedtags/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: schedtag_PerformSetUserMetadata - parameters: - - description: The Id or Name of schedtag - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - schedtag: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedtag_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - schedtag - /schedtags/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: schedtag_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/schedtag_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - schedtag - /schedtags/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: schedtag_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - schedtag: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/schedtag_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - schedtag - /schedtags/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: schedtag_GetPropertySplitable - responses: - "200": - $ref: '#/responses/schedtag_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - schedtag - /schedtags/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: schedtag_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/schedtag_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - schedtag - /schedtags/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: schedtag_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/schedtag_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - schedtag - /schedtags/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: schedtag_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/schedtag_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - schedtag - /security_group_caches: - get: - description: 列表 - operationId: security_group_cache_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 过滤关联指定安全组（ID或Name）的列表结果 - in: query - name: secgroup_id - type: string - x-go-name: SecgroupId - - description: 模糊匹配安全组规则名称 - in: query - name: secgroup_name - type: string - x-go-name: SecgroupName - - description: 以安全组排序 - in: query - name: order_by_secgroup - type: string - x-go-name: OrderBySecgroup - responses: - "200": - $ref: '#/responses/security_group_cache_ListItemFilterOutput' - summary: 安全组缓存列表 - tags: - - security_group_cache - post: - description: 新建 - operationId: security_group_cache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - security_group_cache: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_cache_ValidateCreateDataOutput' - summary: 新建 - tags: - - security_group_cache - /security_group_caches/{id}: - delete: - description: 删除 - operationId: security_group_cache_CustomizeDelete - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_cache_CustomizeDeleteOutput' - summary: 删除 - tags: - - security_group_cache - get: - description: 获取详情 - operationId: security_group_cache_FetchCustomizeColumns - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_cache_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - security_group_cache - put: - description: 更新 - operationId: security_group_cache_ValidateUpdateData - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group_cache: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_cache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - security_group_cache - /security_group_caches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: security_group_cache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_cache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - security_group_cache - post: - description: 执行操作ClassMetadata - operationId: security_group_cache_PerformClassMetadata - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_cache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - security_group_cache - /security_group_caches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: security_group_cache_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 security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_cache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - security_group_cache - /security_group_caches/{id}/references: - get: - description: 获取指定信息References - operationId: security_group_cache_GetDetailsReferences - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_cache_GetDetailsReferencesOutput' - summary: 获取引用信息 - tags: - - security_group_cache - /security_group_caches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: security_group_cache_PerformSetClassMetadata - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_cache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - security_group_cache - /security_group_caches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: security_group_cache_PerformSetUserMetadata - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_cache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - security_group_cache - /security_group_caches/{id}/status: - get: - description: 获取指定信息Status - operationId: security_group_cache_GetDetailsStatus - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_cache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - security_group_cache - post: - description: 执行操作Status - operationId: security_group_cache_PerformStatus - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group_cache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_cache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - security_group_cache - /security_group_caches/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: security_group_cache_PerformSyncstatus - parameters: - - description: The Id or Name of security_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group_cache: - $ref: '#/definitions/DiskSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_cache_PerformSyncstatusOutput' - summary: 同步安全组缓存状态 - tags: - - security_group_cache - /security_group_caches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: security_group_cache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/security_group_cache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - security_group_cache - /security_group_caches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: security_group_cache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - security_group_cache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_cache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - security_group_cache - /security_group_caches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: security_group_cache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/security_group_cache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - security_group_cache - /security_group_caches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: security_group_cache_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/security_group_cache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - security_group_cache - /security_group_caches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: security_group_cache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/security_group_cache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - security_group_cache - /security_group_caches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: security_group_cache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/security_group_cache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - security_group_cache - /security_group_caches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: security_group_cache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/security_group_cache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - security_group_cache - /security_group_rules: - get: - description: 列表 - operationId: security_group_rule_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 过滤关联指定安全组（ID或Name）的列表结果 - in: query - name: secgroup_id - type: string - x-go-name: SecgroupId - - description: 模糊匹配安全组规则名称 - in: query - name: secgroup_name - type: string - x-go-name: SecgroupName - - description: 以安全组排序 - in: query - name: order_by_secgroup - type: string - x-go-name: OrderBySecgroup - - in: query - items: - type: string - name: projects - type: array - x-go-name: Projects - - description: 以direction字段过滤安全组规则 - in: query - name: direction - type: string - x-go-name: Direction - - description: 以action字段过滤安全组规则 - in: query - name: action - type: string - x-go-name: Action - - description: 以protocol字段过滤安全组规则 - in: query - name: protocol - type: string - x-go-name: Protocol - - description: 以ports字段过滤安全组规则 - in: query - name: ports - type: string - x-go-name: Ports - - description: 根据ip模糊匹配安全组规则 - in: query - name: ip - type: string - x-go-name: Ip - responses: - "200": - $ref: '#/responses/security_group_rule_ListItemFilterOutput' - summary: 安全组规则列表 - tags: - - security_group_rule - post: - description: 新建 - operationId: security_group_rule_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - security_group_rule: - $ref: '#/definitions/SSecgroupRuleCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_rule_ValidateCreateDataOutput' - summary: 新建 - tags: - - security_group_rule - /security_group_rules/{id}: - delete: - description: 删除 - operationId: security_group_rule_CustomizeDelete - parameters: - - description: The Id or Name of security_group_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_rule_CustomizeDeleteOutput' - summary: 删除 - tags: - - security_group_rule - get: - description: 获取详情 - operationId: security_group_rule_FetchCustomizeColumns - parameters: - - description: The Id or Name of security_group_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_rule_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - security_group_rule - put: - description: 更新 - operationId: security_group_rule_ValidateUpdateData - parameters: - - description: The Id or Name of security_group_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group_rule: - $ref: '#/definitions/SSecgroupRuleUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_rule_ValidateUpdateDataOutput' - summary: 更新 - tags: - - security_group_rule - /security_group_rules/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: security_group_rule_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/security_group_rule_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - security_group_rule - /security_group_rules/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: security_group_rule_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - security_group_rule: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_rule_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - security_group_rule - /security_group_rules/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: security_group_rule_GetPropertySplitable - responses: - "200": - $ref: '#/responses/security_group_rule_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - security_group_rule - /security_group_rules/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: security_group_rule_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/security_group_rule_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - security_group_rule - /security_groups: - get: - description: 列表 - operationId: security_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: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: 主机（ID或Name） - in: query - name: server_id - type: string - x-go-name: ServerId - - description: RDS实例(ID or Name) - in: query - name: dbinstance_id - type: string - x-go-name: DBInstanceId - - description: 弹性缓存实例(ID or Name) - in: query - name: elasticcache_id - type: string - x-go-name: ElasticcacheId - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: equals - in: query - name: Equals - type: string - - description: 按缓存数量排序 - in: query - name: order_by_cache_cnt - pattern: asc|desc - type: string - x-go-name: OrderByCacheCnt - - description: 按缓存关联主机数排序 - in: query - name: order_by_guest_cnt - pattern: asc|desc - type: string - x-go-name: OrderByGuestCnt - - description: 模糊过滤规则中含有指定ip的安全组 - example: 10.10.2.1 - in: query - name: ip - type: string - x-go-name: Ip - - description: 精确匹配规则中含有指定端口的安全组 - example: 100-200 - in: query - name: ports - type: string - x-go-name: Ports - - default: all - description: '指定过滤规则的方向(仅在指定ip或ports时生效) choices: all|in|out' - example: in - in: query - name: direction - type: string - x-go-name: Direction - - in: query - name: witch_cache - type: boolean - x-go-name: WithCache - responses: - "200": - $ref: '#/responses/security_group_ListItemFilterOutput' - summary: 安全组列表 - tags: - - security_group - post: - description: 新建 - operationId: security_group_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - security_group: - $ref: '#/definitions/SSecgroupCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_ValidateCreateDataOutput' - summary: 新建 - tags: - - security_group - /security_groups/{id}: - delete: - description: 删除 - operationId: security_group_CustomizeDelete - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_CustomizeDeleteOutput' - summary: 删除 - tags: - - security_group - get: - description: 获取详情 - operationId: security_group_FetchCustomizeColumns - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - security_group - put: - description: 更新 - operationId: security_group_ValidateUpdateData - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_ValidateUpdateDataOutput' - summary: 更新 - tags: - - security_group - /security_groups/{id}/add-rule: - post: - description: 执行操作AddRule - operationId: security_group_PerformAddRule - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_PerformAddRuleOutput' - summary: 执行操作AddRule - tags: - - security_group - /security_groups/{id}/cache-secgroup: - post: - description: 执行操作CacheSecgroup - operationId: security_group_PerformCacheSecgroup - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/SecurityGroupCacheInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformCacheSecgroupOutput' - summary: 执行操作CacheSecgroup - tags: - - security_group - /security_groups/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: security_group_PerformCancelDelete - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - security_group - /security_groups/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: security_group_PerformChangeOwner - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - security_group - /security_groups/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: security_group_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - security_group - /security_groups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: security_group_GetDetailsClassMetadata - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - security_group - post: - description: 执行操作ClassMetadata - operationId: security_group_PerformClassMetadata - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - security_group - /security_groups/{id}/clone: - post: - description: 执行操作Clone - operationId: security_group_PerformClone - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/SecurityGroupCloneInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformCloneOutput' - summary: 执行操作Clone - tags: - - security_group - /security_groups/{id}/freeze: - post: - description: 执行操作Freeze - operationId: security_group_PerformFreeze - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - security_group - /security_groups/{id}/import-rules: - post: - description: 执行操作ImportRules - operationId: security_group_PerformImportRules - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/SecgroupImportRulesInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformImportRulesOutput' - summary: 执行操作ImportRules - tags: - - security_group - /security_groups/{id}/merge: - post: - description: 执行操作Merge - operationId: security_group_PerformMerge - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/SecgroupMergeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformMergeOutput' - summary: 执行操作Merge - tags: - - security_group - /security_groups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: security_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 security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - security_group - /security_groups/{id}/private: - post: - description: 执行操作Private - operationId: security_group_PerformPrivate - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformPrivateOutput' - summary: 执行操作Private - tags: - - security_group - /security_groups/{id}/public: - post: - description: 执行操作Public - operationId: security_group_PerformPublic - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformPublicOutput' - summary: 执行操作Public - tags: - - security_group - /security_groups/{id}/purge: - post: - description: 执行操作Purge - operationId: security_group_PerformPurge - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - security_group - /security_groups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: security_group_PerformSetClassMetadata - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - security_group - /security_groups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: security_group_PerformSetUserMetadata - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - security_group - /security_groups/{id}/status: - get: - description: 获取指定信息Status - operationId: security_group_GetDetailsStatus - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - security_group - post: - description: 执行操作Status - operationId: security_group_PerformStatus - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformStatusOutput' - summary: 更新资源状态 - tags: - - security_group - /security_groups/{id}/uncache-secgroup: - post: - description: 执行操作UncacheSecgroup - operationId: security_group_PerformUncacheSecgroup - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/security_group_PerformUncacheSecgroupOutput' - summary: 执行操作UncacheSecgroup - tags: - - security_group - /security_groups/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: security_group_PerformUnfreeze - parameters: - - description: The Id or Name of security_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - security_group - /security_groups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: security_group_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/security_group_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - security_group - /security_groups/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: security_group_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/security_group_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - security_group - /security_groups/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: security_group_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/security_group_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - security_group - /security_groups/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: security_group_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/security_group_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - security_group - /security_groups/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: security_group_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/security_group_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - security_group - /security_groups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: security_group_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - security_group: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/security_group_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - security_group - /security_groups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: security_group_GetPropertySplitable - responses: - "200": - $ref: '#/responses/security_group_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - security_group - /security_groups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: security_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/security_group_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - security_group - /security_groups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: security_group_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/security_group_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - security_group - /security_groups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: security_group_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/security_group_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - security_group - /security_groups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: security_group_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/security_group_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - security_group - /server_skus: - get: - description: 列表 - operationId: server_sku_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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 计费类型，按需计费和预付费 - in: query - name: billing_type - pattern: prepaid|postpaid - type: string - x-go-name: BillingType - - description: 计费过期时间的查询起始时间 - format: date-time - in: query - name: billing_expire_since - type: string - x-go-name: BillingExpireSince - - description: 计费过期时间的查询终止时间 - format: date-time - in: query - name: billing_expire_before - type: string - x-go-name: BillingExpireBefore - - description: 计费周期 - example: 7d - in: query - name: billing_cycle - type: string - x-go-name: BillingCycle - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: filter sku by memory size in MB - in: query - items: - format: int64 - type: integer - name: memory_size_mb - type: array - x-go-name: MemorySizeMb - - description: filter sku by CPU core count - in: query - items: - format: int64 - type: integer - name: cpu_core_count - type: array - x-go-name: CpuCoreCount - - description: 后付费状态 - in: query - name: postpaid_status - type: string - x-go-name: PostpaidStatus - - description: 预付费状态 - in: query - name: prepaid_status - type: string - x-go-name: PrepaidStatus - - description: 按套餐名称去重 - in: query - name: distinct - type: boolean - x-go-name: Distinct - - description: 按关联虚拟机数量排序 - in: query - name: order_by_total_guest_count - type: string - x-go-name: OrderByTotalGuestCount - responses: - "200": - $ref: '#/responses/server_sku_ListItemFilterOutput' - summary: 主机套餐规格列表 - tags: - - server_sku - post: - description: 新建 - operationId: server_sku_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - server_sku: - $ref: '#/definitions/ServerSkuCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_ValidateCreateDataOutput' - summary: 新建 - tags: - - server_sku - /server_skus/{id}: - delete: - description: 删除 - operationId: server_sku_CustomizeDelete - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_sku_CustomizeDeleteOutput' - summary: 删除 - tags: - - server_sku - get: - description: 获取详情 - operationId: server_sku_FetchCustomizeColumns - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_sku_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - server_sku - put: - description: 更新 - operationId: server_sku_ValidateUpdateData - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server_sku: - $ref: '#/definitions/ServerSkuUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_ValidateUpdateDataOutput' - summary: 更新 - tags: - - server_sku - /server_skus/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: server_sku_GetDetailsClassMetadata - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_sku_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - server_sku - post: - description: 执行操作ClassMetadata - operationId: server_sku_PerformClassMetadata - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - server_sku - /server_skus/{id}/disable: - post: - description: 执行操作Disable - operationId: server_sku_PerformDisable - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server_sku: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_PerformDisableOutput' - summary: 禁用资源 - tags: - - server_sku - /server_skus/{id}/enable: - post: - description: 执行操作Enable - operationId: server_sku_PerformEnable - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server_sku: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_PerformEnableOutput' - summary: 启用资源 - tags: - - server_sku - /server_skus/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: server_sku_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 server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_sku_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - server_sku - /server_skus/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: server_sku_PerformSetClassMetadata - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - server_sku - /server_skus/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: server_sku_PerformSetUserMetadata - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server_sku: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - server_sku - /server_skus/{id}/status: - get: - description: 获取指定信息Status - operationId: server_sku_GetDetailsStatus - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_sku_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - server_sku - post: - description: 执行操作Status - operationId: server_sku_PerformStatus - parameters: - - description: The Id or Name of server_sku - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server_sku: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_PerformStatusOutput' - summary: 更新资源状态 - tags: - - server_sku - /server_skus/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: server_sku_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/server_sku_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - server_sku - /server_skus/instance-specs: - get: - description: 获取指定资源类的信息InstanceSpecs - operationId: server_sku_GetPropertyInstanceSpecs - responses: - "200": - $ref: '#/responses/server_sku_GetPropertyInstanceSpecsOutput' - summary: 获取指定资源类的信息InstanceSpecs - tags: - - server_sku - /server_skus/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: server_sku_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - server_sku: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - server_sku - /server_skus/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: server_sku_GetPropertySplitable - responses: - "200": - $ref: '#/responses/server_sku_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - server_sku - /server_skus/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: server_sku_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/server_sku_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - server_sku - /server_skus/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: server_sku_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/server_sku_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - server_sku - /server_skus/sync-skus: - post: - description: 执行操作SyncSkus - operationId: server_sku_PerformSyncSkus - parameters: - - in: body - name: body - schema: - properties: - server_sku: - $ref: '#/definitions/SkuSyncInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_sku_PerformSyncSkusOutput' - summary: 执行操作SyncSkus - tags: - - server_sku - /server_skus/sync-tasks: - get: - description: 获取指定资源类的信息SyncTasks - operationId: server_sku_GetPropertySyncTasks - parameters: - - description: 异步任务ID - in: query - items: - type: string - name: task_ids - type: array - x-go-name: TaskIds - responses: - "200": - $ref: '#/responses/server_sku_GetPropertySyncTasksOutput' - summary: 获取指定资源类的信息SyncTasks - tags: - - server_sku - /server_skus/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: server_sku_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/server_sku_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - server_sku - /server_skus/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: server_sku_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/server_sku_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - server_sku - /servers: - get: - description: 列表 - operationId: server_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 是否禁止删除 - in: query - name: disable_delete - type: boolean - x-go-name: DisableDelete - - description: |- - 通过操作系统架构过滤 - x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 - arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 - 其他的输入会过滤出以输入字符开头的资源 - enmu: x86, arm - in: query - name: os_arch - type: string - x-go-name: OsArch - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - description: 以宿主机序列号过滤 - in: query - name: host_sn - type: string - x-go-name: HostSN - - description: 以宿主机名称排序 - in: query - name: order_by_host - type: string - x-go-name: OrderByHost - - description: 以宿主机序列号名称排序 - in: query - name: order_by_host_sn - type: string - x-go-name: OrderByHostSN - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 二层网络(ID或Name)的资源 - in: query - name: wire_id - type: string - x-go-name: WireId - - description: 以二层网络名称排序 - in: query - name: order_by_wire - type: string - x-go-name: OrderByWire - - description: IP子网（ID或Name） - in: query - name: network_id - type: string - x-go-name: NetworkId - - description: 以IP子网的名称排序 - in: query - name: order_by_network - type: string - x-go-name: OrderByNetwork - - description: 计费类型，按需计费和预付费 - in: query - name: billing_type - pattern: prepaid|postpaid - type: string - x-go-name: BillingType - - description: 计费过期时间的查询起始时间 - format: date-time - in: query - name: billing_expire_since - type: string - x-go-name: BillingExpireSince - - description: 计费过期时间的查询终止时间 - format: date-time - in: query - name: billing_expire_before - type: string - x-go-name: BillingExpireBefore - - description: 计费周期 - example: 7d - in: query - name: billing_cycle - type: string - x-go-name: BillingCycle - - description: 实例组（ID或Name） - in: query - name: group_id - type: string - x-go-name: GroupId - - description: 按组名排序 - in: query - name: order_by_group - type: string - x-go-name: OrderByGroup - - description: 过滤关联指定安全组（ID或Name）的列表结果 - in: query - name: secgroup_id - type: string - x-go-name: SecgroupId - - description: 模糊匹配安全组规则名称 - in: query - name: secgroup_name - type: string - x-go-name: SecgroupName - - description: 以安全组排序 - in: query - name: order_by_secgroup - type: string - x-go-name: OrderBySecgroup - - description: 'description: 伸缩组 Id or Name' - example: sg-1234 - in: query - name: scaling_group - type: string - x-go-name: ScalingGroup - - description: 只列出裸金属主机 - in: query - name: baremetal - type: boolean - x-go-name: Baremetal - - description: 只列出透传了 GPU 的主机 - in: query - name: gpu - type: boolean - x-go-name: Gpu - - description: 只列出透传了 USB 的主机 - in: query - name: usb - type: boolean - x-go-name: Usb - - description: 自定义 PCI 设备类型 - in: query - name: custom_dev_type - type: string - x-go-name: CustomDevType - - description: 通用虚拟机 - in: query - name: normal - type: boolean - x-go-name: Normal - - description: 只列出还有备份机的主机 - in: query - name: bakcup - type: boolean - x-go-name: Backup - - description: 列出指定类型的主机 - enum: - - normal - - gpu - - usb - - backup - in: query - name: server_type - type: string - x-go-name: ServerType - - description: 列出管理安全组为指定安全组的主机 - in: query - name: admin_security - type: string - x-go-name: AdminSecgroup - - description: 列出Hypervisor为指定值的主机 - enum: - - kvm - - esxi - - baremetal - - aliyun - - azure - - aws - - huawei - - ucloud - - zstack - - openstack - - google - - ctyun - - cloudpods - - ecloud - - jdcloud - - remotefile` - in: query - items: - type: string - name: hypervisor - type: array - x-go-name: Hypervisor - - description: 列出绑定了弹性IP（EIP）的主机 - in: query - name: with_eip - type: boolean - x-go-name: WithEip - - description: 列出未绑定弹性IP（EIP）的主机 - in: query - name: without_eip - type: boolean - x-go-name: WithoutEip - - description: 列出可绑定弹性IP的主机 - in: query - name: eip_associable - type: boolean - x-go-name: EipAssociable - - description: 列出操作系统为指定值的主机 - enum: - - linux - - windows - - vmware - in: query - items: - type: string - name: os_type - type: array - x-go-name: OsType - - description: 对列表结果按照磁盘大小进行排序 - enum: - - asc - - desc - in: query - name: order_by_disk - type: string - x-go-name: OrderByDisk - - in: query - name: order_by_ip - type: string - x-go-name: OrderByIp - - description: 根据ip查找机器 - in: query - name: ip_addr - type: string - x-go-name: IpAddr - - description: 根据多个ip查找机器 - in: query - items: - type: string - name: ip_addrs - type: array - x-go-name: IpAddrs - - description: 列出可以挂载指定EIP的主机 - in: query - name: usable_server_for_eip - type: string - x-go-name: UsableServerForEip - - description: 列出可以挂载磁盘的主机 - in: query - name: attachable_servers_for_disk - type: string - x-go-name: AttachableServersForDisk - - description: |- - Deprecated - 列出可以挂载磁盘的主机 - in: query - name: disk - type: string - x-go-name: Disk - - description: 按主机资源类型进行排序 - enum: - - shared - - prepaid - - dedicated - in: query - name: resource_type - type: string - x-go-name: ResourceType - - description: 返回该宿主机上的所有虚拟机，包括备份机 - in: query - name: get_all_guests_on_host - type: string - x-go-name: GetAllGuestsOnHost - - in: query - items: - format: int64 - type: integer - name: vcpu_count - type: array - x-go-name: VcpuCount - - in: query - items: - format: int64 - type: integer - name: vmem_size - type: array - x-go-name: VmemSize - - in: query - items: - type: string - name: boot_order - type: array - x-go-name: BootOrder - - in: query - items: - type: string - name: vga - type: array - x-go-name: Vga - - in: query - items: - type: string - name: vdi - type: array - x-go-name: Vdi - - in: query - items: - type: string - name: machine - type: array - x-go-name: Machine - - in: query - items: - type: string - name: bios - type: array - x-go-name: Bios - - in: query - name: src_ip_check - type: boolean - x-go-name: SrcIpCheck - - in: query - name: src_mac_check - type: boolean - x-go-name: SrcMacCheck - - in: query - items: - type: string - name: instance_type - type: array - x-go-name: InstanceType - - description: 是否调度到宿主机上 - in: query - name: with_host - type: boolean - x-go-name: WithHost - responses: - "200": - $ref: '#/responses/server_ListItemFilterOutput' - summary: 云主机实例列表 - tags: - - server - post: - description: 新建 - operationId: server_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - server: - $ref: '#/definitions/ServerCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_ValidateCreateDataOutput' - summary: 创建虚拟机实例 - tags: - - server - /servers/{id}: - delete: - description: 删除 - operationId: server_CustomizeDelete - parameters: - - default: false - description: 是否越过回收站直接删除 - in: query - name: OverridePendingDelete - type: boolean - - default: false - description: 是否仅删除本地资源 - in: query - name: Purge - type: boolean - - default: false - description: 是否删除快照 - in: query - name: DeleteSnapshots - type: boolean - - default: false - description: 是否删除关联的EIP - in: query - name: DeleteEip - type: boolean - - default: false - description: 是否删除关联的数据盘 - in: query - name: DeleteDisks - type: boolean - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_CustomizeDeleteOutput' - summary: 删除虚拟机 - tags: - - server - get: - description: 获取详情 - operationId: server_FetchCustomizeColumns - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - server - put: - description: 更新 - operationId: server_ValidateUpdateData - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_ValidateUpdateDataOutput' - summary: 更新 - tags: - - server - /servers/{id}/add-secgroup: - post: - description: 执行操作AddSecgroup - operationId: server_PerformAddSecgroup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestAddSecgroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformAddSecgroupOutput' - summary: 绑定多个安全组 - tags: - - server - /servers/{id}/assign-admin-secgroup: - post: - description: 执行操作AssignAdminSecgroup - operationId: server_PerformAssignAdminSecgroup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestAssignSecgroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformAssignAdminSecgroupOutput' - summary: 执行操作AssignAdminSecgroup - tags: - - server - /servers/{id}/associate-eip: - post: - description: 执行操作AssociateEip - operationId: server_PerformAssociateEip - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerAssociateEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformAssociateEipOutput' - summary: 执行操作AssociateEip - tags: - - server - /servers/{id}/attach-isolated-device: - post: - description: 执行操作AttachIsolatedDevice - operationId: server_PerformAttachIsolatedDevice - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformAttachIsolatedDeviceOutput' - summary: 执行操作AttachIsolatedDevice - tags: - - server - /servers/{id}/attachdisk: - post: - description: 执行操作Attachdisk - operationId: server_PerformAttachdisk - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerAttachDiskInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformAttachdiskOutput' - summary: 执行操作Attachdisk - tags: - - server - /servers/{id}/attachnetwork: - post: - description: 执行操作Attachnetwork - operationId: server_PerformAttachnetwork - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/AttachNetworkInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformAttachnetworkOutput' - summary: 执行操作Attachnetwork - tags: - - server - /servers/{id}/bind-groups: - post: - description: 执行操作BindGroups - operationId: server_PerformBindGroups - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformBindGroupsOutput' - summary: 执行操作BindGroups - tags: - - server - /servers/{id}/block-mirror-ready: - post: - description: 执行操作BlockMirrorReady - operationId: server_PerformBlockMirrorReady - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformBlockMirrorReadyOutput' - summary: 执行操作BlockMirrorReady - tags: - - server - /servers/{id}/block-stream-failed: - post: - description: 执行操作BlockStreamFailed - operationId: server_PerformBlockStreamFailed - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformBlockStreamFailedOutput' - summary: 执行操作BlockStreamFailed - tags: - - server - /servers/{id}/calculate-record-checksum: - post: - description: 执行操作CalculateRecordChecksum - operationId: server_PerformCalculateRecordChecksum - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformCalculateRecordChecksumOutput' - summary: 执行操作CalculateRecordChecksum - tags: - - server - /servers/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: server_PerformCancelDelete - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - server - /servers/{id}/cancel-expire: - post: - description: 执行操作CancelExpire - operationId: server_PerformCancelExpire - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformCancelExpireOutput' - summary: 执行操作CancelExpire - tags: - - server - /servers/{id}/cancel-live-migrate: - post: - description: 执行操作CancelLiveMigrate - operationId: server_PerformCancelLiveMigrate - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformCancelLiveMigrateOutput' - summary: 执行操作CancelLiveMigrate - tags: - - server - /servers/{id}/change-bandwidth: - post: - description: 执行操作ChangeBandwidth - operationId: server_PerformChangeBandwidth - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformChangeBandwidthOutput' - summary: 执行操作ChangeBandwidth - tags: - - server - /servers/{id}/change-config: - post: - description: 执行操作ChangeConfig - operationId: server_PerformChangeConfig - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerChangeConfigInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformChangeConfigOutput' - summary: 执行操作ChangeConfig - tags: - - server - /servers/{id}/change-disk-storage: - post: - description: 执行操作ChangeDiskStorage - operationId: server_PerformChangeDiskStorage - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerChangeDiskStorageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformChangeDiskStorageOutput' - summary: 执行操作ChangeDiskStorage - tags: - - server - /servers/{id}/change-ipaddr: - post: - description: |- - first detach the network, then attach a network with identity mac address but different IP configurations - TODO change IP address of a teaming NIC may fail!! - operationId: server_PerformChangeIpaddr - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformChangeIpaddrOutput' - summary: Change IPaddress of a guestnetwork - tags: - - server - /servers/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: server_PerformChangeOwner - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - server - /servers/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: server_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - server - /servers/{id}/change-storage: - post: - description: 执行操作ChangeStorage - operationId: server_PerformChangeStorage - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerChangeStorageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformChangeStorageOutput' - summary: 执行操作ChangeStorage - tags: - - server - /servers/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: server_GetDetailsClassMetadata - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - server - post: - description: 执行操作ClassMetadata - operationId: server_PerformClassMetadata - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - server - /servers/{id}/clone: - post: - description: 执行操作Clone - operationId: server_PerformClone - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformCloneOutput' - summary: 执行操作Clone - tags: - - server - /servers/{id}/close-forward: - post: - description: 执行操作CloseForward - operationId: server_PerformCloseForward - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformCloseForwardOutput' - summary: 执行操作CloseForward - tags: - - server - /servers/{id}/convert: - post: - description: 执行操作Convert - operationId: server_PerformConvert - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ConvertEsxiToKvmInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformConvertOutput' - summary: 执行操作Convert - tags: - - server - /servers/{id}/convert-to-kvm: - post: - description: 执行操作ConvertToKvm - operationId: server_PerformConvertToKvm - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ConvertEsxiToKvmInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformConvertToKvmOutput' - summary: 执行操作ConvertToKvm - tags: - - server - /servers/{id}/cpuset: - post: - description: 执行操作Cpuset - operationId: server_PerformCpuset - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerCPUSetInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformCpusetOutput' - summary: 执行操作Cpuset - tags: - - server - /servers/{id}/cpuset-cores: - get: - description: 获取指定信息CpusetCores - operationId: server_GetDetailsCpusetCores - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsCpusetCoresOutput' - summary: 获取指定信息CpusetCores - tags: - - server - /servers/{id}/cpuset-remove: - post: - description: 执行操作CpusetRemove - operationId: server_PerformCpusetRemove - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerCPUSetRemoveInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformCpusetRemoveOutput' - summary: 执行操作CpusetRemove - tags: - - server - /servers/{id}/create-backup: - post: - description: 执行操作CreateBackup - operationId: server_PerformCreateBackup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformCreateBackupOutput' - summary: 执行操作CreateBackup - tags: - - server - /servers/{id}/create-eip: - post: - description: 执行操作CreateEip - operationId: server_PerformCreateEip - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerCreateEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformCreateEipOutput' - summary: 执行操作CreateEip - tags: - - server - /servers/{id}/create-params: - get: - description: 获取指定信息CreateParams - operationId: server_GetDetailsCreateParams - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsCreateParamsOutput' - summary: 获取指定信息CreateParams - tags: - - server - /servers/{id}/createdisk: - post: - description: 执行操作Createdisk - operationId: server_PerformCreatedisk - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformCreatediskOutput' - summary: 执行操作Createdisk - tags: - - server - /servers/{id}/del-extra-option: - post: - description: 执行操作DelExtraOption - operationId: server_PerformDelExtraOption - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerDelExtraOptionInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformDelExtraOptionOutput' - summary: 执行操作DelExtraOption - tags: - - server - /servers/{id}/delete-backup: - post: - description: 执行操作DeleteBackup - operationId: server_PerformDeleteBackup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformDeleteBackupOutput' - summary: 执行操作DeleteBackup - tags: - - server - /servers/{id}/deploy: - post: - description: 执行操作Deploy - operationId: server_PerformDeploy - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerDeployInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformDeployOutput' - summary: 执行操作Deploy - tags: - - server - /servers/{id}/desc: - get: - description: 获取指定信息Desc - operationId: server_GetDetailsDesc - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsDescOutput' - summary: 获取指定信息Desc - tags: - - server - /servers/{id}/detach-isolated-device: - post: - description: 执行操作DetachIsolatedDevice - operationId: server_PerformDetachIsolatedDevice - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformDetachIsolatedDeviceOutput' - summary: 执行操作DetachIsolatedDevice - tags: - - server - /servers/{id}/detach-scaling-group: - post: - description: 执行操作DetachScalingGroup - operationId: server_PerformDetachScalingGroup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/SGPerformDetachScalingGroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformDetachScalingGroupOutput' - summary: 执行操作DetachScalingGroup - tags: - - server - /servers/{id}/detachdisk: - post: - description: 执行操作Detachdisk - operationId: server_PerformDetachdisk - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerDetachDiskInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformDetachdiskOutput' - summary: 执行操作Detachdisk - tags: - - server - /servers/{id}/detachnetwork: - post: - description: 执行操作Detachnetwork - operationId: server_PerformDetachnetwork - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerDetachnetworkInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformDetachnetworkOutput' - summary: 执行操作Detachnetwork - tags: - - server - /servers/{id}/dissociate-eip: - post: - description: 执行操作DissociateEip - operationId: server_PerformDissociateEip - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerDissociateEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformDissociateEipOutput' - summary: 执行操作DissociateEip - tags: - - server - /servers/{id}/ejectiso: - post: - description: 执行操作Ejectiso - operationId: server_PerformEjectiso - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformEjectisoOutput' - summary: 执行操作Ejectiso - tags: - - server - /servers/{id}/ejectvfd: - post: - description: 执行操作Ejectvfd - operationId: server_PerformEjectvfd - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerEjectVfdInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformEjectvfdOutput' - summary: 执行操作Ejectvfd - tags: - - server - /servers/{id}/enable-memclean: - post: - description: 执行操作EnableMemclean - operationId: server_PerformEnableMemclean - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformEnableMemcleanOutput' - summary: 执行操作EnableMemclean - tags: - - server - /servers/{id}/event: - post: - description: 执行操作Event - operationId: server_PerformEvent - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformEventOutput' - summary: 执行操作Event - tags: - - server - /servers/{id}/freeze: - post: - description: 执行操作Freeze - operationId: server_PerformFreeze - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformFreezeOutput' - summary: 执行操作Freeze - tags: - - server - /servers/{id}/have-agent: - post: - description: 执行操作HaveAgent - operationId: server_PerformHaveAgent - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestHaveAgentInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformHaveAgentOutput' - summary: 执行操作HaveAgent - tags: - - server - /servers/{id}/insertiso: - post: - description: 执行操作Insertiso - operationId: server_PerformInsertiso - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformInsertisoOutput' - summary: 执行操作Insertiso - tags: - - server - /servers/{id}/insertvfd: - post: - description: 执行操作Insertvfd - operationId: server_PerformInsertvfd - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerInsertVfdInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformInsertvfdOutput' - summary: 执行操作Insertvfd - tags: - - server - /servers/{id}/instance-backup: - post: - description: 执行操作InstanceBackup - operationId: server_PerformInstanceBackup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformInstanceBackupOutput' - summary: 执行操作InstanceBackup - tags: - - server - /servers/{id}/instance-snapshot: - post: - description: |- - 2. validate every disk manual snapshot count - 3. validate snapshot quota with disk count - operationId: server_PerformInstanceSnapshot - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerInstanceSnapshot' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformInstanceSnapshotOutput' - summary: 1. validate guest status, guest hypervisor - tags: - - server - /servers/{id}/instance-snapshot-reset: - post: - description: 执行操作InstanceSnapshotReset - operationId: server_PerformInstanceSnapshotReset - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerResetInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformInstanceSnapshotResetOutput' - summary: 执行操作InstanceSnapshotReset - tags: - - server - /servers/{id}/io-throttle: - post: - description: 执行操作IoThrottle - operationId: server_PerformIoThrottle - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformIoThrottleOutput' - summary: 执行操作IoThrottle - tags: - - server - /servers/{id}/iso: - get: - description: 获取指定信息Iso - operationId: server_GetDetailsIso - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsIsoOutput' - summary: 获取指定信息Iso - tags: - - server - /servers/{id}/jnlp: - get: - description: 获取指定信息Jnlp - operationId: server_GetDetailsJnlp - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsJnlpOutput' - summary: 获取指定信息Jnlp - tags: - - server - /servers/{id}/list-forward: - post: - description: 执行操作ListForward - operationId: server_PerformListForward - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformListForwardOutput' - summary: 执行操作ListForward - tags: - - server - /servers/{id}/live-migrate: - post: - description: 执行操作LiveMigrate - operationId: server_PerformLiveMigrate - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestLiveMigrateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformLiveMigrateOutput' - summary: 执行操作LiveMigrate - tags: - - server - /servers/{id}/make-sshable: - post: - description: 执行操作MakeSshable - operationId: server_PerformMakeSshable - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestMakeSshableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformMakeSshableOutput' - summary: 执行操作MakeSshable - tags: - - server - /servers/{id}/make-sshable-cmd: - get: - description: 获取指定信息MakeSshableCmd - operationId: server_GetDetailsMakeSshableCmd - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsMakeSshableCmdOutput' - summary: 获取指定信息MakeSshableCmd - tags: - - server - /servers/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: server_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 server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - server - /servers/{id}/migrate: - post: - description: 执行操作Migrate - operationId: server_PerformMigrate - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestMigrateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformMigrateOutput' - summary: 执行操作Migrate - tags: - - server - /servers/{id}/migrate-forecast: - post: - description: 执行操作MigrateForecast - operationId: server_PerformMigrateForecast - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerMigrateForecastInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformMigrateForecastOutput' - summary: 执行操作MigrateForecast - tags: - - server - /servers/{id}/migrate-network: - post: - description: 'Scenerio: the server used to be in a VPC, migrate it to a underlay - network without network interruption' - operationId: server_PerformMigrateNetwork - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerMigrateNetworkInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformMigrateNetworkOutput' - summary: Migrate a server from one network to another network, without change - IP address - tags: - - server - /servers/{id}/modify-src-check: - post: - description: 执行操作ModifySrcCheck - operationId: server_PerformModifySrcCheck - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformModifySrcCheckOutput' - summary: 执行操作ModifySrcCheck - tags: - - server - /servers/{id}/monitor: - post: - description: 执行操作Monitor - operationId: server_PerformMonitor - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerMonitorInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformMonitorOutput' - summary: 执行操作Monitor - tags: - - server - /servers/{id}/open-forward: - post: - description: 执行操作OpenForward - operationId: server_PerformOpenForward - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformOpenForwardOutput' - summary: 执行操作OpenForward - tags: - - server - /servers/{id}/postpaid-expire: - post: - description: 执行操作PostpaidExpire - operationId: server_PerformPostpaidExpire - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/PostpaidExpireInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformPostpaidExpireOutput' - summary: 执行操作PostpaidExpire - tags: - - server - /servers/{id}/prepaid-recycle: - post: - description: 执行操作PrepaidRecycle - operationId: server_PerformPrepaidRecycle - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformPrepaidRecycleOutput' - summary: 执行操作PrepaidRecycle - tags: - - server - /servers/{id}/probe-isolated-devices: - post: - description: 执行操作ProbeIsolatedDevices - operationId: server_PerformProbeIsolatedDevices - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformProbeIsolatedDevicesOutput' - summary: 执行操作ProbeIsolatedDevices - tags: - - server - /servers/{id}/publicip-to-eip: - post: - description: |- - 要求虚拟机有公网IP,并且虚拟机状态为running 或 ready - 目前仅支持阿里云和腾讯云 - operationId: server_PerformPublicipToEip - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestPublicipToEipInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformPublicipToEipOutput' - summary: 公网Ip转Eip - tags: - - server - /servers/{id}/purge: - post: - description: 执行操作Purge - operationId: server_PerformPurge - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - server - /servers/{id}/qemu-info: - get: - description: 获取指定信息QemuInfo - operationId: server_GetDetailsQemuInfo - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsQemuInfoOutput' - summary: 获取指定信息QemuInfo - tags: - - server - /servers/{id}/qga-command: - post: - description: 执行操作QgaCommand - operationId: server_PerformQgaCommand - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerQgaCommandInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformQgaCommandOutput' - summary: 执行操作QgaCommand - tags: - - server - /servers/{id}/qga-set-password: - post: - description: 执行操作QgaSetPassword - operationId: server_PerformQgaSetPassword - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerQgaSetPasswordInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformQgaSetPasswordOutput' - summary: 执行操作QgaSetPassword - tags: - - server - /servers/{id}/rebuild-root: - post: - description: 执行操作RebuildRoot - operationId: server_PerformRebuildRoot - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerRebuildRootInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformRebuildRootOutput' - summary: 重装系统(更换系统镜像) - tags: - - server - /servers/{id}/remote-nics: - get: - description: 获取指定信息RemoteNics - operationId: server_GetDetailsRemoteNics - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsRemoteNicsOutput' - summary: 获取指定信息RemoteNics - tags: - - server - /servers/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: server_PerformRemoteUpdate - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - server - /servers/{id}/renew: - post: - description: 执行操作Renew - operationId: server_PerformRenew - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformRenewOutput' - summary: 执行操作Renew - tags: - - server - /servers/{id}/reset: - post: - description: 执行操作Reset - operationId: server_PerformReset - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformResetOutput' - summary: 执行操作Reset - tags: - - server - /servers/{id}/resize-disk: - post: - description: 执行操作ResizeDisk - operationId: server_PerformResizeDisk - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerResizeDiskInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformResizeDiskOutput' - summary: 执行操作ResizeDisk - tags: - - server - /servers/{id}/restart: - post: - description: 执行操作Restart - operationId: server_PerformRestart - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformRestartOutput' - summary: 执行操作Restart - tags: - - server - /servers/{id}/resume: - post: - description: 执行操作Resume - operationId: server_PerformResume - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerResumeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformResumeOutput' - summary: 执行操作Resume - tags: - - server - /servers/{id}/revoke-admin-secgroup: - post: - description: 执行操作RevokeAdminSecgroup - operationId: server_PerformRevokeAdminSecgroup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestRevokeSecgroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformRevokeAdminSecgroupOutput' - summary: 执行操作RevokeAdminSecgroup - tags: - - server - /servers/{id}/revoke-secgroup: - post: - description: 执行操作RevokeSecgroup - operationId: server_PerformRevokeSecgroup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestRevokeSecgroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformRevokeSecgroupOutput' - summary: 执行操作RevokeSecgroup - tags: - - server - /servers/{id}/save-guest-image: - post: - description: 执行操作SaveGuestImage - operationId: server_PerformSaveGuestImage - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerSaveGuestImageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSaveGuestImageOutput' - summary: 执行操作SaveGuestImage - tags: - - server - /servers/{id}/save-image: - post: - description: 执行操作SaveImage - operationId: server_PerformSaveImage - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerSaveImageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSaveImageOutput' - summary: 执行操作SaveImage - tags: - - server - /servers/{id}/save-template: - post: - description: 执行操作SaveTemplate - operationId: server_PerformSaveTemplate - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestSaveToTemplateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSaveTemplateOutput' - summary: 执行操作SaveTemplate - tags: - - server - /servers/{id}/sendkeys: - post: - description: 执行操作Sendkeys - operationId: server_PerformSendkeys - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformSendkeysOutput' - summary: 执行操作Sendkeys - tags: - - server - /servers/{id}/set-auto-renew: - post: - description: |- - 要求虚拟机状态为running 或 ready - 要求虚拟机计费类型为包年包月(预付费) - operationId: server_PerformSetAutoRenew - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestAutoRenewInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSetAutoRenewOutput' - summary: 设置自动续费 - tags: - - server - /servers/{id}/set-boot-index: - post: - description: 执行操作SetBootIndex - operationId: server_PerformSetBootIndex - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerSetBootIndexInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSetBootIndexOutput' - summary: 执行操作SetBootIndex - tags: - - server - /servers/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: server_PerformSetClassMetadata - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - server - /servers/{id}/set-extra-option: - post: - description: 执行操作SetExtraOption - operationId: server_PerformSetExtraOption - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerSetExtraOptionInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSetExtraOptionOutput' - summary: 执行操作SetExtraOption - tags: - - server - /servers/{id}/set-isolated-device: - post: - description: 执行操作SetIsolatedDevice - operationId: server_PerformSetIsolatedDevice - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformSetIsolatedDeviceOutput' - summary: 执行操作SetIsolatedDevice - tags: - - server - /servers/{id}/set-live-migrate-params: - post: - description: 执行操作SetLiveMigrateParams - operationId: server_PerformSetLiveMigrateParams - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerSetLiveMigrateParamsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSetLiveMigrateParamsOutput' - summary: 执行操作SetLiveMigrateParams - tags: - - server - /servers/{id}/set-password: - post: - description: 执行操作SetPassword - operationId: server_PerformSetPassword - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerSetPasswordInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSetPasswordOutput' - summary: 执行操作SetPassword - tags: - - server - /servers/{id}/set-qemu-params: - post: - description: 执行操作SetQemuParams - operationId: server_PerformSetQemuParams - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformSetQemuParamsOutput' - summary: 执行操作SetQemuParams - tags: - - server - /servers/{id}/set-secgroup: - post: - description: 执行操作SetSecgroup - operationId: server_PerformSetSecgroup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestSetSecgroupInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSetSecgroupOutput' - summary: 全量覆盖安全组 - tags: - - server - /servers/{id}/set-sshport: - post: - description: 执行操作SetSshport - operationId: server_PerformSetSshport - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestSetSshportInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSetSshportOutput' - summary: 执行操作SetSshport - tags: - - server - /servers/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: server_PerformSetUserMetadata - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - server - /servers/{id}/slave-block-stream-ready: - post: - description: 执行操作SlaveBlockStreamReady - operationId: server_PerformSlaveBlockStreamReady - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformSlaveBlockStreamReadyOutput' - summary: 执行操作SlaveBlockStreamReady - tags: - - server - /servers/{id}/snapshot-and-clone: - post: - description: 执行操作SnapshotAndClone - operationId: server_PerformSnapshotAndClone - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerSnapshotAndCloneInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSnapshotAndCloneOutput' - summary: 执行操作SnapshotAndClone - tags: - - server - /servers/{id}/sshable: - get: - description: 获取指定信息Sshable - operationId: server_GetDetailsSshable - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsSshableOutput' - summary: 获取指定信息Sshable - tags: - - server - /servers/{id}/sshport: - get: - description: 获取指定信息Sshport - operationId: server_GetDetailsSshport - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsSshportOutput' - summary: 获取指定信息Sshport - tags: - - server - /servers/{id}/start: - post: - description: 执行操作Start - operationId: server_PerformStart - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformStartOutput' - summary: 执行操作Start - tags: - - server - /servers/{id}/start-backup: - post: - description: 执行操作StartBackup - operationId: server_PerformStartBackup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformStartBackupOutput' - summary: 执行操作StartBackup - tags: - - server - /servers/{id}/status: - get: - description: 获取指定信息Status - operationId: server_GetDetailsStatus - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - server - post: - description: 执行操作Status - operationId: server_PerformStatus - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformStatusOutput' - summary: 执行操作Status - tags: - - server - /servers/{id}/stop: - post: - description: 执行操作Stop - operationId: server_PerformStop - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerStopInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformStopOutput' - summary: 执行操作Stop - tags: - - server - /servers/{id}/stream-disks-complete: - post: - description: 执行操作StreamDisksComplete - operationId: server_PerformStreamDisksComplete - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformStreamDisksCompleteOutput' - summary: 执行操作StreamDisksComplete - tags: - - server - /servers/{id}/suspend: - post: - description: 执行操作Suspend - operationId: server_PerformSuspend - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformSuspendOutput' - summary: 执行操作Suspend - tags: - - server - /servers/{id}/switch-to-backup: - post: - description: 执行操作SwitchToBackup - operationId: server_PerformSwitchToBackup - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformSwitchToBackupOutput' - summary: 执行操作SwitchToBackup - tags: - - server - /servers/{id}/sync: - post: - description: 执行操作Sync - operationId: server_PerformSync - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformSyncOutput' - summary: 执行操作Sync - tags: - - server - /servers/{id}/sync-fix-nics: - post: - description: 执行操作SyncFixNics - operationId: server_PerformSyncFixNics - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/GuestSyncFixNicsInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformSyncFixNicsOutput' - summary: 执行操作SyncFixNics - tags: - - server - /servers/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: server_PerformSyncstatus - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformSyncstatusOutput' - summary: 同步虚拟机状态 - tags: - - server - /servers/{id}/tasks: - get: - description: 获取指定信息Tasks - operationId: server_GetDetailsTasks - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsTasksOutput' - summary: 获取指定信息Tasks - tags: - - server - /servers/{id}/unbind-groups: - post: - description: 执行操作UnbindGroups - operationId: server_PerformUnbindGroups - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformUnbindGroupsOutput' - summary: 执行操作UnbindGroups - tags: - - server - /servers/{id}/undo-prepaid-recycle: - post: - description: 执行操作UndoPrepaidRecycle - operationId: server_PerformUndoPrepaidRecycle - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_PerformUndoPrepaidRecycleOutput' - summary: 执行操作UndoPrepaidRecycle - tags: - - server - /servers/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: server_PerformUnfreeze - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - server - /servers/{id}/user-data: - post: - description: 执行操作UserData - operationId: server_PerformUserData - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/ServerUserDataInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformUserDataOutput' - summary: 执行操作UserData - tags: - - server - /servers/{id}/virt-install: - get: - description: 获取指定信息VirtInstall - operationId: server_GetDetailsVirtInstall - parameters: - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsVirtInstallOutput' - summary: 获取指定信息VirtInstall - tags: - - server - /servers/{id}/vnc: - get: - description: 获取指定信息Vnc - operationId: server_GetDetailsVnc - parameters: - - default: false - description: 是否使用原生vnc控制台，此选项仅对openstack有效 - in: query - name: origin - type: boolean - x-go-name: Origin - - description: The Id or Name of server - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/server_GetDetailsVncOutput' - summary: 获取指定信息Vnc - tags: - - server - /servers/batch-migrate: - post: - description: 执行操作BatchMigrate - operationId: server_PerformBatchMigrate - responses: - "200": - $ref: '#/responses/server_PerformBatchMigrateOutput' - summary: 执行操作BatchMigrate - tags: - - server - /servers/batch-set-user-metadata: - post: - description: 执行操作BatchSetUserMetadata - operationId: server_PerformBatchSetUserMetadata - responses: - "200": - $ref: '#/responses/server_PerformBatchSetUserMetadataOutput' - summary: 执行操作BatchSetUserMetadata - tags: - - server - /servers/batch-user-metadata: - post: - description: 执行操作BatchUserMetadata - operationId: server_PerformBatchUserMetadata - responses: - "200": - $ref: '#/responses/server_PerformBatchUserMetadataOutput' - summary: 执行操作BatchUserMetadata - tags: - - server - /servers/dirty-server-start: - post: - description: 执行操作DirtyServerStart - operationId: server_PerformDirtyServerStart - responses: - "200": - $ref: '#/responses/server_PerformDirtyServerStartOutput' - summary: 执行操作DirtyServerStart - tags: - - server - /servers/dirty-server-verify: - post: - description: 执行操作DirtyServerVerify - operationId: server_PerformDirtyServerVerify - responses: - "200": - $ref: '#/responses/server_PerformDirtyServerVerifyOutput' - summary: 执行操作DirtyServerVerify - tags: - - server - /servers/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: server_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/server_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - server - /servers/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: server_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/server_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - server - /servers/import: - post: - description: 执行操作Import - operationId: server_PerformImport - responses: - "200": - $ref: '#/responses/server_PerformImportOutput' - summary: 执行操作Import - tags: - - server - /servers/import-from-libvirt: - post: - description: 执行操作ImportFromLibvirt - operationId: server_PerformImportFromLibvirt - responses: - "200": - $ref: '#/responses/server_PerformImportFromLibvirtOutput' - summary: 执行操作ImportFromLibvirt - tags: - - server - /servers/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: server_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/server_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - server - /servers/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: server_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/server_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - server - /servers/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: server_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/server_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - server - /servers/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: server_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - server: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/server_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - server - /servers/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: server_GetPropertySplitable - responses: - "200": - $ref: '#/responses/server_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - server - /servers/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: server_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/server_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - server - /servers/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: server_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/server_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - server - /servers/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: server_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/server_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - server - /servers/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: server_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/server_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - server - /service_catalogs: - get: - description: 列表 - operationId: service_catalog_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: guest_template_id - type: string - x-go-name: GuestTemplateId - responses: - "200": - $ref: '#/responses/service_catalog_ListItemFilterOutput' - summary: 服务目录列表 - tags: - - service_catalog - post: - description: 新建 - operationId: service_catalog_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - service_catalog: - $ref: '#/definitions/ServiceCatalogCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_ValidateCreateDataOutput' - summary: 新建 - tags: - - service_catalog - /service_catalogs/{id}: - delete: - description: 删除 - operationId: service_catalog_CustomizeDelete - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/service_catalog_CustomizeDeleteOutput' - summary: 删除 - tags: - - service_catalog - get: - description: 获取详情 - operationId: service_catalog_FetchCustomizeColumns - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/service_catalog_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - service_catalog - put: - description: 更新 - operationId: service_catalog_ValidateUpdateData - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - $ref: '#/definitions/ServiceCatalogUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_ValidateUpdateDataOutput' - summary: 更新 - tags: - - service_catalog - /service_catalogs/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: service_catalog_PerformCancelDelete - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/service_catalog_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - service_catalog - /service_catalogs/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: service_catalog_PerformChangeOwner - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - service_catalog - /service_catalogs/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: service_catalog_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/service_catalog_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - service_catalog - /service_catalogs/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: service_catalog_GetDetailsClassMetadata - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/service_catalog_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - service_catalog - post: - description: 执行操作ClassMetadata - operationId: service_catalog_PerformClassMetadata - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - service_catalog - /service_catalogs/{id}/deploy: - post: - description: 执行操作Deploy - operationId: service_catalog_PerformDeploy - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - $ref: '#/definitions/ServiceCatalogDeploy' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformDeployOutput' - summary: 执行操作Deploy - tags: - - service_catalog - /service_catalogs/{id}/freeze: - post: - description: 执行操作Freeze - operationId: service_catalog_PerformFreeze - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - service_catalog - /service_catalogs/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: service_catalog_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_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/service_catalog_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - service_catalog - /service_catalogs/{id}/private: - post: - description: 执行操作Private - operationId: service_catalog_PerformPrivate - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformPrivateOutput' - summary: 执行操作Private - tags: - - service_catalog - /service_catalogs/{id}/public: - post: - description: 执行操作Public - operationId: service_catalog_PerformPublic - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformPublicOutput' - summary: 执行操作Public - tags: - - service_catalog - /service_catalogs/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: service_catalog_PerformSetClassMetadata - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - service_catalog - /service_catalogs/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: service_catalog_PerformSetUserMetadata - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - service_catalog - /service_catalogs/{id}/status: - get: - description: 获取指定信息Status - operationId: service_catalog_GetDetailsStatus - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/service_catalog_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - service_catalog - post: - description: 执行操作Status - operationId: service_catalog_PerformStatus - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformStatusOutput' - summary: 更新资源状态 - tags: - - service_catalog - /service_catalogs/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: service_catalog_PerformUnfreeze - parameters: - - description: The Id or Name of service_catalog - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - service_catalog: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - service_catalog - /service_catalogs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: service_catalog_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/service_catalog_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - service_catalog - /service_catalogs/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: service_catalog_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/service_catalog_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - service_catalog - /service_catalogs/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: service_catalog_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/service_catalog_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - service_catalog - /service_catalogs/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: service_catalog_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/service_catalog_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - service_catalog - /service_catalogs/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: service_catalog_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/service_catalog_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - service_catalog - /service_catalogs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: service_catalog_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - service_catalog: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/service_catalog_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - service_catalog - /service_catalogs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: service_catalog_GetPropertySplitable - responses: - "200": - $ref: '#/responses/service_catalog_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - service_catalog - /service_catalogs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: service_catalog_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_catalog_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - service_catalog - /service_catalogs/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: service_catalog_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/service_catalog_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - service_catalog - /service_catalogs/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: service_catalog_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/service_catalog_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - service_catalog - /service_catalogs/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: service_catalog_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/service_catalog_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - service_catalog - /snapshot_policies: - get: - description: 列表 - operationId: snapshot_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: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 按绑定的磁盘数量排序 - in: query - name: order_by_bind_disk_count - pattern: asc|desc - type: string - x-go-name: OrderByBindDiskCount - - description: 是否启用？ - in: query - name: is_activated - type: boolean - x-go-name: IsActivated - responses: - "200": - $ref: '#/responses/snapshot_policy_ListItemFilterOutput' - summary: 快照策略列表 - tags: - - snapshot_policy - post: - description: 新建 - operationId: snapshot_policy_ValidateCreateData - responses: - "200": - $ref: '#/responses/snapshot_policy_ValidateCreateDataOutput' - summary: 新建 - tags: - - snapshot_policy - /snapshot_policies/{id}: - delete: - description: 删除 - operationId: snapshot_policy_CustomizeDelete - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_CustomizeDeleteOutput' - summary: 删除 - tags: - - snapshot_policy - get: - description: 获取详情 - operationId: snapshot_policy_FetchCustomizeColumns - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - snapshot_policy - put: - description: 更新 - operationId: snapshot_policy_ValidateUpdateData - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_ValidateUpdateDataOutput' - summary: 更新 - tags: - - snapshot_policy - /snapshot_policies/{id}/bind-disks: - post: - description: 执行操作BindDisks - operationId: snapshot_policy_PerformBindDisks - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformBindDisksOutput' - summary: 执行操作BindDisks - tags: - - snapshot_policy - /snapshot_policies/{id}/cache: - post: - description: 执行操作Cache - operationId: snapshot_policy_PerformCache - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformCacheOutput' - summary: 执行操作Cache - tags: - - snapshot_policy - /snapshot_policies/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: snapshot_policy_PerformCancelDelete - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - snapshot_policy - /snapshot_policies/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: snapshot_policy_PerformChangeOwner - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - snapshot_policy - /snapshot_policies/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: snapshot_policy_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - snapshot_policy - /snapshot_policies/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: snapshot_policy_GetDetailsClassMetadata - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - snapshot_policy - post: - description: 执行操作ClassMetadata - operationId: snapshot_policy_PerformClassMetadata - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - snapshot_policy - /snapshot_policies/{id}/freeze: - post: - description: 执行操作Freeze - operationId: snapshot_policy_PerformFreeze - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - snapshot_policy - /snapshot_policies/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: snapshot_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 snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - snapshot_policy - /snapshot_policies/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: snapshot_policy_PerformSetClassMetadata - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - snapshot_policy - /snapshot_policies/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: snapshot_policy_PerformSetUserMetadata - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - snapshot_policy - /snapshot_policies/{id}/status: - get: - description: 获取指定信息Status - operationId: snapshot_policy_GetDetailsStatus - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - snapshot_policy - post: - description: 执行操作Status - operationId: snapshot_policy_PerformStatus - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformStatusOutput' - summary: 更新资源状态 - tags: - - snapshot_policy - /snapshot_policies/{id}/unbind-disks: - post: - description: 执行操作UnbindDisks - operationId: snapshot_policy_PerformUnbindDisks - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformUnbindDisksOutput' - summary: 执行操作UnbindDisks - tags: - - snapshot_policy - /snapshot_policies/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: snapshot_policy_PerformUnfreeze - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - snapshot_policy - /snapshot_policies/{id}/update: - post: - description: 执行操作Update - operationId: snapshot_policy_PerformUpdate - parameters: - - description: The Id or Name of snapshot_policy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformUpdateOutput' - summary: 执行操作Update - tags: - - snapshot_policy - /snapshot_policies/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: snapshot_policy_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/snapshot_policy_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - snapshot_policy - /snapshot_policies/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: snapshot_policy_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/snapshot_policy_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - snapshot_policy - /snapshot_policies/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: snapshot_policy_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/snapshot_policy_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - snapshot_policy - /snapshot_policies/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: snapshot_policy_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/snapshot_policy_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - snapshot_policy - /snapshot_policies/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: snapshot_policy_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/snapshot_policy_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - snapshot_policy - /snapshot_policies/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: snapshot_policy_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - snapshot_policy: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - snapshot_policy - /snapshot_policies/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: snapshot_policy_GetPropertySplitable - responses: - "200": - $ref: '#/responses/snapshot_policy_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - snapshot_policy - /snapshot_policies/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: snapshot_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/snapshot_policy_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - snapshot_policy - /snapshot_policies/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: snapshot_policy_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/snapshot_policy_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - snapshot_policy - /snapshot_policies/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: snapshot_policy_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/snapshot_policy_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - snapshot_policy - /snapshot_policies/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: snapshot_policy_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/snapshot_policy_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - snapshot_policy - /snapshot_policy_caches: - get: - description: 列表 - operationId: snapshot_policy_cache_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: filter disk by snapshotpolicy - in: query - name: snapshotpolicy_id - type: string - x-go-name: SnapshotpolicyId - - description: 以快照策略名称排序 - in: query - name: order_by_snapshotpolicy - type: string - x-go-name: OrderBySnapshotpolicy - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_ListItemFilterOutput' - summary: 快照策略缓存列表 - tags: - - snapshot_policy_cache - post: - description: 新建 - operationId: snapshot_policy_cache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - snapshot_policy_cache: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_ValidateCreateDataOutput' - summary: 新建 - tags: - - snapshot_policy_cache - /snapshot_policy_caches/{id}: - delete: - description: 删除 - operationId: snapshot_policy_cache_CustomizeDelete - parameters: - - description: The Id or Name of snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_CustomizeDeleteOutput' - summary: 删除 - tags: - - snapshot_policy_cache - get: - description: 获取详情 - operationId: snapshot_policy_cache_FetchCustomizeColumns - parameters: - - description: The Id or Name of snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - snapshot_policy_cache - put: - description: 更新 - operationId: snapshot_policy_cache_ValidateUpdateData - parameters: - - description: The Id or Name of snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy_cache: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - snapshot_policy_cache - /snapshot_policy_caches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: snapshot_policy_cache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - snapshot_policy_cache - post: - description: 执行操作ClassMetadata - operationId: snapshot_policy_cache_PerformClassMetadata - parameters: - - description: The Id or Name of snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - snapshot_policy_cache - /snapshot_policy_caches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: snapshot_policy_cache_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 snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - snapshot_policy_cache - /snapshot_policy_caches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: snapshot_policy_cache_PerformSetClassMetadata - parameters: - - description: The Id or Name of snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - snapshot_policy_cache - /snapshot_policy_caches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: snapshot_policy_cache_PerformSetUserMetadata - parameters: - - description: The Id or Name of snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - snapshot_policy_cache - /snapshot_policy_caches/{id}/status: - get: - description: 获取指定信息Status - operationId: snapshot_policy_cache_GetDetailsStatus - parameters: - - description: The Id or Name of snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - snapshot_policy_cache - post: - description: 执行操作Status - operationId: snapshot_policy_cache_PerformStatus - parameters: - - description: The Id or Name of snapshot_policy_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy_cache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - snapshot_policy_cache - /snapshot_policy_caches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: snapshot_policy_cache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - snapshot_policy_cache - /snapshot_policy_caches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: snapshot_policy_cache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - snapshot_policy_cache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - snapshot_policy_cache - /snapshot_policy_caches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: snapshot_policy_cache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - snapshot_policy_cache - /snapshot_policy_caches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: snapshot_policy_cache_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/snapshot_policy_cache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - snapshot_policy_cache - /snapshot_policy_caches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: snapshot_policy_cache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - snapshot_policy_cache - /snapshot_policy_caches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: snapshot_policy_cache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - snapshot_policy_cache - /snapshot_policy_caches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: snapshot_policy_cache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/snapshot_policy_cache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - snapshot_policy_cache - /snapshot_policy_disks: - get: - description: 列表 - operationId: snapshot_policy_disk_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: filter disk by snapshotpolicy - in: query - name: snapshotpolicy_id - type: string - x-go-name: SnapshotpolicyId - - description: 以快照策略名称排序 - in: query - name: order_by_snapshotpolicy - type: string - x-go-name: OrderBySnapshotpolicy - - description: 存储（ID或Name） - in: query - name: storage_id - type: string - x-go-name: StorageId - - description: 以存储名称排序 - in: query - name: order_by_storage - pattern: asc|desc - type: string - x-go-name: OrderByStorage - - description: filter shared storage - in: query - name: share - type: boolean - x-go-name: Share - - description: filter local storage - in: query - name: local - type: boolean - x-go-name: Local - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 虚拟磁盘（ID或Name） - in: query - name: disk_id - type: string - x-go-name: DiskId - - description: 以磁盘名称排序 - in: query - name: order_by_disk - pattern: asc|desc - type: string - x-go-name: OrderByDisk - - description: 状态 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - responses: - "200": - $ref: '#/responses/snapshot_policy_disk_ListItemFilterOutput' - summary: 列表 - tags: - - snapshot_policy_disk - post: - description: 新建 - operationId: snapshot_policy_disk_ValidateCreateData - responses: - "200": - $ref: '#/responses/snapshot_policy_disk_ValidateCreateDataOutput' - summary: 新建 - tags: - - snapshot_policy_disk - /snapshot_policy_disks/{id}: - delete: - description: 删除 - operationId: snapshot_policy_disk_CustomizeDelete - parameters: - - description: The Id or Name of snapshot_policy_disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_disk_CustomizeDeleteOutput' - summary: 删除 - tags: - - snapshot_policy_disk - get: - description: 获取详情 - operationId: snapshot_policy_disk_FetchCustomizeColumns - parameters: - - description: The Id or Name of snapshot_policy_disk - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_policy_disk_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - snapshot_policy_disk - put: - description: 更新 - operationId: snapshot_policy_disk_ValidateUpdateData - parameters: - - description: The Id or Name of snapshot_policy_disk - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot_policy_disk: - $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_disk_ValidateUpdateDataOutput' - summary: 更新 - tags: - - snapshot_policy_disk - /snapshot_policy_disks/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: snapshot_policy_disk_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/snapshot_policy_disk_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - snapshot_policy_disk - /snapshot_policy_disks/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: snapshot_policy_disk_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - snapshot_policy_disk: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_policy_disk_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - snapshot_policy_disk - /snapshot_policy_disks/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: snapshot_policy_disk_GetPropertySplitable - responses: - "200": - $ref: '#/responses/snapshot_policy_disk_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - snapshot_policy_disk - /snapshot_policy_disks/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: snapshot_policy_disk_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/snapshot_policy_disk_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - snapshot_policy_disk - /snapshots: - get: - description: 列表 - operationId: snapshot_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: |- - 通过操作系统架构过滤 - x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 - arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 - 其他的输入会过滤出以输入字符开头的资源 - enmu: x86, arm - in: query - name: os_arch - type: string - x-go-name: OsArch - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: filter shared storage - in: query - name: share - type: boolean - x-go-name: Share - - description: filter local storage - in: query - name: local - type: boolean - x-go-name: Local - - description: 虚拟磁盘（ID或Name） - in: query - name: disk_id - type: string - x-go-name: DiskId - - description: 以磁盘名称排序 - in: query - name: order_by_disk - pattern: asc|desc - type: string - x-go-name: OrderByDisk - - description: 存储（ID或Name） - in: query - name: storage_id - type: string - x-go-name: StorageId - - description: 以存储名称排序 - in: query - name: order_by_storage - pattern: asc|desc - type: string - x-go-name: OrderByStorage - - description: filter snapshot that is fake deleted - in: query - name: fake_deleted - type: boolean - x-go-name: FakeDeleted - - description: filter by disk type - in: query - name: disk_type - type: string - x-go-name: DiskType - - description: filter instance snapshot - in: query - name: is_instance_snapshot - type: boolean - x-go-name: IsInstanceSnapshot - - in: query - name: out_of_chain - type: boolean - x-go-name: OutOfChain - - in: query - items: - type: string - name: os_type - type: array - x-go-name: OsType - - description: list server snapshots - in: query - name: server_id - type: string - x-go-name: ServerId - - description: 按虚拟机名称排序 - in: query - name: order_by_guest - pattern: asc|desc - type: string - x-go-name: OrderByGuest - - description: 按磁盘名称排序 - in: query - name: order_by_disk_name - pattern: asc|desc - type: string - x-go-name: OrderByDiskName - responses: - "200": - $ref: '#/responses/snapshot_ListItemFilterOutput' - summary: 快照列表 - tags: - - snapshot - post: - description: 新建 - operationId: snapshot_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - snapshot: - $ref: '#/definitions/SnapshotCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_ValidateCreateDataOutput' - summary: 新建 - tags: - - snapshot - /snapshots/{id}: - delete: - description: 删除 - operationId: snapshot_CustomizeDelete - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_CustomizeDeleteOutput' - summary: 删除 - tags: - - snapshot - get: - description: 获取详情 - operationId: snapshot_FetchCustomizeColumns - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - snapshot - put: - description: 更新 - operationId: snapshot_ValidateUpdateData - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_ValidateUpdateDataOutput' - summary: 更新 - tags: - - snapshot - /snapshots/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: snapshot_PerformCancelDelete - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - snapshot - /snapshots/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: snapshot_PerformChangeOwner - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - snapshot - /snapshots/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: snapshot_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - snapshot - /snapshots/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: snapshot_GetDetailsClassMetadata - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - snapshot - post: - description: 执行操作ClassMetadata - operationId: snapshot_PerformClassMetadata - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - snapshot - /snapshots/{id}/deleted: - post: - description: 执行操作Deleted - operationId: snapshot_PerformDeleted - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_PerformDeletedOutput' - summary: 执行操作Deleted - tags: - - snapshot - /snapshots/{id}/freeze: - post: - description: 执行操作Freeze - operationId: snapshot_PerformFreeze - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - snapshot - /snapshots/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: snapshot_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 snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - snapshot - /snapshots/{id}/purge: - post: - description: 执行操作Purge - operationId: snapshot_PerformPurge - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - snapshot - /snapshots/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: snapshot_PerformSetClassMetadata - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - snapshot - /snapshots/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: snapshot_PerformSetUserMetadata - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - snapshot - /snapshots/{id}/status: - get: - description: 获取指定信息Status - operationId: snapshot_GetDetailsStatus - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/snapshot_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - snapshot - post: - description: 执行操作Status - operationId: snapshot_PerformStatus - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_PerformStatusOutput' - summary: 更新资源状态 - tags: - - snapshot - /snapshots/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: snapshot_PerformSyncstatus - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot: - $ref: '#/definitions/SnapshotSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_PerformSyncstatusOutput' - summary: 同步快照状态 - tags: - - snapshot - /snapshots/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: snapshot_PerformUnfreeze - parameters: - - description: The Id or Name of snapshot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - snapshot: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - snapshot - /snapshots/delete-disk-snapshots: - post: - description: 执行操作DeleteDiskSnapshots - operationId: snapshot_PerformDeleteDiskSnapshots - responses: - "200": - $ref: '#/responses/snapshot_PerformDeleteDiskSnapshotsOutput' - summary: 执行操作DeleteDiskSnapshots - tags: - - snapshot - /snapshots/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: snapshot_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/snapshot_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - snapshot - /snapshots/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: snapshot_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/snapshot_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - snapshot - /snapshots/max-count: - get: - description: 获取指定资源类的信息MaxCount - operationId: snapshot_GetPropertyMaxCount - responses: - "200": - $ref: '#/responses/snapshot_GetPropertyMaxCountOutput' - summary: 获取指定资源类的信息MaxCount - tags: - - snapshot - /snapshots/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: snapshot_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/snapshot_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - snapshot - /snapshots/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: snapshot_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/snapshot_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - snapshot - /snapshots/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: snapshot_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/snapshot_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - snapshot - /snapshots/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: snapshot_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - snapshot: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/snapshot_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - snapshot - /snapshots/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: snapshot_GetPropertySplitable - responses: - "200": - $ref: '#/responses/snapshot_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - snapshot - /snapshots/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: snapshot_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/snapshot_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - snapshot - /snapshots/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: snapshot_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/snapshot_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - snapshot - /snapshots/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: snapshot_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/snapshot_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - snapshot - /snapshots/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: snapshot_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/snapshot_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - snapshot - /storagecachedimages: - get: - description: 列表 - operationId: storagecachedimage_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 存储缓存（ID或Name） - in: query - name: storagecache_id - type: string - x-go-name: StoragecacheId - - description: 以存储缓存名称排序 - in: query - name: order_by_storagecache - pattern: asc|desc - type: string - x-go-name: OrderByStoragecache - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 以镜像缓存过滤 - in: query - name: cachedimage_id - type: string - x-go-name: CachedimageId - - description: 镜像状态 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - responses: - "200": - $ref: '#/responses/storagecachedimage_ListItemFilterOutput' - summary: 列表 - tags: - - storagecachedimage - post: - description: 新建 - operationId: storagecachedimage_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - storagecachedimage: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecachedimage_ValidateCreateDataOutput' - summary: 新建 - tags: - - storagecachedimage - /storagecachedimages/{id}: - delete: - description: 删除 - operationId: storagecachedimage_CustomizeDelete - parameters: - - description: The Id or Name of storagecachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storagecachedimage_CustomizeDeleteOutput' - summary: 删除 - tags: - - storagecachedimage - get: - description: 获取详情 - operationId: storagecachedimage_FetchCustomizeColumns - parameters: - - description: The Id or Name of storagecachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storagecachedimage_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - storagecachedimage - put: - description: 更新 - operationId: storagecachedimage_ValidateUpdateData - parameters: - - description: The Id or Name of storagecachedimage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storagecachedimage: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecachedimage_ValidateUpdateDataOutput' - summary: 更新 - tags: - - storagecachedimage - /storagecachedimages/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: storagecachedimage_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/storagecachedimage_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - storagecachedimage - /storagecachedimages/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: storagecachedimage_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - storagecachedimage: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecachedimage_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - storagecachedimage - /storagecachedimages/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: storagecachedimage_GetPropertySplitable - responses: - "200": - $ref: '#/responses/storagecachedimage_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - storagecachedimage - /storagecachedimages/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: storagecachedimage_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/storagecachedimage_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - storagecachedimage - /storagecaches: - get: - description: 列表 - operationId: storagecache_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 路径过滤 - in: query - items: - type: string - name: path - type: array - x-go-name: Path - responses: - "200": - $ref: '#/responses/storagecache_ListItemFilterOutput' - summary: 镜像缓存存储列表 - tags: - - storagecache - post: - description: 新建 - operationId: storagecache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - storagecache: - $ref: '#/definitions/StandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecache_ValidateCreateDataOutput' - summary: 新建 - tags: - - storagecache - /storagecaches/{id}: - delete: - description: 删除 - operationId: storagecache_CustomizeDelete - parameters: - - description: The Id or Name of storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storagecache_CustomizeDeleteOutput' - summary: 删除 - tags: - - storagecache - get: - description: 获取详情 - operationId: storagecache_FetchCustomizeColumns - parameters: - - description: The Id or Name of storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storagecache_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - storagecache - put: - description: 更新 - operationId: storagecache_ValidateUpdateData - parameters: - - description: The Id or Name of storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storagecache: - $ref: '#/definitions/StandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - storagecache - /storagecaches/{id}/cache-image: - post: - description: 执行操作CacheImage - operationId: storagecache_PerformCacheImage - parameters: - - description: The Id or Name of storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storagecache: - $ref: '#/definitions/CacheImageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecache_PerformCacheImageOutput' - summary: 执行操作CacheImage - tags: - - storagecache - /storagecaches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: storagecache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storagecache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - storagecache - post: - description: 执行操作ClassMetadata - operationId: storagecache_PerformClassMetadata - parameters: - - description: The Id or Name of storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storagecache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - storagecache - /storagecaches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: storagecache_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 storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storagecache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - storagecache - /storagecaches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: storagecache_PerformSetClassMetadata - parameters: - - description: The Id or Name of storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storagecache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - storagecache - /storagecaches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: storagecache_PerformSetUserMetadata - parameters: - - description: The Id or Name of storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storagecache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - storagecache - /storagecaches/{id}/uncache-image: - post: - description: 执行操作UncacheImage - operationId: storagecache_PerformUncacheImage - parameters: - - description: The Id or Name of storagecache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storagecache_PerformUncacheImageOutput' - summary: 执行操作UncacheImage - tags: - - storagecache - /storagecaches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: storagecache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/storagecache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - storagecache - /storagecaches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: storagecache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - storagecache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storagecache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - storagecache - /storagecaches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: storagecache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/storagecache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - storagecache - /storagecaches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: storagecache_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/storagecache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - storagecache - /storagecaches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: storagecache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/storagecache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - storagecache - /storagecaches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: storagecache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/storagecache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - storagecache - /storages: - get: - description: 列表 - operationId: storage_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 以关联的调度标签（ID或Name）过滤列表 - in: query - name: schedtag_id - type: string - x-go-name: SchedtagId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: filter shared storage - in: query - name: share - type: boolean - x-go-name: Share - - description: filter local storage - in: query - name: local - type: boolean - x-go-name: Local - - description: filter by host schedtag - in: query - name: host_schedtag_id - type: string - x-go-name: HostSchedtagId - - description: filter by cachedimage - in: query - name: image_id - type: string - x-go-name: ImageId - - description: filter storages which attached the specified host - in: query - name: host_id - type: string - x-go-name: HostId - - description: filter storages which server can change disks to - in: query - name: server_id - type: string - x-go-name: ServerId - - description: filter storages of baremetal host - in: query - name: is_baremetal - type: boolean - x-go-name: IsBaremetal - responses: - "200": - $ref: '#/responses/storage_ListItemFilterOutput' - summary: 块存储列表 - tags: - - storage - post: - description: 新建 - operationId: storage_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - storage: - $ref: '#/definitions/StorageCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_ValidateCreateDataOutput' - summary: 新建 - tags: - - storage - /storages/{id}: - delete: - description: 删除 - operationId: storage_CustomizeDelete - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_CustomizeDeleteOutput' - summary: 删除 - tags: - - storage - get: - description: 获取详情 - operationId: storage_FetchCustomizeColumns - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - storage - put: - description: 更新 - operationId: storage_ValidateUpdateData - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - $ref: '#/definitions/StorageUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_ValidateUpdateDataOutput' - summary: 更新 - tags: - - storage - /storages/{id}/cache-image: - post: - description: 执行操作CacheImage - operationId: storage_PerformCacheImage - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - $ref: '#/definitions/CacheImageInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformCacheImageOutput' - summary: 执行操作CacheImage - tags: - - storage - /storages/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: storage_PerformChangeOwner - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - storage - /storages/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: storage_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - storage - /storages/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: storage_GetDetailsClassMetadata - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - storage - post: - description: 执行操作ClassMetadata - operationId: storage_PerformClassMetadata - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - storage - /storages/{id}/disable: - post: - description: 执行操作Disable - operationId: storage_PerformDisable - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_PerformDisableOutput' - summary: 执行操作Disable - tags: - - storage - /storages/{id}/enable: - post: - description: 执行操作Enable - operationId: storage_PerformEnable - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_PerformEnableOutput' - summary: 执行操作Enable - tags: - - storage - /storages/{id}/force-detach-host: - post: - description: 执行操作ForceDetachHost - operationId: storage_PerformForceDetachHost - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - $ref: '#/definitions/StorageForceDetachHostInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformForceDetachHostOutput' - summary: 执行操作ForceDetachHost - tags: - - storage - /storages/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: storage_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 storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - storage - /storages/{id}/offline: - post: - description: 执行操作Offline - operationId: storage_PerformOffline - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_PerformOfflineOutput' - summary: 执行操作Offline - tags: - - storage - /storages/{id}/online: - post: - description: 执行操作Online - operationId: storage_PerformOnline - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_PerformOnlineOutput' - summary: 执行操作Online - tags: - - storage - /storages/{id}/private: - post: - description: 执行操作Private - operationId: storage_PerformPrivate - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformPrivateOutput' - summary: 执行操作Private - tags: - - storage - /storages/{id}/public: - post: - description: 执行操作Public - operationId: storage_PerformPublic - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformPublicOutput' - summary: 执行操作Public - tags: - - storage - /storages/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: storage_PerformSetClassMetadata - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - storage - /storages/{id}/set-schedtag: - post: - description: 执行操作SetSchedtag - operationId: storage_PerformSetSchedtag - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_PerformSetSchedtagOutput' - summary: 执行操作SetSchedtag - tags: - - storage - /storages/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: storage_PerformSetUserMetadata - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - storage - /storages/{id}/status: - get: - description: 获取指定信息Status - operationId: storage_GetDetailsStatus - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - storage - post: - description: 执行操作Status - operationId: storage_PerformStatus - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - storage: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformStatusOutput' - summary: 更新资源状态 - tags: - - storage - /storages/{id}/uncache-image: - post: - description: 执行操作UncacheImage - operationId: storage_PerformUncacheImage - parameters: - - description: The Id or Name of storage - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/storage_PerformUncacheImageOutput' - summary: 执行操作UncacheImage - tags: - - storage - /storages/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: storage_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/storage_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - storage - /storages/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: storage_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/storage_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - storage - /storages/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: storage_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/storage_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - storage - /storages/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: storage_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - storage: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/storage_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - storage - /storages/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: storage_GetPropertySplitable - responses: - "200": - $ref: '#/responses/storage_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - storage - /storages/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: storage_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/storage_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - storage - /storages/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: storage_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/storage_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - storage - /storages/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: storage_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/storage_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - storage - /storages/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: storage_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/storage_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - storage - /tablestores: - get: - description: 列表 - operationId: tablestore_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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - responses: - "200": - $ref: '#/responses/tablestore_ListItemFilterOutput' - summary: Tablestore列表 - tags: - - tablestore - post: - description: 新建 - operationId: tablestore_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - tablestore: - $ref: '#/definitions/TablestoreCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_ValidateCreateDataOutput' - summary: 新建 - tags: - - tablestore - /tablestores/{id}: - delete: - description: 删除 - operationId: tablestore_CustomizeDelete - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/tablestore_CustomizeDeleteOutput' - summary: 删除 - tags: - - tablestore - get: - description: 获取详情 - operationId: tablestore_FetchCustomizeColumns - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/tablestore_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - tablestore - put: - description: 更新 - operationId: tablestore_ValidateUpdateData - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - tablestore: - $ref: '#/definitions/TablestoreUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_ValidateUpdateDataOutput' - summary: 更新 - tags: - - tablestore - /tablestores/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: tablestore_PerformCancelDelete - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/tablestore_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - tablestore - /tablestores/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: tablestore_PerformChangeOwner - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - tablestore: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - tablestore - /tablestores/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: tablestore_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/tablestore_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - tablestore - /tablestores/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: tablestore_GetDetailsClassMetadata - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/tablestore_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - tablestore - post: - description: 执行操作ClassMetadata - operationId: tablestore_PerformClassMetadata - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - tablestore: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - tablestore - /tablestores/{id}/freeze: - post: - description: 执行操作Freeze - operationId: tablestore_PerformFreeze - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - tablestore: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - tablestore - /tablestores/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: tablestore_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 tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/tablestore_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - tablestore - /tablestores/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: tablestore_PerformSetClassMetadata - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - tablestore: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - tablestore - /tablestores/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: tablestore_PerformSetUserMetadata - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - tablestore: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - tablestore - /tablestores/{id}/status: - get: - description: 获取指定信息Status - operationId: tablestore_GetDetailsStatus - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/tablestore_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - tablestore - post: - description: 执行操作Status - operationId: tablestore_PerformStatus - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - tablestore: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_PerformStatusOutput' - summary: 更新资源状态 - tags: - - tablestore - /tablestores/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: tablestore_PerformUnfreeze - parameters: - - description: The Id or Name of tablestore - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - tablestore: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - tablestore - /tablestores/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: tablestore_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/tablestore_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - tablestore - /tablestores/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: tablestore_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/tablestore_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - tablestore - /tablestores/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: tablestore_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/tablestore_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - tablestore - /tablestores/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: tablestore_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/tablestore_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - tablestore - /tablestores/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: tablestore_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/tablestore_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - tablestore - /tablestores/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: tablestore_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - tablestore: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/tablestore_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - tablestore - /tablestores/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: tablestore_GetPropertySplitable - responses: - "200": - $ref: '#/responses/tablestore_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - tablestore - /tablestores/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: tablestore_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/tablestore_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - tablestore - /tablestores/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: tablestore_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/tablestore_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - tablestore - /tablestores/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: tablestore_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/tablestore_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - tablestore - /tablestores/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: tablestore_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/tablestore_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - tablestore - /vpc_peering_connections: - get: - description: 列表 - operationId: vpc_peering_connection_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - in: query - name: PeerVpcId - type: string - responses: - "200": - $ref: '#/responses/vpc_peering_connection_ListItemFilterOutput' - summary: 列表 - tags: - - vpc_peering_connection - post: - description: 新建 - operationId: vpc_peering_connection_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - vpc_peering_connection: - $ref: '#/definitions/VpcPeeringConnectionCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_ValidateCreateDataOutput' - summary: 创建 - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}: - delete: - description: 删除 - operationId: vpc_peering_connection_CustomizeDelete - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_peering_connection_CustomizeDeleteOutput' - summary: 删除 - tags: - - vpc_peering_connection - get: - description: 获取详情 - operationId: vpc_peering_connection_FetchCustomizeColumns - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_peering_connection_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - vpc_peering_connection - put: - description: 更新 - operationId: vpc_peering_connection_ValidateUpdateData - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/VpcPeeringConnectionUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_ValidateUpdateDataOutput' - summary: 更新 - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: vpc_peering_connection_PerformChangeOwner - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: vpc_peering_connection_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: vpc_peering_connection_GetDetailsClassMetadata - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - vpc_peering_connection - post: - description: 执行操作ClassMetadata - operationId: vpc_peering_connection_PerformClassMetadata - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/disable: - post: - description: 执行操作Disable - operationId: vpc_peering_connection_PerformDisable - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformDisableOutput' - summary: 禁用资源 - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/enable: - post: - description: 执行操作Enable - operationId: vpc_peering_connection_PerformEnable - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformEnableOutput' - summary: 启用资源 - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: vpc_peering_connection_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 vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/private: - post: - description: 执行操作Private - operationId: vpc_peering_connection_PerformPrivate - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformPrivateOutput' - summary: 执行操作Private - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/public: - post: - description: 执行操作Public - operationId: vpc_peering_connection_PerformPublic - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformPublicOutput' - summary: 执行操作Public - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: vpc_peering_connection_PerformSetClassMetadata - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: vpc_peering_connection_PerformSetUserMetadata - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/status: - get: - description: 获取指定信息Status - operationId: vpc_peering_connection_GetDetailsStatus - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - vpc_peering_connection - post: - description: 执行操作Status - operationId: vpc_peering_connection_PerformStatus - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformStatusOutput' - summary: 更新资源状态 - tags: - - vpc_peering_connection - /vpc_peering_connections/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: vpc_peering_connection_PerformSyncstatus - parameters: - - description: The Id or Name of vpc_peering_connection - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/VpcSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformSyncstatusOutput' - summary: 同步状态 - tags: - - vpc_peering_connection - /vpc_peering_connections/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: vpc_peering_connection_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - vpc_peering_connection - /vpc_peering_connections/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: vpc_peering_connection_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - vpc_peering_connection - /vpc_peering_connections/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: vpc_peering_connection_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - vpc_peering_connection - /vpc_peering_connections/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: vpc_peering_connection_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_peering_connection_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - vpc_peering_connection - /vpc_peering_connections/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: vpc_peering_connection_GetPropertySplitable - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - vpc_peering_connection - /vpc_peering_connections/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: vpc_peering_connection_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/vpc_peering_connection_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - vpc_peering_connection - /vpc_peering_connections/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: vpc_peering_connection_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - vpc_peering_connection - /vpc_peering_connections/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: vpc_peering_connection_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - vpc_peering_connection - /vpc_peering_connections/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: vpc_peering_connection_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/vpc_peering_connection_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - vpc_peering_connection - /vpcs: - get: - description: 列表 - operationId: vpc_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: GlobalVpc ID or Name - in: query - name: globalvpc_id - type: string - x-go-name: GlobalvpcId - - description: 以GlobalVpc的名称排序 - in: query - name: order_by_globalvpc - pattern: asc|desc - type: string - x-go-name: OrderByGlobalvpc - - in: query - name: dns_zone_id - type: string - x-go-name: DnsZoneId - - in: query - name: inter_vpc_network_id - type: string - x-go-name: InterVpcNetworkId - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: filter by Vpc usability of the resource - in: query - name: usable_vpc - type: boolean - x-go-name: UsableVpc - - description: 过滤可以加入指定vpc互联的vpc - in: query - name: usable_for_inter_vpc_network_id - type: string - x-go-name: UsableForInterVpcNetworkId - - description: 过滤vpc底下有指定zone的ip子网 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: filter by globalvpc - in: query - name: globalvpc - type: string - x-go-name: Globalvpc - - description: 是否是默认VPC - example: true - in: query - name: is_default - type: boolean - x-go-name: IsDefault - - description: CIDR地址段 - example: 192.168.222.0/24 - in: query - items: - type: string - name: cidr_block - type: array - x-go-name: CidrBlock - - description: 'enmu: eip, none' - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按子网数量排序 - in: query - name: order_by_network_count - pattern: asc|desc - type: string - x-go-name: OrderByNetworkCount - - description: 按二层网络数量排序 - in: query - name: OrderByWireCount - pattern: asc|desc - type: string - responses: - "200": - $ref: '#/responses/vpc_ListItemFilterOutput' - summary: 列出VPC - tags: - - vpc - post: - description: 新建 - operationId: vpc_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - vpc: - $ref: '#/definitions/VpcCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_ValidateCreateDataOutput' - summary: 新建 - tags: - - vpc - /vpcs/{id}: - delete: - description: 删除 - operationId: vpc_CustomizeDelete - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_CustomizeDeleteOutput' - summary: 删除 - tags: - - vpc - get: - description: 获取详情 - operationId: vpc_FetchCustomizeColumns - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - vpc - put: - description: 更新 - operationId: vpc_ValidateUpdateData - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/VpcUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_ValidateUpdateDataOutput' - summary: 更新 - tags: - - vpc - /vpcs/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: vpc_PerformChangeOwner - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - vpc - /vpcs/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: vpc_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - vpc - /vpcs/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: vpc_GetDetailsClassMetadata - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - vpc - post: - description: 执行操作ClassMetadata - operationId: vpc_PerformClassMetadata - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - vpc - /vpcs/{id}/disable: - post: - description: 执行操作Disable - operationId: vpc_PerformDisable - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformDisableOutput' - summary: 禁用资源 - tags: - - vpc - /vpcs/{id}/enable: - post: - description: 执行操作Enable - operationId: vpc_PerformEnable - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformEnableOutput' - summary: 启用资源 - tags: - - vpc - /vpcs/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: vpc_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 vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - vpc - /vpcs/{id}/private: - post: - description: 执行操作Private - operationId: vpc_PerformPrivate - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformPrivateOutput' - summary: 执行操作Private - tags: - - vpc - /vpcs/{id}/public: - post: - description: 执行操作Public - operationId: vpc_PerformPublic - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformPublicOutput' - summary: 执行操作Public - tags: - - vpc - /vpcs/{id}/purge: - post: - description: 执行操作Purge - operationId: vpc_PerformPurge - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_PerformPurgeOutput' - summary: 执行操作Purge - tags: - - vpc - /vpcs/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: vpc_PerformSetClassMetadata - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - vpc - /vpcs/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: vpc_PerformSetUserMetadata - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - vpc - /vpcs/{id}/status: - get: - description: 获取指定信息Status - operationId: vpc_GetDetailsStatus - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - vpc - post: - description: 执行操作Status - operationId: vpc_PerformStatus - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformStatusOutput' - summary: 更新资源状态 - tags: - - vpc - /vpcs/{id}/sync: - post: - description: 执行操作Sync - operationId: vpc_PerformSync - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/VpcSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformSyncOutput' - summary: 执行操作Sync - tags: - - vpc - /vpcs/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: vpc_PerformSyncstatus - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/VpcSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformSyncstatusOutput' - summary: 同步VPC状态 - tags: - - vpc - /vpcs/{id}/topology: - get: - description: 获取指定信息Topology - operationId: vpc_GetDetailsTopology - parameters: - - description: The Id or Name of vpc - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/vpc_GetDetailsTopologyOutput' - summary: 获取指定信息Topology - tags: - - vpc - /vpcs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: vpc_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/vpc_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - vpc - /vpcs/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: vpc_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/vpc_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - vpc - /vpcs/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: vpc_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/vpc_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - vpc - /vpcs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: vpc_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - vpc: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/vpc_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - vpc - /vpcs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: vpc_GetPropertySplitable - responses: - "200": - $ref: '#/responses/vpc_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - vpc - /vpcs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: vpc_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/vpc_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - vpc - /vpcs/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: vpc_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/vpc_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - vpc - /vpcs/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: vpc_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/vpc_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - vpc - /vpcs/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: vpc_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/vpc_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - vpc - /waf_instances: - get: - description: 列表 - operationId: waf_instance_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - responses: - "200": - $ref: '#/responses/waf_instance_ListItemFilterOutput' - summary: 列出WAF实例 - tags: - - waf_instance - post: - description: 新建 - operationId: waf_instance_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - waf_instance: - $ref: '#/definitions/WafInstanceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_ValidateCreateDataOutput' - summary: 新建 - tags: - - waf_instance - /waf_instances/{id}: - delete: - description: 删除 - operationId: waf_instance_CustomizeDelete - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_instance_CustomizeDeleteOutput' - summary: 删除 - tags: - - waf_instance - get: - description: 获取详情 - operationId: waf_instance_FetchCustomizeColumns - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_instance_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - waf_instance - put: - description: 更新 - operationId: waf_instance_ValidateUpdateData - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_ValidateUpdateDataOutput' - summary: 更新 - tags: - - waf_instance - /waf_instances/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: waf_instance_PerformChangeOwner - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - waf_instance - /waf_instances/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: waf_instance_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_instance_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - waf_instance - /waf_instances/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: waf_instance_GetDetailsClassMetadata - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_instance_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - waf_instance - post: - description: 执行操作ClassMetadata - operationId: waf_instance_PerformClassMetadata - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - waf_instance - /waf_instances/{id}/cloud-resources: - get: - description: 获取指定信息CloudResources - operationId: waf_instance_GetDetailsCloudResources - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_instance_GetDetailsCloudResourcesOutput' - summary: 获取WAF绑定的资源列表 - tags: - - waf_instance - /waf_instances/{id}/disable: - post: - description: 执行操作Disable - operationId: waf_instance_PerformDisable - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformDisableOutput' - summary: 禁用资源 - tags: - - waf_instance - /waf_instances/{id}/enable: - post: - description: 执行操作Enable - operationId: waf_instance_PerformEnable - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformEnableOutput' - summary: 启用资源 - tags: - - waf_instance - /waf_instances/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: waf_instance_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 waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_instance_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - waf_instance - /waf_instances/{id}/private: - post: - description: 执行操作Private - operationId: waf_instance_PerformPrivate - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformPrivateOutput' - summary: 执行操作Private - tags: - - waf_instance - /waf_instances/{id}/public: - post: - description: 执行操作Public - operationId: waf_instance_PerformPublic - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformPublicOutput' - summary: 执行操作Public - tags: - - waf_instance - /waf_instances/{id}/remote-update: - post: - description: 执行操作RemoteUpdate - operationId: waf_instance_PerformRemoteUpdate - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/MongoDBRemoteUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformRemoteUpdateOutput' - summary: 执行操作RemoteUpdate - tags: - - waf_instance - /waf_instances/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: waf_instance_PerformSetClassMetadata - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - waf_instance - /waf_instances/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: waf_instance_PerformSetUserMetadata - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - waf_instance - /waf_instances/{id}/status: - get: - description: 获取指定信息Status - operationId: waf_instance_GetDetailsStatus - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_instance_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - waf_instance - post: - description: 执行操作Status - operationId: waf_instance_PerformStatus - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformStatusOutput' - summary: 更新资源状态 - tags: - - waf_instance - /waf_instances/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: waf_instance_PerformSyncstatus - parameters: - - description: The Id or Name of waf_instance - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/WafSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformSyncstatusOutput' - summary: 同步WAF状态 - tags: - - waf_instance - /waf_instances/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: waf_instance_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/waf_instance_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - waf_instance - /waf_instances/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: waf_instance_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/waf_instance_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - waf_instance - /waf_instances/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: waf_instance_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/waf_instance_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - waf_instance - /waf_instances/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: waf_instance_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - waf_instance: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_instance_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - waf_instance - /waf_instances/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: waf_instance_GetPropertySplitable - responses: - "200": - $ref: '#/responses/waf_instance_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - waf_instance - /waf_instances/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: waf_instance_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/waf_instance_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - waf_instance - /waf_instances/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: waf_instance_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/waf_instance_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - waf_instance - /waf_instances/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: waf_instance_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/waf_instance_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - waf_instance - /waf_instances/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: waf_instance_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/waf_instance_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - waf_instance - /waf_ip_set_caches: - get: - description: 列表 - operationId: waf_ip_set_cache_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_ListItemFilterOutput' - summary: 列出WAF IPSet缓存 - tags: - - waf_ip_set_cache - post: - description: 新建 - operationId: waf_ip_set_cache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - waf_ip_set_cache: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_ValidateCreateDataOutput' - summary: 新建 - tags: - - waf_ip_set_cache - /waf_ip_set_caches/{id}: - delete: - description: 删除 - operationId: waf_ip_set_cache_CustomizeDelete - parameters: - - description: The Id or Name of waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_CustomizeDeleteOutput' - summary: 删除 - tags: - - waf_ip_set_cache - get: - description: 获取详情 - operationId: waf_ip_set_cache_FetchCustomizeColumns - parameters: - - description: The Id or Name of waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - waf_ip_set_cache - put: - description: 更新 - operationId: waf_ip_set_cache_ValidateUpdateData - parameters: - - description: The Id or Name of waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set_cache: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - waf_ip_set_cache - /waf_ip_set_caches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: waf_ip_set_cache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - waf_ip_set_cache - post: - description: 执行操作ClassMetadata - operationId: waf_ip_set_cache_PerformClassMetadata - parameters: - - description: The Id or Name of waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - waf_ip_set_cache - /waf_ip_set_caches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: waf_ip_set_cache_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 waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - waf_ip_set_cache - /waf_ip_set_caches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: waf_ip_set_cache_PerformSetClassMetadata - parameters: - - description: The Id or Name of waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - waf_ip_set_cache - /waf_ip_set_caches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: waf_ip_set_cache_PerformSetUserMetadata - parameters: - - description: The Id or Name of waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - waf_ip_set_cache - /waf_ip_set_caches/{id}/status: - get: - description: 获取指定信息Status - operationId: waf_ip_set_cache_GetDetailsStatus - parameters: - - description: The Id or Name of waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - waf_ip_set_cache - post: - description: 执行操作Status - operationId: waf_ip_set_cache_PerformStatus - parameters: - - description: The Id or Name of waf_ip_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set_cache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - waf_ip_set_cache - /waf_ip_set_caches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: waf_ip_set_cache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - waf_ip_set_cache - /waf_ip_set_caches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: waf_ip_set_cache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - waf_ip_set_cache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - waf_ip_set_cache - /waf_ip_set_caches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: waf_ip_set_cache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - waf_ip_set_cache - /waf_ip_set_caches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: waf_ip_set_cache_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/waf_ip_set_cache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - waf_ip_set_cache - /waf_ip_set_caches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: waf_ip_set_cache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - waf_ip_set_cache - /waf_ip_set_caches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: waf_ip_set_cache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - waf_ip_set_cache - /waf_ip_set_caches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: waf_ip_set_cache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/waf_ip_set_cache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - waf_ip_set_cache - /waf_ip_sets: - get: - description: 列表 - operationId: waf_ip_set_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - responses: - "200": - $ref: '#/responses/waf_ip_set_ListItemFilterOutput' - summary: 列出WAF IPSets - tags: - - waf_ip_set - post: - description: 新建 - operationId: waf_ip_set_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - waf_ip_set: - $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_ValidateCreateDataOutput' - summary: 新建 - tags: - - waf_ip_set - /waf_ip_sets/{id}: - delete: - description: 删除 - operationId: waf_ip_set_CustomizeDelete - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_CustomizeDeleteOutput' - summary: 删除 - tags: - - waf_ip_set - get: - description: 获取详情 - operationId: waf_ip_set_FetchCustomizeColumns - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - waf_ip_set - put: - description: 更新 - operationId: waf_ip_set_ValidateUpdateData - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_ValidateUpdateDataOutput' - summary: 更新 - tags: - - waf_ip_set - /waf_ip_sets/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: waf_ip_set_PerformChangeOwner - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - waf_ip_set - /waf_ip_sets/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: waf_ip_set_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - waf_ip_set - /waf_ip_sets/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: waf_ip_set_GetDetailsClassMetadata - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - waf_ip_set - post: - description: 执行操作ClassMetadata - operationId: waf_ip_set_PerformClassMetadata - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - waf_ip_set - /waf_ip_sets/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: waf_ip_set_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 waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - waf_ip_set - /waf_ip_sets/{id}/private: - post: - description: 执行操作Private - operationId: waf_ip_set_PerformPrivate - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_PerformPrivateOutput' - summary: 执行操作Private - tags: - - waf_ip_set - /waf_ip_sets/{id}/public: - post: - description: 执行操作Public - operationId: waf_ip_set_PerformPublic - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_PerformPublicOutput' - summary: 执行操作Public - tags: - - waf_ip_set - /waf_ip_sets/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: waf_ip_set_PerformSetClassMetadata - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - waf_ip_set - /waf_ip_sets/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: waf_ip_set_PerformSetUserMetadata - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - waf_ip_set - /waf_ip_sets/{id}/status: - get: - description: 获取指定信息Status - operationId: waf_ip_set_GetDetailsStatus - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_ip_set_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - waf_ip_set - post: - description: 执行操作Status - operationId: waf_ip_set_PerformStatus - parameters: - - description: The Id or Name of waf_ip_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_ip_set: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_PerformStatusOutput' - summary: 更新资源状态 - tags: - - waf_ip_set - /waf_ip_sets/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: waf_ip_set_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/waf_ip_set_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - waf_ip_set - /waf_ip_sets/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: waf_ip_set_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/waf_ip_set_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - waf_ip_set - /waf_ip_sets/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: waf_ip_set_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/waf_ip_set_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - waf_ip_set - /waf_ip_sets/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: waf_ip_set_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - waf_ip_set: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_ip_set_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - waf_ip_set - /waf_ip_sets/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: waf_ip_set_GetPropertySplitable - responses: - "200": - $ref: '#/responses/waf_ip_set_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - waf_ip_set - /waf_ip_sets/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: waf_ip_set_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/waf_ip_set_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - waf_ip_set - /waf_ip_sets/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: waf_ip_set_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/waf_ip_set_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - waf_ip_set - /waf_ip_sets/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: waf_ip_set_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/waf_ip_set_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - waf_ip_set - /waf_ip_sets/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: waf_ip_set_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/waf_ip_set_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - waf_ip_set - /waf_regex_set_caches: - get: - description: 列表 - operationId: waf_regex_set_cache_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_ListItemFilterOutput' - summary: 列出WAF RegexSet缓存 - tags: - - waf_regex_set_cache - post: - description: 新建 - operationId: waf_regex_set_cache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - waf_regex_set_cache: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_ValidateCreateDataOutput' - summary: 新建 - tags: - - waf_regex_set_cache - /waf_regex_set_caches/{id}: - delete: - description: 删除 - operationId: waf_regex_set_cache_CustomizeDelete - parameters: - - description: The Id or Name of waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_CustomizeDeleteOutput' - summary: 删除 - tags: - - waf_regex_set_cache - get: - description: 获取详情 - operationId: waf_regex_set_cache_FetchCustomizeColumns - parameters: - - description: The Id or Name of waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - waf_regex_set_cache - put: - description: 更新 - operationId: waf_regex_set_cache_ValidateUpdateData - parameters: - - description: The Id or Name of waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set_cache: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - waf_regex_set_cache - /waf_regex_set_caches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: waf_regex_set_cache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - waf_regex_set_cache - post: - description: 执行操作ClassMetadata - operationId: waf_regex_set_cache_PerformClassMetadata - parameters: - - description: The Id or Name of waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - waf_regex_set_cache - /waf_regex_set_caches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: waf_regex_set_cache_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 waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - waf_regex_set_cache - /waf_regex_set_caches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: waf_regex_set_cache_PerformSetClassMetadata - parameters: - - description: The Id or Name of waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - waf_regex_set_cache - /waf_regex_set_caches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: waf_regex_set_cache_PerformSetUserMetadata - parameters: - - description: The Id or Name of waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - waf_regex_set_cache - /waf_regex_set_caches/{id}/status: - get: - description: 获取指定信息Status - operationId: waf_regex_set_cache_GetDetailsStatus - parameters: - - description: The Id or Name of waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - waf_regex_set_cache - post: - description: 执行操作Status - operationId: waf_regex_set_cache_PerformStatus - parameters: - - description: The Id or Name of waf_regex_set_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set_cache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - waf_regex_set_cache - /waf_regex_set_caches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: waf_regex_set_cache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - waf_regex_set_cache - /waf_regex_set_caches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: waf_regex_set_cache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - waf_regex_set_cache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - waf_regex_set_cache - /waf_regex_set_caches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: waf_regex_set_cache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - waf_regex_set_cache - /waf_regex_set_caches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: waf_regex_set_cache_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/waf_regex_set_cache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - waf_regex_set_cache - /waf_regex_set_caches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: waf_regex_set_cache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - waf_regex_set_cache - /waf_regex_set_caches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: waf_regex_set_cache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - waf_regex_set_cache - /waf_regex_set_caches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: waf_regex_set_cache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/waf_regex_set_cache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - waf_regex_set_cache - /waf_regex_sets: - get: - description: 列表 - operationId: waf_regex_set_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： - - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - responses: - "200": - $ref: '#/responses/waf_regex_set_ListItemFilterOutput' - summary: 列出WAF RegexSets - tags: - - waf_regex_set - post: - description: 新建 - operationId: waf_regex_set_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - waf_regex_set: - $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_ValidateCreateDataOutput' - summary: 新建 - tags: - - waf_regex_set - /waf_regex_sets/{id}: - delete: - description: 删除 - operationId: waf_regex_set_CustomizeDelete - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_CustomizeDeleteOutput' - summary: 删除 - tags: - - waf_regex_set - get: - description: 获取详情 - operationId: waf_regex_set_FetchCustomizeColumns - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - waf_regex_set - put: - description: 更新 - operationId: waf_regex_set_ValidateUpdateData - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_ValidateUpdateDataOutput' - summary: 更新 - tags: - - waf_regex_set - /waf_regex_sets/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: waf_regex_set_PerformChangeOwner - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - waf_regex_set - /waf_regex_sets/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: waf_regex_set_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - waf_regex_set - /waf_regex_sets/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: waf_regex_set_GetDetailsClassMetadata - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - waf_regex_set - post: - description: 执行操作ClassMetadata - operationId: waf_regex_set_PerformClassMetadata - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - waf_regex_set - /waf_regex_sets/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: waf_regex_set_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 waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - waf_regex_set - /waf_regex_sets/{id}/private: - post: - description: 执行操作Private - operationId: waf_regex_set_PerformPrivate - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_PerformPrivateOutput' - summary: 执行操作Private - tags: - - waf_regex_set - /waf_regex_sets/{id}/public: - post: - description: 执行操作Public - operationId: waf_regex_set_PerformPublic - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_PerformPublicOutput' - summary: 执行操作Public - tags: - - waf_regex_set - /waf_regex_sets/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: waf_regex_set_PerformSetClassMetadata - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - waf_regex_set - /waf_regex_sets/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: waf_regex_set_PerformSetUserMetadata - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - waf_regex_set - /waf_regex_sets/{id}/status: - get: - description: 获取指定信息Status - operationId: waf_regex_set_GetDetailsStatus - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_regex_set_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - waf_regex_set - post: - description: 执行操作Status - operationId: waf_regex_set_PerformStatus - parameters: - - description: The Id or Name of waf_regex_set - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_regex_set: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_PerformStatusOutput' - summary: 更新资源状态 - tags: - - waf_regex_set - /waf_regex_sets/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: waf_regex_set_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/waf_regex_set_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - waf_regex_set - /waf_regex_sets/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: waf_regex_set_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/waf_regex_set_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - waf_regex_set - /waf_regex_sets/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: waf_regex_set_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/waf_regex_set_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - waf_regex_set - /waf_regex_sets/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: waf_regex_set_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - waf_regex_set: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_regex_set_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - waf_regex_set - /waf_regex_sets/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: waf_regex_set_GetPropertySplitable - responses: - "200": - $ref: '#/responses/waf_regex_set_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - waf_regex_set - /waf_regex_sets/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: waf_regex_set_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/waf_regex_set_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - waf_regex_set - /waf_regex_sets/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: waf_regex_set_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/waf_regex_set_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - waf_regex_set - /waf_regex_sets/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: waf_regex_set_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/waf_regex_set_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - waf_regex_set - /waf_regex_sets/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: waf_regex_set_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/waf_regex_set_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - waf_regex_set - /waf_rule_group_caches: - get: - description: 列表 - operationId: waf_rule_group_cache_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_ListItemFilterOutput' - summary: 列出WAF RuleGroup缓存 - tags: - - waf_rule_group_cache - post: - description: 新建 - operationId: waf_rule_group_cache_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - waf_rule_group_cache: - $ref: '#/definitions/StatusStandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_ValidateCreateDataOutput' - summary: 新建 - tags: - - waf_rule_group_cache - /waf_rule_group_caches/{id}: - delete: - description: 删除 - operationId: waf_rule_group_cache_CustomizeDelete - parameters: - - description: The Id or Name of waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_CustomizeDeleteOutput' - summary: 删除 - tags: - - waf_rule_group_cache - get: - description: 获取详情 - operationId: waf_rule_group_cache_FetchCustomizeColumns - parameters: - - description: The Id or Name of waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - waf_rule_group_cache - put: - description: 更新 - operationId: waf_rule_group_cache_ValidateUpdateData - parameters: - - description: The Id or Name of waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group_cache: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_ValidateUpdateDataOutput' - summary: 更新 - tags: - - waf_rule_group_cache - /waf_rule_group_caches/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: waf_rule_group_cache_GetDetailsClassMetadata - parameters: - - description: The Id or Name of waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - waf_rule_group_cache - post: - description: 执行操作ClassMetadata - operationId: waf_rule_group_cache_PerformClassMetadata - parameters: - - description: The Id or Name of waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - waf_rule_group_cache - /waf_rule_group_caches/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: waf_rule_group_cache_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 waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - waf_rule_group_cache - /waf_rule_group_caches/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: waf_rule_group_cache_PerformSetClassMetadata - parameters: - - description: The Id or Name of waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - waf_rule_group_cache - /waf_rule_group_caches/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: waf_rule_group_cache_PerformSetUserMetadata - parameters: - - description: The Id or Name of waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - waf_rule_group_cache - /waf_rule_group_caches/{id}/status: - get: - description: 获取指定信息Status - operationId: waf_rule_group_cache_GetDetailsStatus - parameters: - - description: The Id or Name of waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - waf_rule_group_cache - post: - description: 执行操作Status - operationId: waf_rule_group_cache_PerformStatus - parameters: - - description: The Id or Name of waf_rule_group_cache - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group_cache: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_PerformStatusOutput' - summary: 更新资源状态 - tags: - - waf_rule_group_cache - /waf_rule_group_caches/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: waf_rule_group_cache_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - waf_rule_group_cache - /waf_rule_group_caches/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: waf_rule_group_cache_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - waf_rule_group_cache: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - waf_rule_group_cache - /waf_rule_group_caches/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: waf_rule_group_cache_GetPropertySplitable - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - waf_rule_group_cache - /waf_rule_group_caches/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: waf_rule_group_cache_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/waf_rule_group_cache_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - waf_rule_group_cache - /waf_rule_group_caches/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: waf_rule_group_cache_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - waf_rule_group_cache - /waf_rule_group_caches/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: waf_rule_group_cache_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - waf_rule_group_cache - /waf_rule_group_caches/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: waf_rule_group_cache_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/waf_rule_group_cache_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - waf_rule_group_cache - /waf_rule_groups: - get: - description: 列表 - operationId: waf_rule_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 - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 是否是系统RuleGroup - in: query - name: is_system - type: boolean - x-go-name: IsSystem - - description: 云平台 - in: query - name: provider - type: string - x-go-name: Provider - - description: 云环境 - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - responses: - "200": - $ref: '#/responses/waf_rule_group_ListItemFilterOutput' - summary: 列出WAF RuleGroups - tags: - - waf_rule_group - post: - description: 新建 - operationId: waf_rule_group_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - waf_rule_group: - $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_ValidateCreateDataOutput' - summary: 新建 - tags: - - waf_rule_group - /waf_rule_groups/{id}: - delete: - description: 删除 - operationId: waf_rule_group_CustomizeDelete - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_CustomizeDeleteOutput' - summary: 删除 - tags: - - waf_rule_group - get: - description: 获取详情 - operationId: waf_rule_group_FetchCustomizeColumns - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - waf_rule_group - put: - description: 更新 - operationId: waf_rule_group_ValidateUpdateData - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group: - $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_ValidateUpdateDataOutput' - summary: 更新 - tags: - - waf_rule_group - /waf_rule_groups/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: waf_rule_group_PerformChangeOwner - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - waf_rule_group - /waf_rule_groups/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: waf_rule_group_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - waf_rule_group - /waf_rule_groups/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: waf_rule_group_GetDetailsClassMetadata - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - waf_rule_group - post: - description: 执行操作ClassMetadata - operationId: waf_rule_group_PerformClassMetadata - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - waf_rule_group - /waf_rule_groups/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: waf_rule_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 waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - waf_rule_group - /waf_rule_groups/{id}/private: - post: - description: 执行操作Private - operationId: waf_rule_group_PerformPrivate - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_PerformPrivateOutput' - summary: 执行操作Private - tags: - - waf_rule_group - /waf_rule_groups/{id}/public: - post: - description: 执行操作Public - operationId: waf_rule_group_PerformPublic - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_PerformPublicOutput' - summary: 执行操作Public - tags: - - waf_rule_group - /waf_rule_groups/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: waf_rule_group_PerformSetClassMetadata - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - waf_rule_group - /waf_rule_groups/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: waf_rule_group_PerformSetUserMetadata - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - waf_rule_group - /waf_rule_groups/{id}/status: - get: - description: 获取指定信息Status - operationId: waf_rule_group_GetDetailsStatus - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_group_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - waf_rule_group - post: - description: 执行操作Status - operationId: waf_rule_group_PerformStatus - parameters: - - description: The Id or Name of waf_rule_group - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_group: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_PerformStatusOutput' - summary: 更新资源状态 - tags: - - waf_rule_group - /waf_rule_groups/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: waf_rule_group_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/waf_rule_group_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - waf_rule_group - /waf_rule_groups/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: waf_rule_group_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/waf_rule_group_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - waf_rule_group - /waf_rule_groups/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: waf_rule_group_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/waf_rule_group_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - waf_rule_group - /waf_rule_groups/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: waf_rule_group_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - waf_rule_group: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_group_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - waf_rule_group - /waf_rule_groups/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: waf_rule_group_GetPropertySplitable - responses: - "200": - $ref: '#/responses/waf_rule_group_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - waf_rule_group - /waf_rule_groups/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: waf_rule_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/waf_rule_group_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - waf_rule_group - /waf_rule_groups/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: waf_rule_group_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/waf_rule_group_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - waf_rule_group - /waf_rule_groups/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: waf_rule_group_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/waf_rule_group_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - waf_rule_group - /waf_rule_groups/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: waf_rule_group_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/waf_rule_group_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - waf_rule_group - /waf_rule_statements: - get: - description: 列表 - operationId: waf_rule_statement_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/waf_rule_statement_ListItemFilterOutput' - summary: 列表 - tags: - - waf_rule_statement - post: - description: 新建 - operationId: waf_rule_statement_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - waf_rule_statement: - $ref: '#/definitions/ResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_statement_ValidateCreateDataOutput' - summary: 新建 - tags: - - waf_rule_statement - /waf_rule_statements/{id}: - delete: - description: 删除 - operationId: waf_rule_statement_CustomizeDelete - parameters: - - description: The Id or Name of waf_rule_statement - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_statement_CustomizeDeleteOutput' - summary: 删除 - tags: - - waf_rule_statement - get: - description: 获取详情 - operationId: waf_rule_statement_FetchCustomizeColumns - parameters: - - description: The Id or Name of waf_rule_statement - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_statement_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - waf_rule_statement - put: - description: 更新 - operationId: waf_rule_statement_ValidateUpdateData - parameters: - - description: The Id or Name of waf_rule_statement - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule_statement: - $ref: '#/definitions/ResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_statement_ValidateUpdateDataOutput' - summary: 更新 - tags: - - waf_rule_statement - /waf_rule_statements/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: waf_rule_statement_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/waf_rule_statement_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - waf_rule_statement - /waf_rule_statements/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: waf_rule_statement_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - waf_rule_statement: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_statement_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - waf_rule_statement - /waf_rule_statements/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: waf_rule_statement_GetPropertySplitable - responses: - "200": - $ref: '#/responses/waf_rule_statement_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - waf_rule_statement - /waf_rule_statements/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: waf_rule_statement_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/waf_rule_statement_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - waf_rule_statement - /waf_rules: - get: - description: 列表 - operationId: waf_rule_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: WAF实例Id - in: query - name: waf_instance_id - type: string - x-go-name: WafInstanceId - - description: WAF规则组Id - in: query - name: waf_rule_group_id - type: string - x-go-name: WafRuleGroupId - responses: - "200": - $ref: '#/responses/waf_rule_ListItemFilterOutput' - summary: 列出WAF规则 - tags: - - waf_rule - post: - description: 新建 - operationId: waf_rule_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - waf_rule: - $ref: '#/definitions/WafRuleCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_ValidateCreateDataOutput' - summary: 新建 - tags: - - waf_rule - /waf_rules/{id}: - delete: - description: 删除 - operationId: waf_rule_CustomizeDelete - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_CustomizeDeleteOutput' - summary: 删除 - tags: - - waf_rule - get: - description: 获取详情 - operationId: waf_rule_FetchCustomizeColumns - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - waf_rule - put: - description: 更新 - operationId: waf_rule_ValidateUpdateData - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule: - $ref: '#/definitions/WafRuleUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_ValidateUpdateDataOutput' - summary: 更新 - tags: - - waf_rule - /waf_rules/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: waf_rule_GetDetailsClassMetadata - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - waf_rule - post: - description: 执行操作ClassMetadata - operationId: waf_rule_PerformClassMetadata - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - waf_rule - /waf_rules/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: waf_rule_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 waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - waf_rule - /waf_rules/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: waf_rule_PerformSetClassMetadata - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - waf_rule - /waf_rules/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: waf_rule_PerformSetUserMetadata - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - waf_rule - /waf_rules/{id}/status: - get: - description: 获取指定信息Status - operationId: waf_rule_GetDetailsStatus - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/waf_rule_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - waf_rule - post: - description: 执行操作Status - operationId: waf_rule_PerformStatus - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_PerformStatusOutput' - summary: 更新资源状态 - tags: - - waf_rule - /waf_rules/{id}/syncstatus: - post: - description: 执行操作Syncstatus - operationId: waf_rule_PerformSyncstatus - parameters: - - description: The Id or Name of waf_rule - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - waf_rule: - $ref: '#/definitions/WafSyncstatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_PerformSyncstatusOutput' - summary: 同步WAF规则状态 - tags: - - waf_rule - /waf_rules/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: waf_rule_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/waf_rule_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - waf_rule - /waf_rules/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: waf_rule_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - waf_rule: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/waf_rule_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - waf_rule - /waf_rules/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: waf_rule_GetPropertySplitable - responses: - "200": - $ref: '#/responses/waf_rule_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - waf_rule - /waf_rules/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: waf_rule_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/waf_rule_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - waf_rule - /waf_rules/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: waf_rule_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/waf_rule_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - waf_rule - /waf_rules/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: waf_rule_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/waf_rule_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - waf_rule - /waf_rules/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: waf_rule_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/waf_rule_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - waf_rule - /wires: - get: - description: 列表 - operationId: wire_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: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - description: 关联VPC(ID或Name) - in: query - name: vpc_id - type: string - x-go-name: VpcId - - description: Vpc外网访问模式 - in: query - name: external_access_mode - type: string - x-go-name: ExternalAccessMode - - description: 按VPC名称排序 - in: query - name: order_by_vpc - pattern: asc|desc - type: string - x-go-name: OrderByVpc - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 可用区ID或名称 - example: zone1 - in: query - name: zone_id - type: string - x-go-name: ZoneId - - description: 过滤处于多个指定可用区内的资源 - in: query - items: - type: string - name: zone_ids - type: array - x-go-name: ZoneIds - - description: 按可用区名称排序 - in: query - name: order_by_zone - pattern: asc|desc - type: string - x-go-name: OrderByZone - - description: 宿主机或物理机（ID或Name） - in: query - name: host_id - type: string - x-go-name: HostId - - format: int64 - in: query - name: bandwidth - type: integer - x-go-name: Bandwidth - - in: query - name: host_type - type: string - x-go-name: HostType - - description: 按子网数量排序 - in: query - name: order_by_network_count - pattern: asc|desc - type: string - x-go-name: OrderByNetworkCount - responses: - "200": - $ref: '#/responses/wire_ListItemFilterOutput' - summary: 二层网络列表 - tags: - - wire - post: - description: 新建 - operationId: wire_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - wire: - $ref: '#/definitions/WireCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_ValidateCreateDataOutput' - summary: 新建 - tags: - - wire - /wires/{id}: - delete: - description: 删除 - operationId: wire_CustomizeDelete - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/wire_CustomizeDeleteOutput' - summary: 删除 - tags: - - wire - get: - description: 获取详情 - operationId: wire_FetchCustomizeColumns - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/wire_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - wire - put: - description: 更新 - operationId: wire_ValidateUpdateData - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - $ref: '#/definitions/WireUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_ValidateUpdateDataOutput' - summary: 更新 - tags: - - wire - /wires/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: wire_PerformChangeOwner - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - wire - /wires/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: wire_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/wire_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - wire - /wires/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: wire_GetDetailsClassMetadata - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/wire_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - wire - post: - description: 执行操作ClassMetadata - operationId: wire_PerformClassMetadata - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - wire - /wires/{id}/merge-from: - post: - description: 执行操作MergeFrom - operationId: wire_PerformMergeFrom - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - $ref: '#/definitions/WireMergeFromInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformMergeFromOutput' - summary: 执行操作MergeFrom - tags: - - wire - /wires/{id}/merge-network: - post: - description: 执行操作MergeNetwork - operationId: wire_PerformMergeNetwork - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - $ref: '#/definitions/WireMergeNetworkInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformMergeNetworkOutput' - summary: 执行操作MergeNetwork - tags: - - wire - /wires/{id}/merge-to: - post: - description: 执行操作MergeTo - operationId: wire_PerformMergeTo - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - $ref: '#/definitions/WireMergeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformMergeToOutput' - summary: 执行操作MergeTo - tags: - - wire - /wires/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: wire_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 wire - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/wire_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - wire - /wires/{id}/private: - post: - description: 执行操作Private - operationId: wire_PerformPrivate - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformPrivateOutput' - summary: 执行操作Private - tags: - - wire - /wires/{id}/public: - post: - description: 执行操作Public - operationId: wire_PerformPublic - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformPublicOutput' - summary: 执行操作Public - tags: - - wire - /wires/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: wire_PerformSetClassMetadata - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformSetClassMetadataOutput' - summary: 执行操作SetClassMetadata - tags: - - wire - /wires/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: wire_PerformSetUserMetadata - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - wire - /wires/{id}/status: - get: - description: 获取指定信息Status - operationId: wire_GetDetailsStatus - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/wire_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - wire - post: - description: 执行操作Status - operationId: wire_PerformStatus - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - wire: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformStatusOutput' - summary: 更新资源状态 - tags: - - wire - /wires/{id}/topology: - get: - description: 获取指定信息Topology - operationId: wire_GetDetailsTopology - parameters: - - description: The Id or Name of wire - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/wire_GetDetailsTopologyOutput' - summary: 获取指定信息Topology - tags: - - wire - /wires/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: wire_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/wire_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - wire - /wires/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: wire_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/wire_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - wire - /wires/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: wire_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/wire_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - wire - /wires/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: wire_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - wire: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/wire_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - wire - /wires/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: wire_GetPropertySplitable - responses: - "200": - $ref: '#/responses/wire_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - wire - /wires/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: wire_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/wire_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - wire - /wires/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: wire_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/wire_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - wire - /wires/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: wire_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/wire_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - wire - /wires/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: wire_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/wire_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - wire - /zone_quotas/{scope}: - get: - description: 获取所有项目或者域的可用区配额 - operationId: models_ListZoneQuotas - 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/models_ListZoneQuotasOutput' - summary: 获取所有项目或者域的可用区配额 - tags: - - zone_quota - /zone_quotas/{scope}/{scopeId}: - get: - description: 获取指定项目或者域的可用区配额 - operationId: models_GetZoneQuota - 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: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - - description: 指定项目或者域的ID - in: path - name: scopeId - required: true - type: string - x-go-name: ScopeId - responses: - "200": - $ref: '#/responses/models_GetZoneQuotaOutput' - summary: 获取指定项目或者域的可用区配额 - tags: - - zone_quota - post: - description: 设置指定项目或者域的可用区配额 - operationId: models_SetZoneQuotas - parameters: - - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - - description: 指定项目或者域的ID - in: path - name: scopeId - required: true - type: string - x-go-name: ScopeId - - in: body - name: body - schema: - properties: - zone_quotas: - $ref: '#/definitions/SetZoneQuotaInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/models_SetZoneQuotasOutput' - summary: 设置指定项目或者域的可用区配额 - tags: - - zone_quota - /zones: - get: - description: 列表 - operationId: zone_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: 以资源外部ID过滤 - in: query - name: external_id - type: string - x-go-name: ExternalId - - 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: |- - 列出指定云平台的资源，支持的云平台如下 - - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： - - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - description: 区域名称或ID - in: query - name: cloudregion_id - type: string - x-go-name: CloudregionId - - description: 过滤位于指定城市区域的资源 - in: query - name: city - type: string - x-go-name: City - - description: 按区域名称过滤 - in: query - name: order_by_region - type: string - x-go-name: OrderByRegion - - description: 按城市过滤 - in: query - name: order_by_city - type: string - x-go-name: OrderByCity - - description: filter by network usability of the resource - in: query - name: usable - type: boolean - x-go-name: Usable - - description: filter by Vpc usability of the resource - in: query - name: usable_vpc - type: boolean - x-go-name: UsableVpc - - description: 过滤提供特定服务的可用区 - in: query - name: service - type: string - x-go-name: Service - - in: query - items: - type: string - name: location - type: array - x-go-name: Location - - in: query - items: - type: string - name: contacts - type: array - x-go-name: Contacts - - in: query - name: OrderByWires - type: string - - in: query - name: OrderByHosts - type: string - - in: query - name: OrderByHostsEnabled - type: string - - in: query - name: OrderByBaremetals - type: string - - in: query - name: OrderByBaremetalsEnabled - type: string - responses: - "200": - $ref: '#/responses/zone_ListItemFilterOutput' - summary: 可用区列表 - tags: - - zone - post: - description: 新建 - operationId: zone_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - zone: - $ref: '#/definitions/ZoneCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/zone_ValidateCreateDataOutput' - summary: 新建 - tags: - - zone - /zones/{id}: - delete: - description: 删除 - operationId: zone_CustomizeDelete - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/zone_CustomizeDeleteOutput' - summary: 删除 - tags: - - zone - get: - description: 获取详情 - operationId: zone_FetchCustomizeColumns - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/zone_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - zone - put: - description: 更新 - operationId: zone_ValidateUpdateData - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - zone: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/zone_ValidateUpdateDataOutput' - summary: 更新 - tags: - - zone - /zones/{id}/capability: - get: - description: 获取指定信息Capability - operationId: zone_GetDetailsCapability - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/zone_GetDetailsCapabilityOutput' - summary: 获取指定信息Capability - tags: - - zone - /zones/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: zone_GetDetailsClassMetadata - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/zone_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - zone - post: - description: 执行操作ClassMetadata - operationId: zone_PerformClassMetadata - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - zone: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/zone_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - zone - /zones/{id}/disk-capability: - get: - description: 获取指定信息DiskCapability - operationId: zone_GetDetailsDiskCapability - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/zone_GetDetailsDiskCapabilityOutput' - summary: 获取指定信息DiskCapability - tags: - - zone - /zones/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: zone_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 zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/zone_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - zone - /zones/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: zone_PerformSetClassMetadata - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - zone: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/zone_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - zone - /zones/{id}/set-schedtag: - post: - description: 执行操作SetSchedtag - operationId: zone_PerformSetSchedtag - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/zone_PerformSetSchedtagOutput' - summary: 执行操作SetSchedtag - tags: - - zone - /zones/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: zone_PerformSetUserMetadata - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - zone: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/zone_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - zone - /zones/{id}/status: - get: - description: 获取指定信息Status - operationId: zone_GetDetailsStatus - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/zone_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - zone - post: - description: 执行操作Status - operationId: zone_PerformStatus - parameters: - - description: The Id or Name of zone - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - zone: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/zone_PerformStatusOutput' - summary: 更新资源状态 - tags: - - zone - /zones/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: zone_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/zone_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - zone - /zones/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: zone_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - zone: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/zone_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - zone - /zones/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: zone_GetPropertySplitable - responses: - "200": - $ref: '#/responses/zone_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - zone - /zones/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: zone_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/zone_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - zone - /zones/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: zone_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/zone_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - zone - /zones/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: zone_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/zone_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - zone - /zones/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: zone_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/zone_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - zone + /access_group_rules: + get: + description: 列表 + operationId: access_group_rule_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 权限组Id + in: query + name: access_group_id + type: string + x-go-name: AccessGroupId + - description: 以权限组排序 + in: query + name: order_by_access_group + type: string + x-go-name: OrderByAccessGroup + responses: + "200": + $ref: '#/responses/access_group_rule_ListItemFilterOutput' + summary: 权限组规则列表 + tags: + - access_group_rule + post: + description: 新建 + operationId: access_group_rule_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_ValidateCreateDataOutput' + summary: 创建权限组规则 + tags: + - access_group_rule + /access_group_rules/{id}: + delete: + description: 删除 + operationId: access_group_rule_CustomizeDelete + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_rule_CustomizeDeleteOutput' + summary: 删除 + tags: + - access_group_rule + get: + description: 获取详情 + operationId: access_group_rule_FetchCustomizeColumns + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_rule_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - access_group_rule + put: + description: 更新 + operationId: access_group_rule_ValidateUpdateData + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_ValidateUpdateDataOutput' + summary: 更新 + tags: + - access_group_rule + /access_group_rules/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: access_group_rule_GetDetailsClassMetadata + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_rule_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - access_group_rule + post: + description: 执行操作ClassMetadata + operationId: access_group_rule_PerformClassMetadata + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - access_group_rule + /access_group_rules/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: access_group_rule_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 access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_rule_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - access_group_rule + /access_group_rules/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: access_group_rule_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_rule_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - access_group_rule + /access_group_rules/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: access_group_rule_PerformSetClassMetadata + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - access_group_rule + /access_group_rules/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: access_group_rule_PerformSetOrgMetadata + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - access_group_rule + /access_group_rules/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: access_group_rule_PerformSetUserMetadata + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - access_group_rule + /access_group_rules/{id}/status: + get: + description: 获取指定信息Status + operationId: access_group_rule_GetDetailsStatus + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_rule_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - access_group_rule + /access_group_rules/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: access_group_rule_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/access_group_rule_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - access_group_rule + /access_group_rules/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: access_group_rule_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + access_group_rule: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - access_group_rule + /access_group_rules/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: access_group_rule_GetPropertySplitable + responses: + "200": + $ref: '#/responses/access_group_rule_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - access_group_rule + /access_group_rules/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: access_group_rule_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/access_group_rule_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - access_group_rule + /access_group_rules/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: access_group_rule_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/access_group_rule_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - access_group_rule + /access_group_rules/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: access_group_rule_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/access_group_rule_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - access_group_rule + /access_groups: + get: + description: 列表 + operationId: access_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: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/access_group_ListItemFilterOutput' + summary: 列表 + tags: + - access_group + post: + description: 新建 + operationId: access_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - access_group + /access_groups/{id}: + delete: + description: 删除 + operationId: access_group_CustomizeDelete + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - access_group + get: + description: 获取详情 + operationId: access_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - access_group + put: + description: 更新 + operationId: access_group_ValidateUpdateData + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - access_group + /access_groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: access_group_PerformChangeOwner + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - access_group + /access_groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: access_group_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - access_group + /access_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: access_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - access_group + post: + description: 执行操作ClassMetadata + operationId: access_group_PerformClassMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - access_group + /access_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: access_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 access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - access_group + /access_groups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: access_group_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - access_group + /access_groups/{id}/private: + post: + description: 执行操作Private + operationId: access_group_PerformPrivate + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformPrivateOutput' + summary: 执行操作Private + tags: + - access_group + /access_groups/{id}/public: + post: + description: 执行操作Public + operationId: access_group_PerformPublic + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformPublicOutput' + summary: 执行操作Public + tags: + - access_group + /access_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: access_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - access_group + /access_groups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: access_group_PerformSetOrgMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - access_group + /access_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: access_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - access_group + /access_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: access_group_GetDetailsStatus + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - access_group + post: + description: 执行操作Status + operationId: access_group_PerformStatus + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - access_group + /access_groups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: access_group_PerformSyncstatus + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/MountTargetSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformSyncstatusOutput' + summary: 同步权限组状态 + tags: + - access_group + /access_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: access_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/access_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - access_group + /access_groups/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: access_group_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/access_group_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - access_group + /access_groups/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: access_group_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/access_group_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - access_group + /access_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: access_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - access_group + /access_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: access_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/access_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - access_group + /access_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: access_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/access_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - access_group + /access_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: access_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/access_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - access_group + /access_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: access_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/access_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - access_group + /access_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: access_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/access_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - access_group + /app_environments: + get: + description: 列表 + operationId: app_environment_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - in: query + name: AppId + type: string + - in: query + name: InstanceType + type: string + responses: + "200": + $ref: '#/responses/app_environment_ListItemFilterOutput' + summary: 列表 + tags: + - app_environment + post: + description: 新建 + operationId: app_environment_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/VirtualResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_ValidateCreateDataOutput' + summary: 新建 + tags: + - app_environment + /app_environments/{id}: + delete: + description: 删除 + operationId: app_environment_CustomizeDelete + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_CustomizeDeleteOutput' + summary: 删除 + tags: + - app_environment + get: + description: 获取详情 + operationId: app_environment_FetchCustomizeColumns + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - app_environment + put: + description: 更新 + operationId: app_environment_ValidateUpdateData + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_ValidateUpdateDataOutput' + summary: 更新 + tags: + - app_environment + /app_environments/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: app_environment_PerformCancelDelete + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - app_environment + /app_environments/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: app_environment_PerformChangeOwner + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - app_environment + /app_environments/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: app_environment_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - app_environment + /app_environments/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: app_environment_GetDetailsClassMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - app_environment + post: + description: 执行操作ClassMetadata + operationId: app_environment_PerformClassMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - app_environment + /app_environments/{id}/freeze: + post: + description: 执行操作Freeze + operationId: app_environment_PerformFreeze + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - app_environment + /app_environments/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: app_environment_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 app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - app_environment + /app_environments/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: app_environment_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - app_environment + /app_environments/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: app_environment_PerformSetClassMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - app_environment + /app_environments/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: app_environment_PerformSetOrgMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - app_environment + /app_environments/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: app_environment_PerformSetUserMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - app_environment + /app_environments/{id}/status: + get: + description: 获取指定信息Status + operationId: app_environment_GetDetailsStatus + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - app_environment + post: + description: 执行操作Status + operationId: app_environment_PerformStatus + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformStatusOutput' + summary: 更新资源状态 + tags: + - app_environment + /app_environments/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: app_environment_PerformUnfreeze + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - app_environment + /app_environments/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: app_environment_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - app_environment + /app_environments/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: app_environment_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - app_environment + /app_environments/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: app_environment_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - app_environment + /app_environments/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: app_environment_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - app_environment + /app_environments/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: app_environment_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - app_environment + /app_environments/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: app_environment_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - app_environment + /app_environments/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: app_environment_GetPropertySplitable + responses: + "200": + $ref: '#/responses/app_environment_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - app_environment + /app_environments/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: app_environment_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/app_environment_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - app_environment + /app_environments/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: app_environment_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - app_environment + /app_environments/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: app_environment_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - app_environment + /app_environments/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: app_environment_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - app_environment + /apps: + get: + description: 列表 + operationId: app_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - in: query + name: tech_stack + type: string + x-go-name: TechStack + responses: + "200": + $ref: '#/responses/app_ListItemFilterOutput' + summary: 列表 + tags: + - app + post: + description: 新建 + operationId: app_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/VirtualResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_ValidateCreateDataOutput' + summary: 新建 + tags: + - app + /apps/{id}: + delete: + description: 删除 + operationId: app_CustomizeDelete + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_CustomizeDeleteOutput' + summary: 删除 + tags: + - app + get: + description: 获取详情 + operationId: app_FetchCustomizeColumns + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - app + put: + description: 更新 + operationId: app_ValidateUpdateData + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_ValidateUpdateDataOutput' + summary: 更新 + tags: + - app + /apps/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: app_PerformCancelDelete + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - app + /apps/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: app_PerformChangeOwner + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - app + /apps/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: app_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - app + /apps/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: app_GetDetailsClassMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - app + post: + description: 执行操作ClassMetadata + operationId: app_PerformClassMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - app + /apps/{id}/freeze: + post: + description: 执行操作Freeze + operationId: app_PerformFreeze + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - app + /apps/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: app_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 app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - app + /apps/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: app_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - app + /apps/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: app_PerformRemoteUpdate + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - app + /apps/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: app_PerformSetClassMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - app + /apps/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: app_PerformSetOrgMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - app + /apps/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: app_PerformSetUserMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - app + /apps/{id}/status: + get: + description: 获取指定信息Status + operationId: app_GetDetailsStatus + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - app + post: + description: 执行操作Status + operationId: app_PerformStatus + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformStatusOutput' + summary: 更新资源状态 + tags: + - app + /apps/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: app_PerformSyncstatus + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - app + /apps/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: app_PerformUnfreeze + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - app + /apps/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: app_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/app_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - app + /apps/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: app_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/app_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - app + /apps/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: app_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/app_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - app + /apps/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: app_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/app_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - app + /apps/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: app_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/app_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - app + /apps/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: app_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - app + /apps/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: app_GetPropertySplitable + responses: + "200": + $ref: '#/responses/app_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - app + /apps/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: app_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/app_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - app + /apps/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: app_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/app_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - app + /apps/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: app_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/app_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - app + /apps/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: app_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/app_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - app + /backup_storages: + get: + description: 列表 + operationId: backup_storage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: filter by server_id + in: query + name: server_id + type: string + x-go-name: ServerId + - description: filter by disk_id + in: query + name: disk_id + type: string + x-go-name: DiskId + responses: + "200": + $ref: '#/responses/backup_storage_ListItemFilterOutput' + summary: 列表 + tags: + - backup_storage + post: + description: 新建 + operationId: backup_storage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_ValidateCreateDataOutput' + summary: 新建 + tags: + - backup_storage + /backup_storages/{id}: + delete: + description: 删除 + operationId: backup_storage_CustomizeDelete + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_CustomizeDeleteOutput' + summary: 删除 + tags: + - backup_storage + get: + description: 获取详情 + operationId: backup_storage_FetchCustomizeColumns + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - backup_storage + put: + description: 更新 + operationId: backup_storage_ValidateUpdateData + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - backup_storage + /backup_storages/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: backup_storage_PerformChangeOwner + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - backup_storage + /backup_storages/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: backup_storage_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - backup_storage + /backup_storages/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: backup_storage_GetDetailsClassMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - backup_storage + post: + description: 执行操作ClassMetadata + operationId: backup_storage_PerformClassMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - backup_storage + /backup_storages/{id}/disable: + post: + description: 执行操作Disable + operationId: backup_storage_PerformDisable + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformDisableOutput' + summary: 禁用资源 + tags: + - backup_storage + /backup_storages/{id}/enable: + post: + description: 执行操作Enable + operationId: backup_storage_PerformEnable + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformEnableOutput' + summary: 启用资源 + tags: + - backup_storage + /backup_storages/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: backup_storage_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 backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - backup_storage + /backup_storages/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: backup_storage_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - backup_storage + /backup_storages/{id}/private: + post: + description: 执行操作Private + operationId: backup_storage_PerformPrivate + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformPrivateOutput' + summary: 执行操作Private + tags: + - backup_storage + /backup_storages/{id}/public: + post: + description: 执行操作Public + operationId: backup_storage_PerformPublic + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformPublicOutput' + summary: 执行操作Public + tags: + - backup_storage + /backup_storages/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: backup_storage_PerformSetClassMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - backup_storage + /backup_storages/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: backup_storage_PerformSetOrgMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - backup_storage + /backup_storages/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: backup_storage_PerformSetUserMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - backup_storage + /backup_storages/{id}/status: + get: + description: 获取指定信息Status + operationId: backup_storage_GetDetailsStatus + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - backup_storage + post: + description: 执行操作Status + operationId: backup_storage_PerformStatus + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformStatusOutput' + summary: 更新资源状态 + tags: + - backup_storage + /backup_storages/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: backup_storage_PerformSyncstatus + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/DiskBackupSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - backup_storage + /backup_storages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: backup_storage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - backup_storage + /backup_storages/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: backup_storage_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - backup_storage + /backup_storages/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: backup_storage_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - backup_storage + /backup_storages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: backup_storage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - backup_storage + /backup_storages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: backup_storage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - backup_storage + /backup_storages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: backup_storage_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/backup_storage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - backup_storage + /backup_storages/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: backup_storage_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - backup_storage + /backup_storages/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: backup_storage_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - backup_storage + /backup_storages/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: backup_storage_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - backup_storage + /baremetalagents: + get: + description: 列表 + operationId: baremetalagent_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: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以状态过滤 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以IP地址过滤 + in: query + items: + type: string + name: access_ip + type: array + x-go-name: AccessIp + - description: 以AgentType过滤 + in: query + items: + type: string + name: agent_type + type: array + x-go-name: AgentType + responses: + "200": + $ref: '#/responses/baremetalagent_ListItemFilterOutput' + summary: 管理代理服务列表 + tags: + - baremetalagent + post: + description: 新建 + operationId: baremetalagent_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_ValidateCreateDataOutput' + summary: 新建 + tags: + - baremetalagent + /baremetalagents/{id}: + delete: + description: 删除 + operationId: baremetalagent_CustomizeDelete + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_CustomizeDeleteOutput' + summary: 删除 + tags: + - baremetalagent + get: + description: 获取详情 + operationId: baremetalagent_FetchCustomizeColumns + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - baremetalagent + put: + description: 更新 + operationId: baremetalagent_ValidateUpdateData + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_ValidateUpdateDataOutput' + summary: 更新 + tags: + - baremetalagent + /baremetalagents/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: baremetalagent_GetDetailsClassMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - baremetalagent + post: + description: 执行操作ClassMetadata + operationId: baremetalagent_PerformClassMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - baremetalagent + /baremetalagents/{id}/disable: + post: + description: 执行操作Disable + operationId: baremetalagent_PerformDisable + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformDisableOutput' + summary: 执行操作Disable + tags: + - baremetalagent + /baremetalagents/{id}/disable-image-cache: + post: + description: 执行操作DisableImageCache + operationId: baremetalagent_PerformDisableImageCache + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformDisableImageCacheOutput' + summary: 执行操作DisableImageCache + tags: + - baremetalagent + /baremetalagents/{id}/enable: + post: + description: 执行操作Enable + operationId: baremetalagent_PerformEnable + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformEnableOutput' + summary: 执行操作Enable + tags: + - baremetalagent + /baremetalagents/{id}/enable-image-cache: + post: + description: 执行操作EnableImageCache + operationId: baremetalagent_PerformEnableImageCache + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformEnableImageCacheOutput' + summary: 执行操作EnableImageCache + tags: + - baremetalagent + /baremetalagents/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: baremetalagent_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 baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - baremetalagent + /baremetalagents/{id}/offline: + post: + description: 执行操作Offline + operationId: baremetalagent_PerformOffline + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformOfflineOutput' + summary: 执行操作Offline + tags: + - baremetalagent + /baremetalagents/{id}/online: + post: + description: 执行操作Online + operationId: baremetalagent_PerformOnline + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformOnlineOutput' + summary: 执行操作Online + tags: + - baremetalagent + /baremetalagents/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: baremetalagent_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - baremetalagent + /baremetalagents/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: baremetalagent_PerformSetClassMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - baremetalagent + /baremetalagents/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: baremetalagent_PerformSetOrgMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - baremetalagent + /baremetalagents/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: baremetalagent_PerformSetUserMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - baremetalagent + /baremetalagents/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: baremetalagent_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/baremetalagent_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - baremetalagent + /baremetalagents/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: baremetalagent_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + baremetalagent: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - baremetalagent + /baremetalagents/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: baremetalagent_GetPropertySplitable + responses: + "200": + $ref: '#/responses/baremetalagent_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - baremetalagent + /baremetalagents/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: baremetalagent_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/baremetalagent_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - baremetalagent + /baremetalagents/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: baremetalagent_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/baremetalagent_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - baremetalagent + /baremetalagents/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: baremetalagent_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/baremetalagent_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - baremetalagent + /billing_resource_checks: + get: + description: 列表 + operationId: billing_resource_check_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/billing_resource_check_ListItemFilterOutput' + summary: 列表 + tags: + - billing_resource_check + post: + description: 新建 + operationId: billing_resource_check_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/billing_resource_check_ValidateCreateDataOutput' + summary: 新建 + tags: + - billing_resource_check + /billing_resource_checks/{id}: + delete: + description: 删除 + operationId: billing_resource_check_CustomizeDelete + parameters: + - description: The Id or Name of billing_resource_check + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/billing_resource_check_CustomizeDeleteOutput' + summary: 删除 + tags: + - billing_resource_check + get: + description: 获取详情 + operationId: billing_resource_check_FetchCustomizeColumns + parameters: + - description: The Id or Name of billing_resource_check + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/billing_resource_check_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - billing_resource_check + put: + description: 更新 + operationId: billing_resource_check_ValidateUpdateData + parameters: + - description: The Id or Name of billing_resource_check + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/billing_resource_check_ValidateUpdateDataOutput' + summary: 更新 + tags: + - billing_resource_check + /billing_resource_checks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: billing_resource_check_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/billing_resource_check_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - billing_resource_check + /billing_resource_checks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: billing_resource_check_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + billing_resource_check: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/billing_resource_check_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - billing_resource_check + /billing_resource_checks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: billing_resource_check_GetPropertySplitable + responses: + "200": + $ref: '#/responses/billing_resource_check_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - billing_resource_check + /billing_resource_checks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: billing_resource_check_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/billing_resource_check_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - billing_resource_check + /buckets: + get: + description: 列表 + operationId: bucket_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: STORAGE_CLASS + in: query + items: + type: string + name: storage_class + type: array + x-go-name: StorageClass + - description: 位置 + in: query + items: + type: string + name: location + type: array + x-go-name: Location + - description: ACL + in: query + items: + type: string + name: acl + type: array + x-go-name: Acl + responses: + "200": + $ref: '#/responses/bucket_ListItemFilterOutput' + summary: 对象存储的存储桶列表 + tags: + - bucket + post: + description: 新建 + operationId: bucket_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_ValidateCreateDataOutput' + summary: 新建 + tags: + - bucket + /buckets/{id}: + delete: + description: 删除 + operationId: bucket_CustomizeDelete + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_CustomizeDeleteOutput' + summary: 删除 + tags: + - bucket + get: + description: 获取详情 + operationId: bucket_FetchCustomizeColumns + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - bucket + put: + description: 更新 + operationId: bucket_ValidateUpdateData + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_ValidateUpdateDataOutput' + summary: 更新 + tags: + - bucket + /buckets/{id}/access-info: + get: + description: 获取指定信息AccessInfo + operationId: bucket_GetDetailsAccessInfo + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsAccessInfoOutput' + summary: 获取指定信息AccessInfo + tags: + - bucket + /buckets/{id}/acl: + get: + description: |4- + 获取对象或bucket的ACL + operationId: bucket_GetDetailsAcl + parameters: + - description: 对象KEY + in: query + name: key + type: string + x-go-name: Key + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsAclOutput' + summary: 获取对象或bucket的ACL + tags: + - bucket + post: + description: |4- + 设置对象和bucket的ACL + operationId: bucket_PerformAcl + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketAclInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformAclOutput' + summary: 设置对象和bucket的ACL + tags: + - bucket + /buckets/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: bucket_PerformCancelDelete + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - bucket + /buckets/{id}/cdn-domain: + get: + description: 获取指定信息CdnDomain + operationId: bucket_GetDetailsCdnDomain + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsCdnDomainOutput' + summary: 获取指定信息CdnDomain + tags: + - bucket + /buckets/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: bucket_PerformChangeOwner + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - bucket + /buckets/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: bucket_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - bucket + /buckets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: bucket_GetDetailsClassMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - bucket + post: + description: 执行操作ClassMetadata + operationId: bucket_PerformClassMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - bucket + /buckets/{id}/cors: + get: + description: 获取指定信息Cors + operationId: bucket_GetDetailsCors + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsCorsOutput' + summary: 获取指定信息Cors + tags: + - bucket + /buckets/{id}/delete: + post: + description: |4- + 删除对象 + operationId: bucket_PerformDelete + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPerformDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformDeleteOutput' + summary: 删除对象 + tags: + - bucket + /buckets/{id}/delete-cors: + post: + description: 执行操作DeleteCors + operationId: bucket_PerformDeleteCors + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketCORSRuleDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformDeleteCorsOutput' + summary: 执行操作DeleteCors + tags: + - bucket + /buckets/{id}/delete-policy: + post: + description: 执行操作DeletePolicy + operationId: bucket_PerformDeletePolicy + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPolicyDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformDeletePolicyOutput' + summary: 执行操作DeletePolicy + tags: + - bucket + /buckets/{id}/delete-website: + post: + description: 执行操作DeleteWebsite + operationId: bucket_PerformDeleteWebsite + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformDeleteWebsiteOutput' + summary: 执行操作DeleteWebsite + tags: + - bucket + /buckets/{id}/freeze: + post: + description: 执行操作Freeze + operationId: bucket_PerformFreeze + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - bucket + /buckets/{id}/limit: + post: + description: 执行操作Limit + operationId: bucket_PerformLimit + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformLimitOutput' + summary: 执行操作Limit + tags: + - bucket + /buckets/{id}/makedir: + post: + description: 执行操作Makedir + operationId: bucket_PerformMakedir + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPerformMakedirInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformMakedirOutput' + summary: 新建对象目录 + tags: + - bucket + /buckets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: bucket_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 bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - bucket + post: + description: 执行操作Metadata + operationId: bucket_PerformMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketMetadataInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformMetadataOutput' + summary: 执行操作Metadata + tags: + - bucket + /buckets/{id}/objects: + get: + description: |4- + 获取bucket的对象列表 + operationId: bucket_GetDetailsObjects + parameters: + - description: Prefix + in: query + name: prefix + type: string + x-go-name: Prefix + - description: 是否模拟列举目录模式 + in: query + name: recursive + type: boolean + x-go-name: Recursive + - description: 分页标识 + in: query + name: paging_marker + type: string + x-go-name: PagingMarker + - description: 最大输出条目数 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsObjectsOutput' + summary: 获取bucket的对象列表 + tags: + - bucket + /buckets/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: bucket_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - bucket + /buckets/{id}/policy: + get: + description: 获取指定信息Policy + operationId: bucket_GetDetailsPolicy + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsPolicyOutput' + summary: 获取指定信息Policy + tags: + - bucket + /buckets/{id}/private: + post: + description: 执行操作Private + operationId: bucket_PerformPrivate + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformPrivateOutput' + summary: 执行操作Private + tags: + - bucket + /buckets/{id}/public: + post: + description: 执行操作Public + operationId: bucket_PerformPublic + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformPublicOutput' + summary: 执行操作Public + tags: + - bucket + /buckets/{id}/referer: + get: + description: 获取指定信息Referer + operationId: bucket_GetDetailsReferer + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsRefererOutput' + summary: 获取指定信息Referer + tags: + - bucket + /buckets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: bucket_PerformSetClassMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - bucket + /buckets/{id}/set-cors: + post: + description: 执行操作SetCors + operationId: bucket_PerformSetCors + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketCORSRules' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetCorsOutput' + summary: 执行操作SetCors + tags: + - bucket + /buckets/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: bucket_PerformSetOrgMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - bucket + /buckets/{id}/set-policy: + post: + description: 执行操作SetPolicy + operationId: bucket_PerformSetPolicy + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPolicyStatementInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetPolicyOutput' + summary: 执行操作SetPolicy + tags: + - bucket + /buckets/{id}/set-referer: + post: + description: 执行操作SetReferer + operationId: bucket_PerformSetReferer + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketRefererConf' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetRefererOutput' + summary: 执行操作SetReferer + tags: + - bucket + /buckets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: bucket_PerformSetUserMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - bucket + /buckets/{id}/set-website: + post: + description: 执行操作SetWebsite + operationId: bucket_PerformSetWebsite + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketWebsiteConf' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetWebsiteOutput' + summary: 执行操作SetWebsite + tags: + - bucket + /buckets/{id}/status: + get: + description: 获取指定信息Status + operationId: bucket_GetDetailsStatus + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - bucket + post: + description: 执行操作Status + operationId: bucket_PerformStatus + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformStatusOutput' + summary: 更新资源状态 + tags: + - bucket + /buckets/{id}/sync: + post: + description: 执行操作Sync + operationId: bucket_PerformSync + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformSyncOutput' + summary: 执行操作Sync + tags: + - bucket + /buckets/{id}/syncstatus: + post: + description: |4- + 同步存储桶状态 + operationId: bucket_PerformSyncstatus + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSyncstatusOutput' + summary: 同步存储桶状态 + tags: + - bucket + /buckets/{id}/temp-url: + post: + description: 执行操作TempUrl + operationId: bucket_PerformTempUrl + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPerformTempUrlInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformTempUrlOutput' + summary: 获取访问对象的临时URL + tags: + - bucket + /buckets/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: bucket_PerformUnfreeze + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - bucket + /buckets/{id}/upload: + post: + description: |4- + 上传对象 + operationId: bucket_PerformUpload + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformUploadOutput' + summary: 上传对象 + tags: + - bucket + /buckets/{id}/website: + get: + description: 获取指定信息Website + operationId: bucket_GetDetailsWebsite + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsWebsiteOutput' + summary: 获取指定信息Website + tags: + - bucket + /buckets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: bucket_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/bucket_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - bucket + /buckets/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: bucket_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/bucket_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - bucket + /buckets/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: bucket_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/bucket_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - bucket + /buckets/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: bucket_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/bucket_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - bucket + /buckets/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: bucket_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/bucket_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - bucket + /buckets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: bucket_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - bucket + /buckets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: bucket_GetPropertySplitable + responses: + "200": + $ref: '#/responses/bucket_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - bucket + /buckets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: bucket_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/bucket_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - bucket + /buckets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: bucket_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/bucket_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - bucket + /buckets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: bucket_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/bucket_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - bucket + /buckets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: bucket_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/bucket_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - bucket + /cachedimages: + get: + description: 列表 + operationId: cachedimage_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: '镜像类型，可能值为: system(公有云公共镜像), customized(自定义镜像)' + example: system + in: query + items: + type: string + name: image_type + type: array + x-go-name: ImageType + - description: filter by host schedtag + in: query + name: host_schedtag_id + type: string + x-go-name: HostSchedtagId + - description: valid cachedimage + in: query + name: valid + type: boolean + x-go-name: Valid + responses: + "200": + $ref: '#/responses/cachedimage_ListItemFilterOutput' + summary: 缓存镜像列表 + tags: + - cachedimage + post: + description: 新建 + operationId: cachedimage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/SharableVirtualResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_ValidateCreateDataOutput' + summary: 新建 + tags: + - cachedimage + /cachedimages/{id}: + delete: + description: 删除 + operationId: cachedimage_CustomizeDelete + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_CustomizeDeleteOutput' + summary: 删除 + tags: + - cachedimage + get: + description: 获取详情 + operationId: cachedimage_FetchCustomizeColumns + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cachedimage + put: + description: 更新 + operationId: cachedimage_ValidateUpdateData + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cachedimage + /cachedimages/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: cachedimage_PerformCancelDelete + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - cachedimage + /cachedimages/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cachedimage_PerformChangeOwner + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cachedimage + /cachedimages/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cachedimage_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cachedimage + /cachedimages/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cachedimage_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cachedimage + post: + description: 执行操作ClassMetadata + operationId: cachedimage_PerformClassMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cachedimage + /cachedimages/{id}/freeze: + post: + description: 执行操作Freeze + operationId: cachedimage_PerformFreeze + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - cachedimage + /cachedimages/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cachedimage_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 cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cachedimage + /cachedimages/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cachedimage_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cachedimage + /cachedimages/{id}/private: + post: + description: 执行操作Private + operationId: cachedimage_PerformPrivate + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cachedimage + /cachedimages/{id}/public: + post: + description: 执行操作Public + operationId: cachedimage_PerformPublic + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformPublicOutput' + summary: 执行操作Public + tags: + - cachedimage + /cachedimages/{id}/refresh: + post: + description: 执行操作Refresh + operationId: cachedimage_PerformRefresh + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_PerformRefreshOutput' + summary: 执行操作Refresh + tags: + - cachedimage + /cachedimages/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cachedimage_PerformSetClassMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cachedimage + /cachedimages/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cachedimage_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cachedimage + /cachedimages/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cachedimage_PerformSetUserMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cachedimage + /cachedimages/{id}/status: + get: + description: 获取指定信息Status + operationId: cachedimage_GetDetailsStatus + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cachedimage + post: + description: 执行操作Status + operationId: cachedimage_PerformStatus + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cachedimage + /cachedimages/{id}/uncache-image: + post: + description: 执行操作UncacheImage + operationId: cachedimage_PerformUncacheImage + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedImageUncacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformUncacheImageOutput' + summary: 清除镜像缓存 + tags: + - cachedimage + /cachedimages/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: cachedimage_PerformUnfreeze + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - cachedimage + /cachedimages/cache-image: + post: + description: 执行操作CacheImage + operationId: cachedimage_PerformCacheImage + parameters: + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedImageManagerCacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformCacheImageOutput' + summary: 执行操作CacheImage + tags: + - cachedimage + /cachedimages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cachedimage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cachedimage + /cachedimages/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: cachedimage_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - cachedimage + /cachedimages/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: cachedimage_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - cachedimage + /cachedimages/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: cachedimage_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - cachedimage + /cachedimages/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: cachedimage_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - cachedimage + /cachedimages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cachedimage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cachedimage + /cachedimages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cachedimage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cachedimage + /cachedimages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cachedimage_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/cachedimage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cachedimage + /cachedimages/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cachedimage_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cachedimage + /cachedimages/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cachedimage_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cachedimage + /cachedimages/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cachedimage_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cachedimage + /cdn_domains: + get: + description: 列表 + operationId: cdn_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 + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/cdn_domain_ListItemFilterOutput' + summary: 列出CDN域名 + tags: + - cdn_domain + post: + description: 新建 + operationId: cdn_domain_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_ValidateCreateDataOutput' + summary: 新建 + tags: + - cdn_domain + /cdn_domains/{id}: + delete: + description: 删除 + operationId: cdn_domain_CustomizeDelete + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_CustomizeDeleteOutput' + summary: 删除 + tags: + - cdn_domain + get: + description: 获取详情 + operationId: cdn_domain_FetchCustomizeColumns + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cdn_domain + put: + description: 更新 + operationId: cdn_domain_ValidateUpdateData + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cdn_domain + /cdn_domains/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: cdn_domain_PerformCancelDelete + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - cdn_domain + /cdn_domains/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cdn_domain_PerformChangeOwner + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cdn_domain + /cdn_domains/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cdn_domain_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cdn_domain + /cdn_domains/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cdn_domain_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cdn_domain + post: + description: 执行操作ClassMetadata + operationId: cdn_domain_PerformClassMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cdn_domain + /cdn_domains/{id}/disable: + post: + description: 执行操作Disable + operationId: cdn_domain_PerformDisable + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformDisableOutput' + summary: 禁用资源 + tags: + - cdn_domain + /cdn_domains/{id}/enable: + post: + description: 执行操作Enable + operationId: cdn_domain_PerformEnable + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformEnableOutput' + summary: 启用资源 + tags: + - cdn_domain + /cdn_domains/{id}/freeze: + post: + description: 执行操作Freeze + operationId: cdn_domain_PerformFreeze + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - cdn_domain + /cdn_domains/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cdn_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 cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cdn_domain + /cdn_domains/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cdn_domain_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cdn_domain + /cdn_domains/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: cdn_domain_PerformRemoteUpdate + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - cdn_domain + /cdn_domains/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cdn_domain_PerformSetClassMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cdn_domain + /cdn_domains/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cdn_domain_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cdn_domain + /cdn_domains/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cdn_domain_PerformSetUserMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cdn_domain + /cdn_domains/{id}/status: + get: + description: 获取指定信息Status + operationId: cdn_domain_GetDetailsStatus + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cdn_domain + post: + description: 执行操作Status + operationId: cdn_domain_PerformStatus + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cdn_domain + /cdn_domains/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: cdn_domain_PerformSyncstatus + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/NatGatewaySyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformSyncstatusOutput' + summary: 同步域名状态 + tags: + - cdn_domain + /cdn_domains/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: cdn_domain_PerformUnfreeze + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - cdn_domain + /cdn_domains/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cdn_domain_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cdn_domain + /cdn_domains/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: cdn_domain_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - cdn_domain + /cdn_domains/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: cdn_domain_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - cdn_domain + /cdn_domains/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: cdn_domain_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - cdn_domain + /cdn_domains/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: cdn_domain_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - cdn_domain + /cdn_domains/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cdn_domain_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cdn_domain + /cdn_domains/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cdn_domain_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cdn_domain + /cdn_domains/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cdn_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/cdn_domain_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cdn_domain + /cdn_domains/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cdn_domain_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cdn_domain + /cdn_domains/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cdn_domain_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cdn_domain + /cdn_domains/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cdn_domain_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cdn_domain + /cloudaccounts: + get: + description: 列表 + operationId: cloudaccount_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 根据该云平台的功能对云账号或云订阅进行过滤 + in: query + items: + type: string + name: capability + type: array + x-go-name: Capability + - description: 同步状态 + in: query + items: + type: string + name: sync_status + type: array + x-go-name: SyncStatus + - description: 账号健康状态 + in: query + items: + type: string + name: health_status + type: array + x-go-name: HealthStatus + - in: query + name: read_only + type: boolean + x-go-name: ReadOnly + - description: 共享模式 + in: query + items: + type: string + name: share_mode + type: array + x-go-name: ShareMode + - description: 代理 + in: query + name: proxy_setting + type: string + x-go-name: ProxySetting + - description: 按宿主机数量排序 + in: query + name: order_by_host_count + pattern: asc|desc + type: string + x-go-name: OrderByHostCount + - description: 按虚拟机数量排序 + in: query + name: order_by_guest_count + pattern: asc|desc + type: string + x-go-name: OrderByGuestCount + responses: + "200": + $ref: '#/responses/cloudaccount_ListItemFilterOutput' + summary: 云账号列表 + tags: + - cloudaccount + post: + description: 新建 + operationId: cloudaccount_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudaccount + /cloudaccounts/{id}: + delete: + description: 删除 + operationId: cloudaccount_CustomizeDelete + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudaccount + get: + description: 获取详情 + operationId: cloudaccount_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudaccount + put: + description: 更新 + operationId: cloudaccount_ValidateUpdateData + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudaccount + /cloudaccounts/{id}/balance: + get: + description: 获取指定信息Balance + operationId: cloudaccount_GetDetailsBalance + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsBalanceOutput' + summary: 获取指定信息Balance + tags: + - cloudaccount + /cloudaccounts/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudaccount_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudaccount + /cloudaccounts/{id}/change-project: + post: + description: 执行操作ChangeProject + operationId: cloudaccount_PerformChangeProject + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformChangeProjectOutput' + summary: 执行操作ChangeProject + tags: + - cloudaccount + /cloudaccounts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudaccount_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudaccount + post: + description: 执行操作ClassMetadata + operationId: cloudaccount_PerformClassMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudaccount + /cloudaccounts/{id}/create-subscription: + post: + description: 执行操作CreateSubscription + operationId: cloudaccount_PerformCreateSubscription + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/SubscriptonCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformCreateSubscriptionOutput' + summary: 创建Azure订阅 + tags: + - cloudaccount + /cloudaccounts/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudaccount_PerformDisable + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformDisableOutput' + summary: 执行操作Disable + tags: + - cloudaccount + /cloudaccounts/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudaccount_PerformEnable + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformEnableOutput' + summary: 执行操作Enable + tags: + - cloudaccount + /cloudaccounts/{id}/enrollment-accounts: + get: + description: 获取指定信息EnrollmentAccounts + operationId: cloudaccount_GetDetailsEnrollmentAccounts + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsEnrollmentAccountsOutput' + summary: 获取Azure Enrollment Accounts + tags: + - cloudaccount + /cloudaccounts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudaccount_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 cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudaccount + /cloudaccounts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cloudaccount_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cloudaccount + /cloudaccounts/{id}/private: + post: + description: 执行操作Private + operationId: cloudaccount_PerformPrivate + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cloudaccount + /cloudaccounts/{id}/project-mapping: + post: + description: 执行操作ProjectMapping + operationId: cloudaccount_PerformProjectMapping + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountProjectMappingInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformProjectMappingOutput' + summary: 绑定同步策略 + tags: + - cloudaccount + /cloudaccounts/{id}/public: + post: + description: 执行操作Public + operationId: cloudaccount_PerformPublic + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountPerformPublicInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformPublicOutput' + summary: 执行操作Public + tags: + - cloudaccount + /cloudaccounts/{id}/saml: + get: + description: 获取指定信息Saml + operationId: cloudaccount_GetDetailsSaml + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsSamlOutput' + summary: 获取指定信息Saml + tags: + - cloudaccount + /cloudaccounts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudaccount_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudaccount + /cloudaccounts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cloudaccount_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudaccount + /cloudaccounts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudaccount_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudaccount + /cloudaccounts/{id}/share-mode: + post: + description: 执行操作ShareMode + operationId: cloudaccount_PerformShareMode + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountShareModeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformShareModeOutput' + summary: Deprecated + tags: + - cloudaccount + /cloudaccounts/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudaccount_GetDetailsStatus + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudaccount + post: + description: 执行操作Status + operationId: cloudaccount_PerformStatus + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudaccount + /cloudaccounts/{id}/sync: + post: + description: 执行操作Sync + operationId: cloudaccount_PerformSync + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/SyncRangeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformSyncOutput' + summary: 执行操作Sync + tags: + - cloudaccount + /cloudaccounts/{id}/sync-skus: + post: + description: 执行操作SyncSkus + operationId: cloudaccount_PerformSyncSkus + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountSyncSkusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - cloudaccount + /cloudaccounts/{id}/test-connectivity: + post: + description: 执行操作TestConnectivity + operationId: cloudaccount_PerformTestConnectivity + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/SCloudaccountCredential' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformTestConnectivityOutput' + summary: 测试账号连通性(更新秘钥信息时) + tags: + - cloudaccount + /cloudaccounts/{id}/update-credential: + post: + description: 执行操作UpdateCredential + operationId: cloudaccount_PerformUpdateCredential + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_PerformUpdateCredentialOutput' + summary: 执行操作UpdateCredential + tags: + - cloudaccount + /cloudaccounts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudaccount_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudaccount + /cloudaccounts/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: cloudaccount_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - cloudaccount + /cloudaccounts/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: cloudaccount_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - cloudaccount + /cloudaccounts/prepare-nets: + post: + description: 执行操作PrepareNets + operationId: cloudaccount_PerformPrepareNets + parameters: + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountPerformPrepareNetsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformPrepareNetsOutput' + summary: Performpreparenets searches for suitable network facilities for physical and virtual machines under the cloud account or provides configuration recommendations for network facilities before importing a cloud account. + tags: + - cloudaccount + /cloudaccounts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudaccount_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudaccount + /cloudaccounts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudaccount_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudaccount + /cloudaccounts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudaccount_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/cloudaccount_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudaccount + /cloudaccounts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudaccount_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudaccount + /cloudaccounts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudaccount_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudaccount + /cloudaccounts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudaccount_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudaccount + /cloudimages: + get: + description: 列表 + operationId: cloudimage_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/cloudimage_ListItemFilterOutput' + summary: 列表 + tags: + - cloudimage + post: + description: 新建 + operationId: cloudimage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudimage + /cloudimages/{id}: + delete: + description: 删除 + operationId: cloudimage_CustomizeDelete + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudimage_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudimage + get: + description: 获取详情 + operationId: cloudimage_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudimage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudimage + put: + description: 更新 + operationId: cloudimage_ValidateUpdateData + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudimage + /cloudimages/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudimage_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudimage_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudimage + post: + description: 执行操作ClassMetadata + operationId: cloudimage_PerformClassMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudimage + /cloudimages/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudimage_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 cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudimage_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudimage + /cloudimages/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cloudimage_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudimage_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cloudimage + /cloudimages/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudimage_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudimage + /cloudimages/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cloudimage_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudimage + /cloudimages/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudimage_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudimage + /cloudimages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudimage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudimage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudimage + /cloudimages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudimage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudimage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudimage + /cloudimages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudimage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudimage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudimage + /cloudimages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudimage_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/cloudimage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudimage + /cloudimages/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudimage_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudimage_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudimage + /cloudimages/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudimage_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudimage_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudimage + /cloudproviderregions: + get: + description: 列表 + operationId: cloudproviderregion_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 同步状态 + in: query + items: + type: string + name: sync_status + type: array + x-go-name: SyncStatus + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 根据该云平台的功能对云账号或云订阅进行过滤 + in: query + items: + type: string + name: capability + type: array + x-go-name: Capability + - description: 是否启用 + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/cloudproviderregion_ListItemFilterOutput' + summary: 列表 + tags: + - cloudproviderregion + post: + description: 新建 + operationId: cloudproviderregion_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/JoinResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudproviderregion_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudproviderregion + /cloudproviderregions/{id}: + delete: + description: 删除 + operationId: cloudproviderregion_CustomizeDelete + parameters: + - description: The Id or Name of cloudproviderregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudproviderregion_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudproviderregion + get: + description: 获取详情 + operationId: cloudproviderregion_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudproviderregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudproviderregion_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudproviderregion + put: + description: 更新 + operationId: cloudproviderregion_ValidateUpdateData + parameters: + - description: The Id or Name of cloudproviderregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudproviderregion_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudproviderregion + /cloudproviderregions/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudproviderregion_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudproviderregion_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudproviderregion + /cloudproviderregions/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudproviderregion_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudproviderregion_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudproviderregion + /cloudproviderregions/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudproviderregion_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudproviderregion_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudproviderregion + /cloudproviderregions/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudproviderregion_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/cloudproviderregion_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudproviderregion + /cloudproviders: + get: + description: 列表 + operationId: cloudprovider_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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 根据该云平台的功能对云账号或云订阅进行过滤 + in: query + items: + type: string + name: capability + type: array + x-go-name: Capability + - description: 同步状态 + in: query + items: + type: string + name: sync_status + type: array + x-go-name: SyncStatus + - in: query + name: read_only + type: boolean + x-go-name: ReadOnly + - description: 账号健康状态 + in: query + items: + type: string + name: health_status + type: array + x-go-name: HealthStatus + - description: filter by host schedtag + in: query + name: host_schedtag_id + type: string + x-go-name: HostSchedtagId + responses: + "200": + $ref: '#/responses/cloudprovider_ListItemFilterOutput' + summary: 云订阅列表 + tags: + - cloudprovider + /cloudproviders/{id}: + delete: + description: 删除 + operationId: cloudprovider_CustomizeDelete + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudprovider + get: + description: 获取详情 + operationId: cloudprovider_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudprovider + put: + description: 更新 + operationId: cloudprovider_ValidateUpdateData + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudprovider + /cloudproviders/{id}/canned-acls: + get: + description: 获取指定信息CannedAcls + operationId: cloudprovider_GetDetailsCannedAcls + parameters: + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsCannedAclsOutput' + summary: 获取指定信息CannedAcls + tags: + - cloudprovider + /cloudproviders/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudprovider_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudprovider + /cloudproviders/{id}/change-project: + post: + description: 执行操作ChangeProject + operationId: cloudprovider_PerformChangeProject + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformChangeProjectOutput' + summary: 执行操作ChangeProject + tags: + - cloudprovider + /cloudproviders/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudprovider_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudprovider + post: + description: 执行操作ClassMetadata + operationId: cloudprovider_PerformClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/clirc: + get: + description: 获取指定信息Clirc + operationId: cloudprovider_GetDetailsClirc + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsClircOutput' + summary: 获取指定信息Clirc + tags: + - cloudprovider + /cloudproviders/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudprovider_PerformDisable + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformDisableOutput' + summary: 执行操作Disable + tags: + - cloudprovider + /cloudproviders/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudprovider_PerformEnable + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformEnableOutput' + summary: 执行操作Enable + tags: + - cloudprovider + /cloudproviders/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudprovider_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 cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudprovider + /cloudproviders/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cloudprovider_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cloudprovider + /cloudproviders/{id}/project-mapping: + post: + description: 执行操作ProjectMapping + operationId: cloudprovider_PerformProjectMapping + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudaccountProjectMappingInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformProjectMappingOutput' + summary: 绑定同步策略 + tags: + - cloudprovider + /cloudproviders/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudprovider_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cloudprovider_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: cloudprovider_PerformSetSchedtag + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - cloudprovider + /cloudproviders/{id}/set-syncing: + post: + description: 执行操作SetSyncing + operationId: cloudprovider_PerformSetSyncing + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderSync' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetSyncingOutput' + summary: 执行操作SetSyncing + tags: + - cloudprovider + /cloudproviders/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudprovider_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudprovider + /cloudproviders/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudprovider_GetDetailsStatus + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudprovider + post: + description: 执行操作Status + operationId: cloudprovider_PerformStatus + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudprovider + /cloudproviders/{id}/storage-classes: + get: + description: 获取指定信息StorageClasses + operationId: cloudprovider_GetDetailsStorageClasses + parameters: + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsStorageClassesOutput' + summary: 获取指定信息StorageClasses + tags: + - cloudprovider + /cloudproviders/{id}/sync: + post: + description: 执行操作Sync + operationId: cloudprovider_PerformSync + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/SyncRangeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSyncOutput' + summary: 执行操作Sync + tags: + - cloudprovider + /cloudproviders/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudprovider_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudprovider + /cloudproviders/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudprovider_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudprovider + /cloudproviders/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudprovider_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudprovider + /cloudproviders/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudprovider_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/cloudprovider_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudprovider + /cloudproviders/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudprovider_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudprovider + /cloudproviders/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudprovider_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudprovider + /cloudproviders/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudprovider_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudprovider + /cloudregions: + get: + description: 列表 + operationId: cloudregion_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by Vpc usability of the resource + in: query + name: usable_vpc + type: boolean + x-go-name: UsableVpc + - description: 根据该云平台的功能对云账号或云订阅进行过滤 + in: query + items: + type: string + name: capability + type: array + x-go-name: Capability + - description: 过滤位于指定城市的区域 + in: query + name: city + type: string + x-go-name: City + - description: 过滤提供特定服务的区域 + in: query + name: service + type: string + x-go-name: Service + - description: 云环境 + in: query + items: + type: string + name: environment + type: array + x-go-name: Environment + - description: 按可用区数量排序 + in: query + name: order_by_zone_count + pattern: asc|desc + type: string + x-go-name: OrderByZoneCount + - description: 按vpc数量排序 + in: query + name: order_by_vpc_count + pattern: asc|desc + type: string + x-go-name: OrderByVpcCount + - description: 按虚拟机数量排序 + in: query + name: order_by_guest_count + pattern: asc|desc + type: string + x-go-name: OrderByGuestCount + responses: + "200": + $ref: '#/responses/cloudregion_ListItemFilterOutput' + summary: 云平台区域列表 + tags: + - cloudregion + post: + description: 新建 + operationId: cloudregion_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudregion + /cloudregions/{id}: + delete: + description: 删除 + operationId: cloudregion_CustomizeDelete + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudregion + get: + description: 获取详情 + operationId: cloudregion_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudregion + put: + description: 更新 + operationId: cloudregion_ValidateUpdateData + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudregion + /cloudregions/{id}/capability: + get: + description: 获取指定信息Capability + operationId: cloudregion_GetDetailsCapability + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsCapabilityOutput' + summary: 获取指定信息Capability + tags: + - cloudregion + /cloudregions/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudregion_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudregion + post: + description: 执行操作ClassMetadata + operationId: cloudregion_PerformClassMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudregion + /cloudregions/{id}/default-vpc: + post: + description: 执行操作DefaultVpc + operationId: cloudregion_PerformDefaultVpc + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_PerformDefaultVpcOutput' + summary: 执行操作DefaultVpc + tags: + - cloudregion + /cloudregions/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudregion_PerformDisable + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformDisableOutput' + summary: 禁用资源 + tags: + - cloudregion + /cloudregions/{id}/disk-capability: + get: + description: 获取指定信息DiskCapability + operationId: cloudregion_GetDetailsDiskCapability + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsDiskCapabilityOutput' + summary: 获取指定信息DiskCapability + tags: + - cloudregion + /cloudregions/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudregion_PerformEnable + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformEnableOutput' + summary: 启用资源 + tags: + - cloudregion + /cloudregions/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudregion_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 cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudregion + /cloudregions/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: cloudregion_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - cloudregion + /cloudregions/{id}/purge: + post: + description: 执行操作Purge + operationId: cloudregion_PerformPurge + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionPurgeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - cloudregion + /cloudregions/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudregion_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudregion + /cloudregions/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: cloudregion_PerformSetOrgMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudregion + /cloudregions/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: cloudregion_PerformSetSchedtag + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - cloudregion + /cloudregions/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudregion_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudregion + /cloudregions/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudregion_GetDetailsStatus + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudregion + post: + description: 执行操作Status + operationId: cloudregion_PerformStatus + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudregion + /cloudregions/{id}/sync-images: + post: + description: 执行操作SyncImages + operationId: cloudregion_PerformSyncImages + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/SyncImagesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformSyncImagesOutput' + summary: 执行操作SyncImages + tags: + - cloudregion + /cloudregions/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudregion_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudregion + /cloudregions/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudregion_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudregion + /cloudregions/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudregion_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudregion + /cloudregions/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudregion_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/cloudregion_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudregion + /cloudregions/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudregion_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudregion + /cloudregions/sync-skus: + post: + description: 执行操作SyncSkus + operationId: cloudregion_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionSkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - cloudregion + /cloudregions/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: cloudregion_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - cloudregion + /cloudregions/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudregion_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudregion + /cloudregions/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudregion_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudregion + /containers: + get: + description: 列表 + operationId: container_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - in: query + name: guest_id + type: string + x-go-name: GuestId + responses: + "200": + $ref: '#/responses/container_ListItemFilterOutput' + summary: 列表 + tags: + - container + post: + description: 新建 + operationId: container_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + container: + $ref: '#/definitions/ContainerCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_ValidateCreateDataOutput' + summary: 新建 + tags: + - container + /containers/{id}: + delete: + description: 删除 + operationId: container_CustomizeDelete + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_CustomizeDeleteOutput' + summary: 删除 + tags: + - container + get: + description: 获取详情 + operationId: container_FetchCustomizeColumns + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - container + put: + description: 更新 + operationId: container_ValidateUpdateData + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + $ref: '#/definitions/ContainerUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_ValidateUpdateDataOutput' + summary: 更新 + tags: + - container + /containers/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: container_PerformCancelDelete + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - container + /containers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: container_PerformChangeOwner + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - container + /containers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: container_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - container + /containers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: container_GetDetailsClassMetadata + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - container + post: + description: 执行操作ClassMetadata + operationId: container_PerformClassMetadata + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - container + /containers/{id}/exec-info: + get: + description: 获取指定信息ExecInfo + operationId: container_GetDetailsExecInfo + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_GetDetailsExecInfoOutput' + summary: 获取指定信息ExecInfo + tags: + - container + /containers/{id}/freeze: + post: + description: 执行操作Freeze + operationId: container_PerformFreeze + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - container + /containers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: container_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 container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - container + /containers/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: container_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - container + /containers/{id}/save-volume-mount-image: + post: + description: 执行操作SaveVolumeMountImage + operationId: container_PerformSaveVolumeMountImage + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + $ref: '#/definitions/ContainerSaveVolumeMountToImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformSaveVolumeMountImageOutput' + summary: 执行操作SaveVolumeMountImage + tags: + - container + /containers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: container_PerformSetClassMetadata + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - container + /containers/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: container_PerformSetOrgMetadata + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - container + /containers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: container_PerformSetUserMetadata + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - container + /containers/{id}/start: + post: + description: 执行操作Start + operationId: container_PerformStart + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_PerformStartOutput' + summary: 执行操作Start + tags: + - container + /containers/{id}/status: + get: + description: 获取指定信息Status + operationId: container_GetDetailsStatus + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - container + post: + description: 执行操作Status + operationId: container_PerformStatus + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformStatusOutput' + summary: 更新资源状态 + tags: + - container + /containers/{id}/stop: + post: + description: 执行操作Stop + operationId: container_PerformStop + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + $ref: '#/definitions/ContainerStopInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformStopOutput' + summary: 执行操作Stop + tags: + - container + /containers/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: container_PerformSyncstatus + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/container_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - container + /containers/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: container_PerformUnfreeze + parameters: + - description: The Id or Name of container + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + container: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - container + /containers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: container_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/container_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - container + /containers/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: container_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/container_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - container + /containers/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: container_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/container_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - container + /containers/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: container_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/container_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - container + /containers/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: container_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/container_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - container + /containers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: container_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + container: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/container_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - container + /containers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: container_GetPropertySplitable + responses: + "200": + $ref: '#/responses/container_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - container + /containers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: container_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/container_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - container + /containers/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: container_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/container_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - container + /containers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: container_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/container_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - container + /containers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: container_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/container_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - container + /db_instance_accounts: + get: + description: 列表 + operationId: db_instance_account_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/db_instance_account_ListItemFilterOutput' + summary: RDS账号列表 + tags: + - db_instance_account + post: + description: 新建 + operationId: db_instance_account_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_account: + $ref: '#/definitions/DBInstanceAccountCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_account + /db_instance_accounts/{id}: + delete: + description: 删除 + operationId: db_instance_account_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_account + get: + description: 获取详情 + operationId: db_instance_account_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_account + put: + description: 更新 + operationId: db_instance_account_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_account + /db_instance_accounts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_account_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_account + post: + description: 执行操作ClassMetadata + operationId: db_instance_account_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_account + /db_instance_accounts/{id}/grant-privilege: + post: + description: 执行操作GrantPrivilege + operationId: db_instance_account_PerformGrantPrivilege + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_PerformGrantPrivilegeOutput' + summary: 执行操作GrantPrivilege + tags: + - db_instance_account + /db_instance_accounts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_account_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 db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_account + /db_instance_accounts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: db_instance_account_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - db_instance_account + /db_instance_accounts/{id}/reset-password: + post: + description: 执行操作ResetPassword + operationId: db_instance_account_PerformResetPassword + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_PerformResetPasswordOutput' + summary: 执行操作ResetPassword + tags: + - db_instance_account + /db_instance_accounts/{id}/revoke-privilege: + post: + description: 执行操作RevokePrivilege + operationId: db_instance_account_PerformRevokePrivilege + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_PerformRevokePrivilegeOutput' + summary: 执行操作RevokePrivilege + tags: + - db_instance_account + /db_instance_accounts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_account_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_account + /db_instance_accounts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: db_instance_account_PerformSetOrgMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_account + /db_instance_accounts/{id}/set-privileges: + post: + description: 执行操作SetPrivileges + operationId: db_instance_account_PerformSetPrivileges + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_PerformSetPrivilegesOutput' + summary: 执行操作SetPrivileges + tags: + - db_instance_account + /db_instance_accounts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_account_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_account + /db_instance_accounts/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_account_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance_account + post: + description: 执行操作Status + operationId: db_instance_account_PerformStatus + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance_account + /db_instance_accounts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_account_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_account + /db_instance_accounts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_account_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_account: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_account + /db_instance_accounts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_account_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_account + /db_instance_accounts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_account_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/db_instance_account_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_account + /db_instance_accounts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_account_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance_account + /db_instance_accounts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_account_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_account + /db_instance_accounts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_account_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_account + /db_instance_backups: + get: + description: 列表 + operationId: db_instance_backup_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: RDS引擎 + example: MySQL + in: query + items: + type: string + name: engine + type: array + x-go-name: Engine + - description: RDS引擎版本 + example: "5.7" + in: query + items: + type: string + name: engine_version + type: array + x-go-name: EngineVersion + - description: 备份模式 + in: query + items: + type: string + name: backup_mode + type: array + x-go-name: BackupMode + - description: 数据库名称 + in: query + name: db_names + type: string + x-go-name: DBNames + responses: + "200": + $ref: '#/responses/db_instance_backup_ListItemFilterOutput' + summary: RDS备份列表 + tags: + - db_instance_backup + post: + description: 新建 + operationId: db_instance_backup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_backup + /db_instance_backups/{id}: + delete: + description: 删除 + operationId: db_instance_backup_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_backup + get: + description: 获取详情 + operationId: db_instance_backup_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_backup + put: + description: 更新 + operationId: db_instance_backup_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_backup + /db_instance_backups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: db_instance_backup_PerformCancelDelete + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - db_instance_backup + /db_instance_backups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: db_instance_backup_PerformChangeOwner + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - db_instance_backup + /db_instance_backups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: db_instance_backup_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - db_instance_backup + /db_instance_backups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_backup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_backup + post: + description: 执行操作ClassMetadata + operationId: db_instance_backup_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_backup + /db_instance_backups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: db_instance_backup_PerformFreeze + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - db_instance_backup + /db_instance_backups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_backup_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 db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_backup + /db_instance_backups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: db_instance_backup_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - db_instance_backup + /db_instance_backups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_backup_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_backup + /db_instance_backups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: db_instance_backup_PerformSetOrgMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_backup + /db_instance_backups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_backup_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_backup + /db_instance_backups/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_backup_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance_backup + post: + description: 执行操作Status + operationId: db_instance_backup_PerformStatus + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance_backup + /db_instance_backups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: db_instance_backup_PerformSyncstatus + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DiskSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformSyncstatusOutput' + summary: 同步RDS备份状态 + tags: + - db_instance_backup + /db_instance_backups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: db_instance_backup_PerformUnfreeze + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - db_instance_backup + /db_instance_backups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_backup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_backup + /db_instance_backups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: db_instance_backup_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - db_instance_backup + /db_instance_backups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: db_instance_backup_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - db_instance_backup + /db_instance_backups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: db_instance_backup_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - db_instance_backup + /db_instance_backups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: db_instance_backup_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - db_instance_backup + /db_instance_backups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_backup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_backup + /db_instance_backups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_backup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_backup + /db_instance_backups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_backup_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/db_instance_backup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_backup + /db_instance_backups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_backup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance_backup + /db_instance_backups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_backup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_backup + /db_instance_backups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_backup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_backup + /db_instance_databases: + get: + description: 列表 + operationId: db_instance_database_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 数据库字符集 + in: query + items: + type: string + name: character_set + type: array + x-go-name: CharacterSet + responses: + "200": + $ref: '#/responses/db_instance_database_ListItemFilterOutput' + summary: RDS数据库列表 + tags: + - db_instance_database + post: + description: 新建 + operationId: db_instance_database_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_database: + $ref: '#/definitions/DBInstanceDatabaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_database + /db_instance_databases/{id}: + delete: + description: 删除 + operationId: db_instance_database_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_database + get: + description: 获取详情 + operationId: db_instance_database_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_database + put: + description: 更新 + operationId: db_instance_database_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstanceDatabaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_database + /db_instance_databases/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_database_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_database + post: + description: 执行操作ClassMetadata + operationId: db_instance_database_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_database + /db_instance_databases/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_database_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 db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_database + /db_instance_databases/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: db_instance_database_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - db_instance_database + /db_instance_databases/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_database_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_database + /db_instance_databases/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: db_instance_database_PerformSetOrgMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_database + /db_instance_databases/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_database_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_database + /db_instance_databases/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_database_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance_database + post: + description: 执行操作Status + operationId: db_instance_database_PerformStatus + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance_database + /db_instance_databases/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_database_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_database + /db_instance_databases/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_database_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_database: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_database + /db_instance_databases/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_database_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_database + /db_instance_databases/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_database_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/db_instance_database_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_database + /db_instance_databases/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_database_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance_database + /db_instance_databases/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_database_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_database + /db_instance_databases/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_database_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_database + /db_instance_networks: + get: + description: 列表 + operationId: db_instance_network_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + responses: + "200": + $ref: '#/responses/db_instance_network_ListItemFilterOutput' + summary: RDS网络列表 + tags: + - db_instance_network + post: + description: 新建 + operationId: db_instance_network_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_network: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_network_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_network + /db_instance_networks/{id}: + delete: + description: 删除 + operationId: db_instance_network_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_network_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_network + get: + description: 获取详情 + operationId: db_instance_network_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_network_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_network + put: + description: 更新 + operationId: db_instance_network_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_network_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_network + /db_instance_networks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_network_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_network_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_network + /db_instance_networks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_network_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_network: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_network_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_network + /db_instance_networks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_network_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_network_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_network + /db_instance_networks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_network_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/db_instance_network_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_network + /db_instance_parameters: + get: + description: 列表 + operationId: db_instance_parameter_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 参数名称 + in: query + items: + type: string + name: key + type: array + x-go-name: Key + - description: 参数值 + in: query + items: + type: string + name: value + type: array + x-go-name: Value + responses: + "200": + $ref: '#/responses/db_instance_parameter_ListItemFilterOutput' + summary: 列出数据参数 + tags: + - db_instance_parameter + post: + description: 新建 + operationId: db_instance_parameter_ValidateCreateData + responses: + "200": + $ref: '#/responses/db_instance_parameter_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_parameter + /db_instance_parameters/{id}: + delete: + description: 删除 + operationId: db_instance_parameter_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_parameter_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_parameter + get: + description: 获取详情 + operationId: db_instance_parameter_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_parameter_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_parameter + put: + description: 更新 + operationId: db_instance_parameter_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_parameter + /db_instance_parameters/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_parameter_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_parameter + post: + description: 执行操作ClassMetadata + operationId: db_instance_parameter_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_parameter + /db_instance_parameters/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_parameter_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 db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_parameter + /db_instance_parameters/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: db_instance_parameter_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - db_instance_parameter + /db_instance_parameters/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_parameter_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_parameter + /db_instance_parameters/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: db_instance_parameter_PerformSetOrgMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_parameter + /db_instance_parameters/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_parameter_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_parameter + /db_instance_parameters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_parameter_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_parameter + /db_instance_parameters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_parameter_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_parameter + /db_instance_parameters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_parameter_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_parameter + /db_instance_parameters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_parameter_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/db_instance_parameter_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_parameter + /db_instance_parameters/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_parameter_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_parameter + /db_instance_parameters/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_parameter_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_parameter + /db_instance_privileges: + get: + description: 列表 + operationId: db_instance_privilege_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: filter by dbinstanceaccount + in: query + name: dbinstanceaccount + type: string + x-go-name: Dbinstanceaccount + - description: filter by dbinstancedatabase + in: query + name: dbinstancedatabase + type: string + x-go-name: Dbinstancedatabase + - description: 权限 + in: query + items: + type: string + name: privilege + type: array + x-go-name: Privilege + responses: + "200": + $ref: '#/responses/db_instance_privilege_ListItemFilterOutput' + summary: 列表 + tags: + - db_instance_privilege + post: + description: 新建 + operationId: db_instance_privilege_ValidateCreateData + responses: + "200": + $ref: '#/responses/db_instance_privilege_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_privilege + /db_instance_privileges/{id}: + delete: + description: 删除 + operationId: db_instance_privilege_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_privilege + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_privilege_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_privilege + get: + description: 获取详情 + operationId: db_instance_privilege_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_privilege + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_privilege_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_privilege + put: + description: 更新 + operationId: db_instance_privilege_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_privilege + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_privilege_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_privilege + /db_instance_privileges/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_privilege_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_privilege_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_privilege + /db_instance_privileges/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_privilege_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_privilege_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_privilege + /db_instance_privileges/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_privilege_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_privilege_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_privilege + /db_instance_privileges/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_privilege_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/db_instance_privilege_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_privilege + /db_instance_secgroups: + get: + description: 列表 + operationId: db_instance_secgroup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + responses: + "200": + $ref: '#/responses/db_instance_secgroup_ListItemFilterOutput' + summary: 列表 + tags: + - db_instance_secgroup + post: + description: 新建 + operationId: db_instance_secgroup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_secgroup: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_secgroup_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_secgroup + /db_instance_secgroups/{id}: + delete: + description: 删除 + operationId: db_instance_secgroup_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_secgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_secgroup_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_secgroup + get: + description: 获取详情 + operationId: db_instance_secgroup_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_secgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_secgroup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_secgroup + put: + description: 更新 + operationId: db_instance_secgroup_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_secgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_secgroup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_secgroup + /db_instance_secgroups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_secgroup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_secgroup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_secgroup + /db_instance_secgroups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_secgroup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_secgroup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_secgroup + /db_instance_secgroups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_secgroup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_secgroup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_secgroup + /db_instance_secgroups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_secgroup_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/db_instance_secgroup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_secgroup + /db_instance_skus: + get: + description: 列表 + operationId: db_instance_sku_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: StorageType + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - in: query + items: + format: int64 + type: integer + name: vcpu_count + type: array + x-go-name: VcpuCount + - in: query + items: + format: int64 + type: integer + name: vmem_size_mb + type: array + x-go-name: VmemSizeMb + - in: query + items: + type: string + name: category + type: array + x-go-name: Category + - in: query + items: + type: string + name: engine + type: array + x-go-name: Engine + - in: query + items: + type: string + name: engine_version + type: array + x-go-name: EngineVersion + - in: query + items: + type: string + name: zone1 + type: array + x-go-name: Zone1 + - in: query + items: + type: string + name: zone2 + type: array + x-go-name: Zone2 + - in: query + items: + type: string + name: zone3 + type: array + x-go-name: Zone3 + responses: + "200": + $ref: '#/responses/db_instance_sku_ListItemFilterOutput' + summary: RDS套餐类型列表 + tags: + - db_instance_sku + post: + description: 新建 + operationId: db_instance_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_sku + /db_instance_skus/{id}: + delete: + description: 删除 + operationId: db_instance_sku_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_sku + get: + description: 获取详情 + operationId: db_instance_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_sku + put: + description: 更新 + operationId: db_instance_sku_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_sku + /db_instance_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_sku + post: + description: 执行操作ClassMetadata + operationId: db_instance_sku_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_sku + /db_instance_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: db_instance_sku_PerformDisable + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - db_instance_sku + /db_instance_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: db_instance_sku_PerformEnable + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - db_instance_sku + /db_instance_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_sku_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 db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_sku + /db_instance_skus/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: db_instance_sku_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - db_instance_sku + /db_instance_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_sku + /db_instance_skus/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: db_instance_sku_PerformSetOrgMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_sku + /db_instance_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_sku + /db_instance_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_sku_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance_sku + post: + description: 执行操作Status + operationId: db_instance_sku_PerformStatus + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance_sku + /db_instance_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_sku + /db_instance_skus/instance-specs: + get: + description: 获取指定资源类的信息InstanceSpecs + operationId: db_instance_sku_GetPropertyInstanceSpecs + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyInstanceSpecsOutput' + summary: 获取指定资源类的信息InstanceSpecs + tags: + - db_instance_sku + /db_instance_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_sku + /db_instance_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_sku + /db_instance_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_sku_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/db_instance_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_sku + /db_instance_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance_sku + /db_instance_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: db_instance_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - db_instance_sku + /db_instance_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: db_instance_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - db_instance_sku + /db_instance_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_sku + /db_instance_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_sku + /db_instances: + get: + description: 列表 + operationId: db_instance_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - in: query + name: master_instance + type: string + x-go-name: MasterInstance + - format: int64 + in: query + name: vcpu_count + type: integer + x-go-name: VcpuCount + - format: int64 + in: query + name: vmem_size_mb + type: integer + x-go-name: VmemSizeMb + - in: query + name: storage_type + type: string + x-go-name: StorageType + - in: query + name: category + type: string + x-go-name: Category + - in: query + name: engine + type: string + x-go-name: Engine + - in: query + name: engine_version + type: string + x-go-name: EngineVersion + - in: query + name: instance_type + type: string + x-go-name: InstanceType + - description: 通过IP搜索RDS实例 + in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + - description: 通过安全组Id过滤RDS实例 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + responses: + "200": + $ref: '#/responses/db_instance_ListItemFilterOutput' + summary: RDS实例列表 + tags: + - db_instance + post: + description: 新建 + operationId: db_instance_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance: + $ref: '#/definitions/DBInstanceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance + /db_instances/{id}: + delete: + description: 删除 + operationId: db_instance_CustomizeDelete + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance + get: + description: 获取详情 + operationId: db_instance_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance + put: + description: 更新 + operationId: db_instance_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance + /db_instances/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: db_instance_PerformCancelDelete + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - db_instance + /db_instances/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: db_instance_PerformCancelExpire + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformCancelExpireOutput' + summary: 执行操作CancelExpire + tags: + - db_instance + /db_instances/{id}/change-config: + post: + description: 执行操作ChangeConfig + operationId: db_instance_PerformChangeConfig + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/SDBInstanceChangeConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformChangeConfigOutput' + summary: 执行操作ChangeConfig + tags: + - db_instance + /db_instances/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: db_instance_PerformChangeOwner + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - db_instance + /db_instances/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: db_instance_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - db_instance + /db_instances/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance + post: + description: 执行操作ClassMetadata + operationId: db_instance_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance + /db_instances/{id}/freeze: + post: + description: 执行操作Freeze + operationId: db_instance_PerformFreeze + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - db_instance + /db_instances/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_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 db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance + /db_instances/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: db_instance_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - db_instance + /db_instances/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: db_instance_PerformPostpaidExpire + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformPostpaidExpireOutput' + summary: 执行操作PostpaidExpire + tags: + - db_instance + /db_instances/{id}/public-connection: + post: + description: 执行操作PublicConnection + operationId: db_instance_PerformPublicConnection + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformPublicConnectionOutput' + summary: 执行操作PublicConnection + tags: + - db_instance + /db_instances/{id}/purge: + post: + description: 执行操作Purge + operationId: db_instance_PerformPurge + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - db_instance + /db_instances/{id}/reboot: + post: + description: 执行操作Reboot + operationId: db_instance_PerformReboot + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformRebootOutput' + summary: 执行操作Reboot + tags: + - db_instance + /db_instances/{id}/recovery: + post: + description: 执行操作Recovery + operationId: db_instance_PerformRecovery + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/SDBInstanceRecoveryConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformRecoveryOutput' + summary: 执行操作Recovery + tags: + - db_instance + /db_instances/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: db_instance_PerformRemoteUpdate + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - db_instance + /db_instances/{id}/renew: + post: + description: 执行操作Renew + operationId: db_instance_PerformRenew + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformRenewOutput' + summary: 执行操作Renew + tags: + - db_instance + /db_instances/{id}/set-auto-renew: + post: + description: |- + 要求RDS状态为running + 要求RDS计费类型为包年包月(预付费) + operationId: db_instance_PerformSetAutoRenew + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceAutoRenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformSetAutoRenewOutput' + summary: 设置自动续费 + tags: + - db_instance + /db_instances/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance + /db_instances/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: db_instance_PerformSetOrgMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance + /db_instances/{id}/set-secgroup: + post: + description: 执行操作SetSecgroup + operationId: db_instance_PerformSetSecgroup + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceSetSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformSetSecgroupOutput' + summary: 执行操作SetSecgroup + tags: + - db_instance + /db_instances/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance + /db_instances/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance + post: + description: 执行操作Status + operationId: db_instance_PerformStatus + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance + /db_instances/{id}/sync: + post: + description: 执行操作Sync + operationId: db_instance_PerformSync + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformSyncOutput' + summary: 同步RDS信息 + tags: + - db_instance + /db_instances/{id}/sync-status: + post: + description: 执行操作SyncStatus + operationId: db_instance_PerformSyncStatus + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformSyncStatusOutput' + summary: 同步RDS状态(弃用) + tags: + - db_instance + /db_instances/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: db_instance_PerformSyncstatus + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformSyncstatusOutput' + summary: 同步RDS实例状态 + tags: + - db_instance + /db_instances/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: db_instance_PerformUnfreeze + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - db_instance + /db_instances/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance + /db_instances/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: db_instance_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - db_instance + /db_instances/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: db_instance_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - db_instance + /db_instances/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: db_instance_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - db_instance + /db_instances/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: db_instance_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - db_instance + /db_instances/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance + /db_instances/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance + /db_instances/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_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/db_instance_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance + /db_instances/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance + /db_instances/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance + /db_instances/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance + /disk_backups: + get: + description: 列表 + operationId: disk_backup_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - description: 'description: disk id' + in: query + name: disk_id + type: string + x-go-name: DiskId + - description: 'description: backup storage id' + in: query + name: backup_storage_id + type: string + x-go-name: BackupStorageId + - description: 'description: 是否为主机备份的一部分' + in: query + name: is_instance_backup + type: boolean + x-go-name: IsInstanceBackup + - description: 按硬盘名称排序 + in: query + name: order_by_disk_name + type: string + x-go-name: OrderByDiskName + responses: + "200": + $ref: '#/responses/disk_backup_ListItemFilterOutput' + summary: 列表 + tags: + - disk_backup + post: + description: 新建 + operationId: disk_backup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + disk_backup: + $ref: '#/definitions/DiskBackupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_ValidateCreateDataOutput' + summary: 新建 + tags: + - disk_backup + /disk_backups/{id}: + delete: + description: 删除 + operationId: disk_backup_CustomizeDelete + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_CustomizeDeleteOutput' + summary: 删除 + tags: + - disk_backup + get: + description: 获取详情 + operationId: disk_backup_FetchCustomizeColumns + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - disk_backup + put: + description: 更新 + operationId: disk_backup_ValidateUpdateData + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - disk_backup + /disk_backups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: disk_backup_PerformCancelDelete + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - disk_backup + /disk_backups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: disk_backup_PerformChangeOwner + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - disk_backup + /disk_backups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: disk_backup_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - disk_backup + /disk_backups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: disk_backup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - disk_backup + post: + description: 执行操作ClassMetadata + operationId: disk_backup_PerformClassMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - disk_backup + /disk_backups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: disk_backup_PerformFreeze + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - disk_backup + /disk_backups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: disk_backup_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 disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - disk_backup + /disk_backups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: disk_backup_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - disk_backup + /disk_backups/{id}/recovery: + post: + description: 执行操作Recovery + operationId: disk_backup_PerformRecovery + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupRecoveryInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformRecoveryOutput' + summary: 执行操作Recovery + tags: + - disk_backup + /disk_backups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: disk_backup_PerformSetClassMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - disk_backup + /disk_backups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: disk_backup_PerformSetOrgMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - disk_backup + /disk_backups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: disk_backup_PerformSetUserMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - disk_backup + /disk_backups/{id}/status: + get: + description: 获取指定信息Status + operationId: disk_backup_GetDetailsStatus + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - disk_backup + post: + description: 执行操作Status + operationId: disk_backup_PerformStatus + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - disk_backup + /disk_backups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: disk_backup_PerformSyncstatus + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - disk_backup + /disk_backups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: disk_backup_PerformUnfreeze + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - disk_backup + /disk_backups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: disk_backup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - disk_backup + /disk_backups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: disk_backup_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - disk_backup + /disk_backups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: disk_backup_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - disk_backup + /disk_backups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: disk_backup_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - disk_backup + /disk_backups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: disk_backup_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - disk_backup + /disk_backups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: disk_backup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - disk_backup + /disk_backups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: disk_backup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - disk_backup + /disk_backups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: disk_backup_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/disk_backup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - disk_backup + /disk_backups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: disk_backup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - disk_backup + /disk_backups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: disk_backup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - disk_backup + /disk_backups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: disk_backup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - disk_backup + /disks: + get: + description: 列表 + operationId: disk_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - in: query + name: AutoDelete + type: boolean + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: 以存储名称排序 + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: filter disk by snapshotpolicy + in: query + name: snapshotpolicy_id + type: string + x-go-name: SnapshotpolicyId + - description: 以快照策略名称排序 + in: query + name: order_by_snapshotpolicy + type: string + x-go-name: OrderBySnapshotpolicy + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: filter disk by whether it is being used + in: query + name: unused + type: boolean + x-go-name: Unused + - description: |- + 过滤指定disk_type的磁盘列表，可能的值为：sys, data, swap. volume + + disk_type值 | 说明 | + -------------|----------| + sys | 虚拟机系统盘 | + data | 虚拟机数据盘 | + swap | 虚拟机内存交换盘 | + volume | 容器volumn盘 | + in: query + name: disk_type + type: string + x-go-name: DiskType + - in: query + name: disk_format + type: string + x-go-name: DiskFormat + - format: int64 + in: query + name: disk_size + type: integer + x-go-name: DiskSize + - in: query + name: fs_format + type: string + x-go-name: FsFormat + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - in: query + name: order_by_guest_count + type: string + x-go-name: OrderByGuestCount + - description: 镜像 + in: query + name: image_id + type: string + x-go-name: ImageId + - description: 快照 + in: query + name: snapshot_id + type: string + x-go-name: SnapshotId + - description: 根据虚拟机状态过滤 + in: query + name: guest_status + type: string + x-go-name: GuestStatus + responses: + "200": + $ref: '#/responses/disk_ListItemFilterOutput' + summary: 磁盘列表 + tags: + - disk + post: + description: 新建 + operationId: disk_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + disk: + $ref: '#/definitions/DiskCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_ValidateCreateDataOutput' + summary: 新建 + tags: + - disk + /disks/{id}: + delete: + description: 删除 + operationId: disk_CustomizeDelete + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_CustomizeDeleteOutput' + summary: 删除 + tags: + - disk + get: + description: 获取详情 + operationId: disk_FetchCustomizeColumns + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - disk + put: + description: 更新 + operationId: disk_ValidateUpdateData + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_ValidateUpdateDataOutput' + summary: 更新 + tags: + - disk + /disks/{id}/bind-snapshotpolicy: + post: + description: 执行操作BindSnapshotpolicy + operationId: disk_PerformBindSnapshotpolicy + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskSnapshotpolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformBindSnapshotpolicyOutput' + summary: 执行操作BindSnapshotpolicy + tags: + - disk + /disks/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: disk_PerformCancelDelete + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - disk + /disks/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: disk_PerformChangeOwner + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - disk + /disks/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: disk_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - disk + /disks/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: disk_GetDetailsClassMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - disk + post: + description: 执行操作ClassMetadata + operationId: disk_PerformClassMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - disk + /disks/{id}/disk-reset: + post: + description: 执行操作DiskReset + operationId: disk_PerformDiskReset + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskResetInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformDiskResetOutput' + summary: 执行操作DiskReset + tags: + - disk + /disks/{id}/freeze: + post: + description: 执行操作Freeze + operationId: disk_PerformFreeze + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - disk + /disks/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: disk_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 disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - disk + /disks/{id}/migrate: + post: + description: 执行操作Migrate + operationId: disk_PerformMigrate + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskMigrateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformMigrateOutput' + summary: 执行操作Migrate + tags: + - disk + /disks/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: disk_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - disk + /disks/{id}/purge: + post: + description: 执行操作Purge + operationId: disk_PerformPurge + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - disk + /disks/{id}/rebuild: + post: + description: 执行操作Rebuild + operationId: disk_PerformRebuild + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskRebuildInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformRebuildOutput' + summary: 执行操作Rebuild + tags: + - disk + /disks/{id}/resize: + post: + description: 执行操作Resize + operationId: disk_PerformResize + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskResizeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformResizeOutput' + summary: 执行操作Resize + tags: + - disk + /disks/{id}/save: + post: + description: 执行操作Save + operationId: disk_PerformSave + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskSaveInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformSaveOutput' + summary: 执行操作Save + tags: + - disk + /disks/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: disk_PerformSetClassMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - disk + /disks/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: disk_PerformSetOrgMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - disk + /disks/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: disk_PerformSetUserMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - disk + /disks/{id}/status: + get: + description: 获取指定信息Status + operationId: disk_GetDetailsStatus + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - disk + post: + description: 执行操作Status + operationId: disk_PerformStatus + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformStatusOutput' + summary: 更新资源状态 + tags: + - disk + /disks/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: disk_PerformSyncstatus + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformSyncstatusOutput' + summary: 同步磁盘状态 + tags: + - disk + /disks/{id}/unbind-snapshotpolicy: + post: + description: 执行操作UnbindSnapshotpolicy + operationId: disk_PerformUnbindSnapshotpolicy + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskSnapshotpolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformUnbindSnapshotpolicyOutput' + summary: 执行操作UnbindSnapshotpolicy + tags: + - disk + /disks/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: disk_PerformUnfreeze + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - disk + /disks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: disk_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/disk_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - disk + /disks/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: disk_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/disk_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - disk + /disks/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: disk_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/disk_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - disk + /disks/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: disk_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/disk_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - disk + /disks/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: disk_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/disk_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - disk + /disks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: disk_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - disk + /disks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: disk_GetPropertySplitable + responses: + "200": + $ref: '#/responses/disk_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - disk + /disks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: disk_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/disk_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - disk + /disks/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: disk_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/disk_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - disk + /disks/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: disk_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/disk_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - disk + /disks/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: disk_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/disk_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - disk + /dns_records: + get: + description: 列表 + operationId: dns_record_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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: dns_zone_id + type: string + x-go-name: DnsZoneId + responses: + "200": + $ref: '#/responses/dns_record_ListItemFilterOutput' + summary: DNS记录列表 + tags: + - dns_record + post: + description: 新建 + operationId: dns_record_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + dns_record: + $ref: '#/definitions/DnsRecordCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_ValidateCreateDataOutput' + summary: 创建 + tags: + - dns_record + /dns_records/{id}: + delete: + description: 删除 + operationId: dns_record_CustomizeDelete + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_record + get: + description: 获取详情 + operationId: dns_record_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_FetchCustomizeColumnsOutput' + summary: 解析详情 + tags: + - dns_record + put: + description: 更新 + operationId: dns_record_ValidateUpdateData + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_record + /dns_records/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: dns_record_GetDetailsClassMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - dns_record + post: + description: 执行操作ClassMetadata + operationId: dns_record_PerformClassMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - dns_record + /dns_records/{id}/disable: + post: + description: 执行操作Disable + operationId: dns_record_PerformDisable + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformDisableOutput' + summary: 禁用 + tags: + - dns_record + /dns_records/{id}/enable: + post: + description: 执行操作Enable + operationId: dns_record_PerformEnable + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformEnableOutput' + summary: 启用 + tags: + - dns_record + /dns_records/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: dns_record_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 dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - dns_record + /dns_records/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: dns_record_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - dns_record + /dns_records/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: dns_record_PerformSetClassMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dns_record + /dns_records/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: dns_record_PerformSetOrgMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dns_record + /dns_records/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: dns_record_PerformSetUserMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - dns_record + /dns_records/{id}/status: + get: + description: 获取指定信息Status + operationId: dns_record_GetDetailsStatus + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - dns_record + post: + description: 执行操作Status + operationId: dns_record_PerformStatus + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformStatusOutput' + summary: 更新资源状态 + tags: + - dns_record + /dns_records/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_record_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_record + /dns_records/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_record_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_record + /dns_records/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_record_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_record_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_record + /dns_records/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_record_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/dns_record_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_record + /dns_records/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: dns_record_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - dns_record + /dns_records/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: dns_record_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - dns_record + /dns_records/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: dns_record_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - dns_record + /dns_zone_vpcs: + get: + description: 列表 + operationId: dns_zone_vpc_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/dns_zone_vpc_ListItemFilterOutput' + summary: 列表 + tags: + - dns_zone_vpc + post: + description: 新建 + operationId: dns_zone_vpc_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + dns_zone_vpc: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_vpc_ValidateCreateDataOutput' + summary: 新建 + tags: + - dns_zone_vpc + /dns_zone_vpcs/{id}: + delete: + description: 删除 + operationId: dns_zone_vpc_CustomizeDelete + parameters: + - description: The Id or Name of dns_zone_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_vpc_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_zone_vpc + get: + description: 获取详情 + operationId: dns_zone_vpc_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_zone_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_vpc_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - dns_zone_vpc + put: + description: 更新 + operationId: dns_zone_vpc_ValidateUpdateData + parameters: + - description: The Id or Name of dns_zone_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_vpc_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_zone_vpc + /dns_zone_vpcs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_zone_vpc_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_zone_vpc_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_zone_vpc + /dns_zone_vpcs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_zone_vpc_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_vpc_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_zone_vpc + /dns_zone_vpcs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_zone_vpc_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_zone_vpc_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_zone_vpc + /dns_zone_vpcs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_zone_vpc_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/dns_zone_vpc_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_zone_vpc + /dns_zones: + get: + description: 列表 + operationId: dns_zone_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: 指定查询的权限范围，可能值为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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: |- + 区域类型 + + + 类型 | 说明 | + ---------- |---------| + PublicZone | 公有 | + PrivateZone | 私有 | + in: query + name: zone_type + type: string + x-go-name: ZoneType + - description: Filter dns zone By vpc + in: query + name: vpc_id + type: string + x-go-name: VpcId + responses: + "200": + $ref: '#/responses/dns_zone_ListItemFilterOutput' + summary: 列表 + tags: + - dns_zone + post: + description: 新建 + operationId: dns_zone_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + dns_zone: + $ref: '#/definitions/DnsZoneCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_ValidateCreateDataOutput' + summary: 创建 + tags: + - dns_zone + /dns_zones/{id}: + delete: + description: 删除 + operationId: dns_zone_CustomizeDelete + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_zone + get: + description: 获取详情 + operationId: dns_zone_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_FetchCustomizeColumnsOutput' + summary: 解析详情 + tags: + - dns_zone + put: + description: 更新 + operationId: dns_zone_ValidateUpdateData + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_zone + /dns_zones/{id}/add-vpcs: + post: + description: 执行操作AddVpcs + operationId: dns_zone_PerformAddVpcs + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneAddVpcsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformAddVpcsOutput' + summary: 添加VPC + tags: + - dns_zone + /dns_zones/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: dns_zone_PerformCancelDelete + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - dns_zone + /dns_zones/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: dns_zone_PerformChangeOwner + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - dns_zone + /dns_zones/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: dns_zone_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - dns_zone + /dns_zones/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: dns_zone_GetDetailsClassMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - dns_zone + post: + description: 执行操作ClassMetadata + operationId: dns_zone_PerformClassMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - dns_zone + /dns_zones/{id}/exports: + get: + description: 获取指定信息Exports + operationId: dns_zone_GetDetailsExports + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsExportsOutput' + summary: 获取指定信息Exports + tags: + - dns_zone + /dns_zones/{id}/freeze: + post: + description: 执行操作Freeze + operationId: dns_zone_PerformFreeze + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - dns_zone + /dns_zones/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: dns_zone_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 dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - dns_zone + /dns_zones/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: dns_zone_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - dns_zone + /dns_zones/{id}/private: + post: + description: 执行操作Private + operationId: dns_zone_PerformPrivate + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformPrivateOutput' + summary: 执行操作Private + tags: + - dns_zone + /dns_zones/{id}/public: + post: + description: 执行操作Public + operationId: dns_zone_PerformPublic + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformPublicOutput' + summary: 执行操作Public + tags: + - dns_zone + /dns_zones/{id}/purge: + post: + description: 执行操作Purge + operationId: dns_zone_PerformPurge + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZonePurgeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - dns_zone + /dns_zones/{id}/remove-vpcs: + post: + description: 执行操作RemoveVpcs + operationId: dns_zone_PerformRemoveVpcs + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneRemoveVpcsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformRemoveVpcsOutput' + summary: 移除VPC + tags: + - dns_zone + /dns_zones/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: dns_zone_PerformSetClassMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dns_zone + /dns_zones/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: dns_zone_PerformSetOrgMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dns_zone + /dns_zones/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: dns_zone_PerformSetUserMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - dns_zone + /dns_zones/{id}/status: + get: + description: 获取指定信息Status + operationId: dns_zone_GetDetailsStatus + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - dns_zone + post: + description: 执行操作Status + operationId: dns_zone_PerformStatus + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformStatusOutput' + summary: 更新资源状态 + tags: + - dns_zone + /dns_zones/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: dns_zone_PerformSyncstatus + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneSyncStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformSyncstatusOutput' + summary: 同步状态 + tags: + - dns_zone + /dns_zones/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: dns_zone_PerformUnfreeze + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - dns_zone + /dns_zones/capability: + get: + description: 获取指定资源类的信息Capability + operationId: dns_zone_GetPropertyCapability + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyCapabilityOutput' + summary: 获取指定资源类的信息Capability + tags: + - dns_zone + /dns_zones/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_zone_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_zone + /dns_zones/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: dns_zone_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - dns_zone + /dns_zones/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: dns_zone_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - dns_zone + /dns_zones/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: dns_zone_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - dns_zone + /dns_zones/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: dns_zone_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - dns_zone + /dns_zones/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_zone_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_zone + /dns_zones/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_zone_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_zone + /dns_zones/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_zone_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/dns_zone_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_zone + /dns_zones/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: dns_zone_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - dns_zone + /dns_zones/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: dns_zone_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - dns_zone + /dns_zones/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: dns_zone_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - dns_zone + /domain_quotas/domains: + get: + description: 获取所有域的域配额 + operationId: models_ListDomainQuotas + 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_ListDomainQuotasOutput' + summary: 获取所有域的域配额 + tags: + - domain_quota + /domain_quotas/domains/{domainId}: + get: + description: 获取指定域的配额 + operationId: models_GetDomainQuota + 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_GetDomainQuotaOutput' + summary: 获取指定域的配额 + tags: + - domain_quota + post: + description: 设置域的域配额 + operationId: models_SetDomainQuotas + parameters: + - description: 指定域的ID + in: path + name: domainId + required: true + type: string + x-go-name: DomainId + - in: body + name: body + schema: + properties: + domain_quotas: + $ref: '#/definitions/SetDomainQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetDomainQuotasOutput' + summary: 设置域的域配额 + tags: + - domain_quota + /dynamicschedtags: + get: + description: 列表 + operationId: dynamicschedtag_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: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - description: filter by enabled status + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/dynamicschedtag_ListItemFilterOutput' + summary: 动态调度标签列表 + tags: + - dynamicschedtag + post: + description: 新建 + operationId: dynamicschedtag_ValidateCreateData + responses: + "200": + $ref: '#/responses/dynamicschedtag_ValidateCreateDataOutput' + summary: 新建 + tags: + - dynamicschedtag + /dynamicschedtags/{id}: + delete: + description: 删除 + operationId: dynamicschedtag_CustomizeDelete + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_CustomizeDeleteOutput' + summary: 删除 + tags: + - dynamicschedtag + get: + description: 获取详情 + operationId: dynamicschedtag_FetchCustomizeColumns + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - dynamicschedtag + put: + description: 更新 + operationId: dynamicschedtag_ValidateUpdateData + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dynamicschedtag + /dynamicschedtags/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: dynamicschedtag_GetDetailsClassMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - dynamicschedtag + post: + description: 执行操作ClassMetadata + operationId: dynamicschedtag_PerformClassMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - dynamicschedtag + /dynamicschedtags/{id}/evaluate: + post: + description: 执行操作Evaluate + operationId: dynamicschedtag_PerformEvaluate + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformEvaluateOutput' + summary: 执行操作Evaluate + tags: + - dynamicschedtag + /dynamicschedtags/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: dynamicschedtag_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 dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - dynamicschedtag + /dynamicschedtags/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: dynamicschedtag_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - dynamicschedtag + /dynamicschedtags/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: dynamicschedtag_PerformSetClassMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dynamicschedtag + /dynamicschedtags/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: dynamicschedtag_PerformSetOrgMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dynamicschedtag + /dynamicschedtags/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: dynamicschedtag_PerformSetUserMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - dynamicschedtag + /dynamicschedtags/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dynamicschedtag_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dynamicschedtag + /dynamicschedtags/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dynamicschedtag_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dynamicschedtag + /dynamicschedtags/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dynamicschedtag_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dynamicschedtag + /dynamicschedtags/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dynamicschedtag_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/dynamicschedtag_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dynamicschedtag + /dynamicschedtags/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: dynamicschedtag_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - dynamicschedtag + /dynamicschedtags/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: dynamicschedtag_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - dynamicschedtag + /elastic_searches: + get: + description: 列表 + operationId: elastic_search_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/elastic_search_ListItemFilterOutput' + summary: ElasticSearch实例列表 + tags: + - elastic_search + post: + description: 新建 + operationId: elastic_search_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elastic_search: + $ref: '#/definitions/ElasticSearchCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_ValidateCreateDataOutput' + summary: 新建 + tags: + - elastic_search + /elastic_searches/{id}: + delete: + description: 删除 + operationId: elastic_search_CustomizeDelete + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_CustomizeDeleteOutput' + summary: 删除 + tags: + - elastic_search + get: + description: 获取详情 + operationId: elastic_search_FetchCustomizeColumns + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elastic_search + put: + description: 更新 + operationId: elastic_search_ValidateUpdateData + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elastic_search + /elastic_searches/{id}/access-info: + get: + description: 获取指定信息AccessInfo + operationId: elastic_search_GetDetailsAccessInfo + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsAccessInfoOutput' + summary: 获取指定信息AccessInfo + tags: + - elastic_search + /elastic_searches/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: elastic_search_PerformCancelDelete + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - elastic_search + /elastic_searches/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: elastic_search_PerformChangeOwner + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - elastic_search + /elastic_searches/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: elastic_search_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - elastic_search + /elastic_searches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elastic_search_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elastic_search + post: + description: 执行操作ClassMetadata + operationId: elastic_search_PerformClassMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elastic_search + /elastic_searches/{id}/freeze: + post: + description: 执行操作Freeze + operationId: elastic_search_PerformFreeze + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - elastic_search + /elastic_searches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elastic_search_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 elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elastic_search + /elastic_searches/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: elastic_search_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - elastic_search + /elastic_searches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elastic_search_PerformSetClassMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elastic_search + /elastic_searches/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: elastic_search_PerformSetOrgMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elastic_search + /elastic_searches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elastic_search_PerformSetUserMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elastic_search + /elastic_searches/{id}/status: + get: + description: 获取指定信息Status + operationId: elastic_search_GetDetailsStatus + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elastic_search + post: + description: 执行操作Status + operationId: elastic_search_PerformStatus + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elastic_search + /elastic_searches/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: elastic_search_PerformSyncstatus + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_PerformSyncstatusOutput' + summary: 同步ElasticSearch实例状态 + tags: + - elastic_search + /elastic_searches/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: elastic_search_PerformUnfreeze + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - elastic_search + /elastic_searches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elastic_search_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elastic_search + /elastic_searches/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: elastic_search_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - elastic_search + /elastic_searches/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: elastic_search_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - elastic_search + /elastic_searches/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: elastic_search_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - elastic_search + /elastic_searches/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: elastic_search_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - elastic_search + /elastic_searches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elastic_search_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elastic_search + /elastic_searches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elastic_search_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elastic_search + /elastic_searches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elastic_search_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/elastic_search_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elastic_search + /elastic_searches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elastic_search_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elastic_search + /elastic_searches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elastic_search_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elastic_search + /elastic_searches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elastic_search_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elastic_search + /elasticcache_accounts: + get: + description: 列表 + operationId: elasticcache_account_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: 账号类型 normal |admin + in: query + items: + type: string + name: account_type + type: array + x-go-name: AccountType + - description: 账号权限 read | write | repl（复制, 复制权限支持读写，且开放SYNC/PSYNC命令） + in: query + items: + type: string + name: account_privilege + type: array + x-go-name: AccountPrivilege + responses: + "200": + $ref: '#/responses/elasticcache_account_ListItemFilterOutput' + summary: 弹性缓存账号列表 + tags: + - elasticcache_account + post: + description: 新建 + operationId: elasticcache_account_ValidateCreateData + responses: + "200": + $ref: '#/responses/elasticcache_account_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_account + /elasticcache_accounts/{id}: + delete: + description: 删除 + operationId: elasticcache_account_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_account + get: + description: 获取详情 + operationId: elasticcache_account_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_account + put: + description: 更新 + operationId: elasticcache_account_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_account + /elasticcache_accounts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_account_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_account + post: + description: 执行操作ClassMetadata + operationId: elasticcache_account_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_account + /elasticcache_accounts/{id}/login-info: + get: + description: 获取指定信息LoginInfo + operationId: elasticcache_account_GetDetailsLoginInfo + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_GetDetailsLoginInfoOutput' + summary: 获取指定信息LoginInfo + tags: + - elasticcache_account + /elasticcache_accounts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_account_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 elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_account + /elasticcache_accounts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: elasticcache_account_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - elasticcache_account + /elasticcache_accounts/{id}/reset-password: + post: + description: 执行操作ResetPassword + operationId: elasticcache_account_PerformResetPassword + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformResetPasswordOutput' + summary: 执行操作ResetPassword + tags: + - elasticcache_account + /elasticcache_accounts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_account_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_account + /elasticcache_accounts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: elasticcache_account_PerformSetOrgMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_account + /elasticcache_accounts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_account_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_account + /elasticcache_accounts/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_account_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_account + post: + description: 执行操作Status + operationId: elasticcache_account_PerformStatus + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_account + /elasticcache_accounts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_account_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_account + /elasticcache_accounts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_account_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_account: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_account + /elasticcache_accounts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_account_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_account + /elasticcache_accounts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_account_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/elasticcache_account_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_account + /elasticcache_accounts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticcache_account_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticcache_account + /elasticcache_accounts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_account_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_account + /elasticcache_accounts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_account_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_account + /elasticcache_acls: + get: + description: 列表 + operationId: elasticcache_acl_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: Ip地址白名单列表 + in: query + name: ip_list + type: string + x-go-name: IpList + responses: + "200": + $ref: '#/responses/elasticcache_acl_ListItemFilterOutput' + summary: 弹性缓存ACL规则列表 + tags: + - elasticcache_acl + post: + description: 新建 + operationId: elasticcache_acl_ValidateCreateData + responses: + "200": + $ref: '#/responses/elasticcache_acl_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_acl + /elasticcache_acls/{id}: + delete: + description: 删除 + operationId: elasticcache_acl_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_acl + get: + description: 获取详情 + operationId: elasticcache_acl_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_acl + put: + description: 更新 + operationId: elasticcache_acl_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_acl + /elasticcache_acls/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_acl_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_acl + post: + description: 执行操作ClassMetadata + operationId: elasticcache_acl_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_acl + /elasticcache_acls/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_acl_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 elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_acl + /elasticcache_acls/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: elasticcache_acl_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - elasticcache_acl + /elasticcache_acls/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_acl_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_acl + /elasticcache_acls/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: elasticcache_acl_PerformSetOrgMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_acl + /elasticcache_acls/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_acl_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_acl + /elasticcache_acls/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_acl_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_acl + post: + description: 执行操作Status + operationId: elasticcache_acl_PerformStatus + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_acl + /elasticcache_acls/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_acl_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_acl + /elasticcache_acls/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_acl_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_acl + /elasticcache_acls/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_acl_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_acl + /elasticcache_acls/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_acl_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/elasticcache_acl_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_acl + /elasticcache_acls/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_acl_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_acl + /elasticcache_acls/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_acl_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_acl + /elasticcache_backups: + get: + description: 列表 + operationId: elasticcache_backup_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: 备份类型, 全量|增量额 + in: query + items: + type: string + name: backup_type + type: array + x-go-name: BackupType + - description: 备份模式，自动|手动 + in: query + items: + type: string + name: backup_mode + type: array + x-go-name: BackupMode + responses: + "200": + $ref: '#/responses/elasticcache_backup_ListItemFilterOutput' + summary: 弹性缓存备份列表 + tags: + - elasticcache_backup + post: + description: 新建 + operationId: elasticcache_backup_ValidateCreateData + responses: + "200": + $ref: '#/responses/elasticcache_backup_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_backup + /elasticcache_backups/{id}: + delete: + description: 删除 + operationId: elasticcache_backup_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_backup + get: + description: 获取详情 + operationId: elasticcache_backup_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_backup + put: + description: 更新 + operationId: elasticcache_backup_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_backup + /elasticcache_backups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_backup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_backup + post: + description: 执行操作ClassMetadata + operationId: elasticcache_backup_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_backup + /elasticcache_backups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_backup_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 elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_backup + /elasticcache_backups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: elasticcache_backup_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - elasticcache_backup + /elasticcache_backups/{id}/restore-instance: + post: + description: 执行操作RestoreInstance + operationId: elasticcache_backup_PerformRestoreInstance + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformRestoreInstanceOutput' + summary: 执行操作RestoreInstance + tags: + - elasticcache_backup + /elasticcache_backups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_backup_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_backup + /elasticcache_backups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: elasticcache_backup_PerformSetOrgMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_backup + /elasticcache_backups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_backup_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_backup + /elasticcache_backups/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_backup_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_backup + post: + description: 执行操作Status + operationId: elasticcache_backup_PerformStatus + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_backup + /elasticcache_backups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_backup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_backup + /elasticcache_backups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_backup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_backup + /elasticcache_backups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_backup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_backup + /elasticcache_backups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_backup_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/elasticcache_backup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_backup + /elasticcache_backups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticcache_backup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticcache_backup + /elasticcache_backups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_backup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_backup + /elasticcache_backups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_backup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_backup + /elasticcache_parameters: + get: + description: 列表 + operationId: elasticcache_parameter_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: 参数名称 + in: query + items: + type: string + name: key + type: array + x-go-name: Key + - description: 参数值 + in: query + items: + type: string + name: value + type: array + x-go-name: Value + responses: + "200": + $ref: '#/responses/elasticcache_parameter_ListItemFilterOutput' + summary: 列出弹性缓存参数 + tags: + - elasticcache_parameter + post: + description: 新建 + operationId: elasticcache_parameter_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticcache_parameter: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}: + delete: + description: 删除 + operationId: elasticcache_parameter_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_parameter + get: + description: 获取详情 + operationId: elasticcache_parameter_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_parameter + put: + description: 更新 + operationId: elasticcache_parameter_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_parameter_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_parameter + post: + description: 执行操作ClassMetadata + operationId: elasticcache_parameter_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_parameter_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 elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: elasticcache_parameter_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_parameter_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: elasticcache_parameter_PerformSetOrgMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_parameter_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_parameter_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_parameter + post: + description: 执行操作Status + operationId: elasticcache_parameter_PerformStatus + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_parameter + /elasticcache_parameters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_parameter_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_parameter + /elasticcache_parameters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_parameter_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_parameter + /elasticcache_parameters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_parameter_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_parameter + /elasticcache_parameters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_parameter_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/elasticcache_parameter_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_parameter + /elasticcache_parameters/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_parameter_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_parameter + /elasticcache_parameters/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_parameter_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_parameter + /elasticcache_skus: + get: + description: 列表 + operationId: elasticcache_sku_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: filter sku by memory size in MB + format: int64 + in: query + name: memory_size_mb + type: integer + x-go-name: MemorySizeMb + - in: query + items: + type: string + name: instance_spec + type: array + x-go-name: InstanceSpec + - in: query + items: + type: string + name: engine_arch + type: array + x-go-name: EngineArch + - in: query + items: + type: string + name: local_category + type: array + x-go-name: LocalCategory + - in: query + items: + type: string + name: prepaid_status + type: array + x-go-name: PrepaidStatus + - in: query + items: + type: string + name: postpaid_sStatus + type: array + x-go-name: PostpaidStatus + - description: 引擎 redis|memcached + in: query + items: + type: string + name: engine + type: array + x-go-name: Engine + - description: 引擎版本 3.0 + in: query + items: + type: string + name: engine_version + type: array + x-go-name: EngineVersion + - description: CPU 架构 x86|ARM + in: query + items: + type: string + name: cpu_arch + type: array + x-go-name: CpuArch + - description: 存储类型 DRAM|SCM + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - description: standrad|enhanced + in: query + items: + type: string + name: performance_type + type: array + x-go-name: PerformanceType + - description: single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | readfive（5只读） + in: query + items: + type: string + name: node_type + type: array + x-go-name: NodeType + responses: + "200": + $ref: '#/responses/elasticcache_sku_ListItemFilterOutput' + summary: 弹性缓存套餐规格列表 + tags: + - elasticcache_sku + post: + description: 新建 + operationId: elasticcache_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticcache_sku: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_sku + /elasticcache_skus/{id}: + delete: + description: 删除 + operationId: elasticcache_sku_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_sku + get: + description: 获取详情 + operationId: elasticcache_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_sku + put: + description: 更新 + operationId: elasticcache_sku_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_sku + /elasticcache_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_sku + post: + description: 执行操作ClassMetadata + operationId: elasticcache_sku_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_sku + /elasticcache_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_sku_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 elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_sku + /elasticcache_skus/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: elasticcache_sku_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - elasticcache_sku + /elasticcache_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_sku + /elasticcache_skus/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: elasticcache_sku_PerformSetOrgMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_sku + /elasticcache_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_sku + /elasticcache_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_sku_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_sku + post: + description: 执行操作Status + operationId: elasticcache_sku_PerformStatus + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_sku + /elasticcache_skus/capability: + get: + description: 获取指定资源类的信息Capability + operationId: elasticcache_sku_GetPropertyCapability + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyCapabilityOutput' + summary: 获取指定资源类的信息Capability + tags: + - elasticcache_sku + /elasticcache_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_sku + /elasticcache_skus/instance-specs: + get: + description: 获取指定资源类的信息InstanceSpecs + operationId: elasticcache_sku_GetPropertyInstanceSpecs + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyInstanceSpecsOutput' + summary: 获取指定资源类的信息InstanceSpecs + tags: + - elasticcache_sku + /elasticcache_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_sku + /elasticcache_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_sku + /elasticcache_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_sku_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/elasticcache_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_sku + /elasticcache_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticcache_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticcache_sku + /elasticcache_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: elasticcache_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - elasticcache_sku + /elasticcache_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: elasticcache_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - elasticcache_sku + /elasticcache_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_sku + /elasticcache_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_sku + /elasticcaches: + get: + description: 列表 + operationId: elasticcache_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: 实例规格 + example: redis.master.micro.default + in: query + items: + type: string + name: instance_type + type: array + x-go-name: InstanceType + - description: 对应Sku + in: query + items: + type: string + name: local_category + type: array + x-go-name: LocalCategory + - description: |- + 类型 + single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | readfive（5只读） + in: query + items: + type: string + name: node_type + type: array + x-go-name: NodeType + - description: |- + 后端存储引擎 + Redis | Memcache + example: redis + in: query + items: + type: string + name: engine + type: array + x-go-name: Engine + - description: 后端存储引擎版本 + example: "4.0" + in: query + items: + type: string + name: engine_version + type: array + x-go-name: EngineVersion + - description: 网络类型, CLASSIC（经典网络） VPC（专有网络） + example: CLASSIC + in: query + items: + type: string + name: network_type + type: array + x-go-name: NetworkType + - description: 内网DNS + in: query + items: + type: string + name: private_dns + type: array + x-go-name: PrivateDNS + - description: 内网IP地址 + in: query + items: + type: string + name: private_ip_addr + type: array + x-go-name: PrivateIpAddr + - description: 内网访问端口 + in: query + items: + format: int64 + type: integer + name: private_connect_port + type: array + x-go-name: PrivateConnectPort + - description: 公网DNS + in: query + items: + type: string + name: public_dns + type: array + x-go-name: PublicDNS + - description: 公网IP地址 + in: query + items: + type: string + name: public_ip_addr + type: array + x-go-name: PublicIpAddr + - description: 外网访问端口 + in: query + items: + format: int64 + type: integer + name: public_connect_port + type: array + x-go-name: PublicConnectPort + - description: 访问密码？ on （开启密码）|off （免密码访问） + in: query + items: + type: string + name: auth_mode + type: array + x-go-name: AuthMode + - description: 通过安全组Id过滤缓存实例 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + responses: + "200": + $ref: '#/responses/elasticcache_ListItemFilterOutput' + summary: 列出弹性缓存（redis等） + tags: + - elasticcache + post: + description: 新建 + operationId: elasticcache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticcache: + $ref: '#/definitions/ElasticcacheCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache + /elasticcaches/{id}: + delete: + description: 删除 + operationId: elasticcache_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache + get: + description: 获取详情 + operationId: elasticcache_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache + put: + description: 更新 + operationId: elasticcache_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache + /elasticcaches/{id}/add-secgroup: + post: + description: 执行操作AddSecgroup + operationId: elasticcache_PerformAddSecgroup + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheSecgroupsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformAddSecgroupOutput' + summary: 执行操作AddSecgroup + tags: + - elasticcache + /elasticcaches/{id}/allocate-public-connection: + post: + description: 执行操作AllocatePublicConnection + operationId: elasticcache_PerformAllocatePublicConnection + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformAllocatePublicConnectionOutput' + summary: 执行操作AllocatePublicConnection + tags: + - elasticcache + /elasticcaches/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: elasticcache_PerformCancelDelete + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - elasticcache + /elasticcaches/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: elasticcache_PerformCancelExpire + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformCancelExpireOutput' + summary: 执行操作CancelExpire + tags: + - elasticcache + /elasticcaches/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: elasticcache_PerformChangeOwner + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - elasticcache + /elasticcaches/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: elasticcache_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - elasticcache + /elasticcaches/{id}/change-spec: + post: + description: 执行操作ChangeSpec + operationId: elasticcache_PerformChangeSpec + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformChangeSpecOutput' + summary: 执行操作ChangeSpec + tags: + - elasticcache + /elasticcaches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache + post: + description: 执行操作ClassMetadata + operationId: elasticcache_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache + /elasticcaches/{id}/flush-instance: + post: + description: 执行操作FlushInstance + operationId: elasticcache_PerformFlushInstance + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformFlushInstanceOutput' + summary: 执行操作FlushInstance + tags: + - elasticcache + /elasticcaches/{id}/freeze: + post: + description: 执行操作Freeze + operationId: elasticcache_PerformFreeze + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - elasticcache + /elasticcaches/{id}/login-info: + get: + description: 获取指定信息LoginInfo + operationId: elasticcache_GetDetailsLoginInfo + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsLoginInfoOutput' + summary: 获取指定信息LoginInfo + tags: + - elasticcache + /elasticcaches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_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 elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache + /elasticcaches/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: elasticcache_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - elasticcache + /elasticcaches/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: elasticcache_PerformPostpaidExpire + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformPostpaidExpireOutput' + summary: 执行操作PostpaidExpire + tags: + - elasticcache + /elasticcaches/{id}/release-public-connection: + post: + description: 执行操作ReleasePublicConnection + operationId: elasticcache_PerformReleasePublicConnection + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformReleasePublicConnectionOutput' + summary: 执行操作ReleasePublicConnection + tags: + - elasticcache + /elasticcaches/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: elasticcache_PerformRemoteUpdate + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - elasticcache + /elasticcaches/{id}/renew: + post: + description: 执行操作Renew + operationId: elasticcache_PerformRenew + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformRenewOutput' + summary: 执行操作Renew + tags: + - elasticcache + /elasticcaches/{id}/reset-password: + post: + description: 执行操作ResetPassword + operationId: elasticcache_PerformResetPassword + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformResetPasswordOutput' + summary: 执行操作ResetPassword + tags: + - elasticcache + /elasticcaches/{id}/restart: + post: + description: 执行操作Restart + operationId: elasticcache_PerformRestart + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformRestartOutput' + summary: 执行操作Restart + tags: + - elasticcache + /elasticcaches/{id}/revoke-secgroup: + post: + description: 执行操作RevokeSecgroup + operationId: elasticcache_PerformRevokeSecgroup + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheSecgroupsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformRevokeSecgroupOutput' + summary: 执行操作RevokeSecgroup + tags: + - elasticcache + /elasticcaches/{id}/set-auto-renew: + post: + description: |- + 要求实例状态为running + 要求实例计费类型为包年包月(预付费) + operationId: elasticcache_PerformSetAutoRenew + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/GuestAutoRenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetAutoRenewOutput' + summary: 设置自动续费 + tags: + - elasticcache + /elasticcaches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache + /elasticcaches/{id}/set-maintain-time: + post: + description: 执行操作SetMaintainTime + operationId: elasticcache_PerformSetMaintainTime + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetMaintainTimeOutput' + summary: 执行操作SetMaintainTime + tags: + - elasticcache + /elasticcaches/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: elasticcache_PerformSetOrgMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache + /elasticcaches/{id}/set-secgroup: + post: + description: 执行操作SetSecgroup + operationId: elasticcache_PerformSetSecgroup + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheSecgroupsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetSecgroupOutput' + summary: 执行操作SetSecgroup + tags: + - elasticcache + /elasticcaches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache + /elasticcaches/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache + post: + description: 执行操作Status + operationId: elasticcache_PerformStatus + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache + /elasticcaches/{id}/sync: + post: + description: 执行操作Sync + operationId: elasticcache_PerformSync + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformSyncOutput' + summary: 执行操作Sync + tags: + - elasticcache + /elasticcaches/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: elasticcache_PerformSyncstatus + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSyncstatusOutput' + summary: 同步弹性缓存状态 + tags: + - elasticcache + /elasticcaches/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: elasticcache_PerformUnfreeze + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - elasticcache + /elasticcaches/{id}/update-auth-mode: + post: + description: 执行操作UpdateAuthMode + operationId: elasticcache_PerformUpdateAuthMode + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformUpdateAuthModeOutput' + summary: 执行操作UpdateAuthMode + tags: + - elasticcache + /elasticcaches/{id}/update-backup-policy: + post: + description: 执行操作UpdateBackupPolicy + operationId: elasticcache_PerformUpdateBackupPolicy + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformUpdateBackupPolicyOutput' + summary: 执行操作UpdateBackupPolicy + tags: + - elasticcache + /elasticcaches/{id}/update-instance-parameters: + post: + description: 执行操作UpdateInstanceParameters + operationId: elasticcache_PerformUpdateInstanceParameters + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformUpdateInstanceParametersOutput' + summary: 执行操作UpdateInstanceParameters + tags: + - elasticcache + /elasticcaches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache + /elasticcaches/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: elasticcache_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - elasticcache + /elasticcaches/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: elasticcache_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - elasticcache + /elasticcaches/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: elasticcache_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - elasticcache + /elasticcaches/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: elasticcache_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - elasticcache + /elasticcaches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache + /elasticcaches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache + /elasticcaches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_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/elasticcache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache + /elasticcaches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticcache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticcache + /elasticcaches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache + /elasticcaches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache + /elasticcachesecgroups: + get: + description: 列表 + operationId: elasticcachesecgroup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_ListItemFilterOutput' + summary: 列表 + tags: + - elasticcachesecgroup + post: + description: 新建 + operationId: elasticcachesecgroup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticcachesecgroup: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcachesecgroup + /elasticcachesecgroups/{id}: + delete: + description: 删除 + operationId: elasticcachesecgroup_CustomizeDelete + parameters: + - description: The Id or Name of elasticcachesecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcachesecgroup + get: + description: 获取详情 + operationId: elasticcachesecgroup_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcachesecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcachesecgroup + put: + description: 更新 + operationId: elasticcachesecgroup_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcachesecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcacheJointBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcachesecgroup + /elasticcachesecgroups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcachesecgroup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcachesecgroup + /elasticcachesecgroups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcachesecgroup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcachesecgroup + /elasticcachesecgroups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcachesecgroup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcachesecgroup + /elasticcachesecgroups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcachesecgroup_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/elasticcachesecgroup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcachesecgroup + /elasticips: + get: + description: 列表 + operationId: elasticip_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: |- + filter usable eip for given associate type + enmu: server, natgateway + in: query + name: usable_eip_for_associate_type + type: string + x-go-name: UsableEipForAssociateType + - description: filter usable eip for given associate id + in: query + name: usable_eip_for_associate_id + type: string + x-go-name: UsableEipForAssociateId + - description: |- + 标识弹性或非弹性 + Mode | 说明 | + ------------|------------| + public_ip | 公网IP | + elastic_ip | 弹性公公网网IP | + example: elastic_ip + in: query + name: mode + type: string + x-go-name: Mode + - description: IP地址 + in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + - description: 绑定资源类型 + in: query + name: associate_type + type: string + x-go-name: AssociateType + - description: 绑定资源Id + in: query + name: associate_id + type: string + x-go-name: AssociateId + - description: '计费类型: 流量、带宽' + example: bandwidth + in: query + items: + type: string + name: charge_type + type: array + x-go-name: ChargeType + - description: 目前只有华为云此字段是必需填写的 + in: query + items: + type: string + name: bgp_type + type: array + x-go-name: BgpType + - description: 是否跟随主机删除而自动释放 + in: query + name: auto_dellocate + type: boolean + x-go-name: AutoDellocate + - description: 按ip地址排序 + in: query + name: order_by_ip + pattern: asc|desc + type: string + x-go-name: OrderByIp + responses: + "200": + $ref: '#/responses/elasticip_ListItemFilterOutput' + summary: 弹性公网IP列表 + tags: + - elasticip + post: + description: 新建 + operationId: elasticip_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticip: + $ref: '#/definitions/SElasticipCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticip + /elasticips/{id}: + delete: + description: 删除 + operationId: elasticip_CustomizeDelete + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticip + get: + description: 获取详情 + operationId: elasticip_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticip + put: + description: 更新 + operationId: elasticip_ValidateUpdateData + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticip + /elasticips/{id}/associate: + post: + description: 执行操作Associate + operationId: elasticip_PerformAssociate + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipAssociateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformAssociateOutput' + summary: 执行操作Associate + tags: + - elasticip + /elasticips/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: elasticip_PerformCancelDelete + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - elasticip + /elasticips/{id}/change-bandwidth: + post: + description: 执行操作ChangeBandwidth + operationId: elasticip_PerformChangeBandwidth + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_PerformChangeBandwidthOutput' + summary: 执行操作ChangeBandwidth + tags: + - elasticip + /elasticips/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: elasticip_PerformChangeOwner + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - elasticip + /elasticips/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: elasticip_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - elasticip + /elasticips/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticip_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticip + post: + description: 执行操作ClassMetadata + operationId: elasticip_PerformClassMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticip + /elasticips/{id}/dissociate: + post: + description: 执行操作Dissociate + operationId: elasticip_PerformDissociate + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticDissociateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformDissociateOutput' + summary: 执行操作Dissociate + tags: + - elasticip + /elasticips/{id}/freeze: + post: + description: 执行操作Freeze + operationId: elasticip_PerformFreeze + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - elasticip + /elasticips/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticip_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 elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticip + /elasticips/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: elasticip_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - elasticip + /elasticips/{id}/purge: + post: + description: 执行操作Purge + operationId: elasticip_PerformPurge + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - elasticip + /elasticips/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: elasticip_PerformRemoteUpdate + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - elasticip + /elasticips/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticip_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticip + /elasticips/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: elasticip_PerformSetOrgMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticip + /elasticips/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticip_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticip + /elasticips/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticip_GetDetailsStatus + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticip + post: + description: 执行操作Status + operationId: elasticip_PerformStatus + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticip + /elasticips/{id}/sync: + post: + description: 执行操作Sync + operationId: elasticip_PerformSync + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_PerformSyncOutput' + summary: 执行操作Sync + tags: + - elasticip + /elasticips/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: elasticip_PerformSyncstatus + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformSyncstatusOutput' + summary: 同步弹性公网IP状态 + tags: + - elasticip + /elasticips/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: elasticip_PerformUnfreeze + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - elasticip + /elasticips/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticip_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticip + /elasticips/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: elasticip_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - elasticip + /elasticips/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: elasticip_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - elasticip + /elasticips/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: elasticip_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - elasticip + /elasticips/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: elasticip_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - elasticip + /elasticips/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticip_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticip + /elasticips/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticip_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticip_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticip + /elasticips/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticip_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/elasticip_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticip + /elasticips/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticip_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticip + /elasticips/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticip_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticip + /elasticips/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticip_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticip + /external_projects: + get: + description: 列表 + operationId: external_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: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/external_project_ListItemFilterOutput' + summary: 云平台导入项目列表 + tags: + - external_project + post: + description: 新建 + operationId: external_project_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + external_project: + $ref: '#/definitions/ExternalProjectCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_ValidateCreateDataOutput' + summary: 新建 + tags: + - external_project + /external_projects/{id}: + delete: + description: 删除 + operationId: external_project_CustomizeDelete + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_CustomizeDeleteOutput' + summary: 删除 + tags: + - external_project + get: + description: 获取详情 + operationId: external_project_FetchCustomizeColumns + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - external_project + put: + description: 更新 + operationId: external_project_ValidateUpdateData + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_ValidateUpdateDataOutput' + summary: 更新 + tags: + - external_project + /external_projects/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: external_project_PerformCancelDelete + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - external_project + /external_projects/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: external_project_PerformChangeOwner + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - external_project + /external_projects/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: external_project_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - external_project + /external_projects/{id}/change-project: + post: + description: 执行操作ChangeProject + operationId: external_project_PerformChangeProject + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectChangeProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformChangeProjectOutput' + summary: 切换本地项目 + tags: + - external_project + /external_projects/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: external_project_GetDetailsClassMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - external_project + post: + description: 执行操作ClassMetadata + operationId: external_project_PerformClassMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - external_project + /external_projects/{id}/freeze: + post: + description: 执行操作Freeze + operationId: external_project_PerformFreeze + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - external_project + /external_projects/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: external_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 external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - external_project + /external_projects/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: external_project_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - external_project + /external_projects/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: external_project_PerformSetClassMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - external_project + /external_projects/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: external_project_PerformSetOrgMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - external_project + /external_projects/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: external_project_PerformSetUserMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - external_project + /external_projects/{id}/status: + get: + description: 获取指定信息Status + operationId: external_project_GetDetailsStatus + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - external_project + post: + description: 执行操作Status + operationId: external_project_PerformStatus + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformStatusOutput' + summary: 更新资源状态 + tags: + - external_project + /external_projects/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: external_project_PerformUnfreeze + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - external_project + /external_projects/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: external_project_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/external_project_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - external_project + /external_projects/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: external_project_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/external_project_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - external_project + /external_projects/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: external_project_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/external_project_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - external_project + /external_projects/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: external_project_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/external_project_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - external_project + /external_projects/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: external_project_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/external_project_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - external_project + /external_projects/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: external_project_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - external_project + /external_projects/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: external_project_GetPropertySplitable + responses: + "200": + $ref: '#/responses/external_project_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - external_project + /external_projects/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: external_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/external_project_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - external_project + /external_projects/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: external_project_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/external_project_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - external_project + /external_projects/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: external_project_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/external_project_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - external_project + /external_projects/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: external_project_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/external_project_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - external_project + /file_systems: + get: + description: 列表 + operationId: file_system_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/file_system_ListItemFilterOutput' + summary: 列表 + tags: + - file_system + post: + description: 新建 + operationId: file_system_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + file_system: + $ref: '#/definitions/FileSystemCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_ValidateCreateDataOutput' + summary: 新建 + tags: + - file_system + /file_systems/{id}: + delete: + description: 删除 + operationId: file_system_CustomizeDelete + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_CustomizeDeleteOutput' + summary: 删除 + tags: + - file_system + get: + description: 获取详情 + operationId: file_system_FetchCustomizeColumns + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - file_system + put: + description: 更新 + operationId: file_system_ValidateUpdateData + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_ValidateUpdateDataOutput' + summary: 更新 + tags: + - file_system + /file_systems/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: file_system_PerformCancelDelete + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - file_system + /file_systems/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: file_system_PerformChangeOwner + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - file_system + /file_systems/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: file_system_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - file_system + /file_systems/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: file_system_GetDetailsClassMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - file_system + post: + description: 执行操作ClassMetadata + operationId: file_system_PerformClassMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - file_system + /file_systems/{id}/freeze: + post: + description: 执行操作Freeze + operationId: file_system_PerformFreeze + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - file_system + /file_systems/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: file_system_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 file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - file_system + /file_systems/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: file_system_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - file_system + /file_systems/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: file_system_PerformRemoteUpdate + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - file_system + /file_systems/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: file_system_PerformSetClassMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - file_system + /file_systems/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: file_system_PerformSetOrgMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - file_system + /file_systems/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: file_system_PerformSetUserMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - file_system + /file_systems/{id}/status: + get: + description: 获取指定信息Status + operationId: file_system_GetDetailsStatus + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - file_system + post: + description: 执行操作Status + operationId: file_system_PerformStatus + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformStatusOutput' + summary: 更新资源状态 + tags: + - file_system + /file_systems/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: file_system_PerformSyncstatus + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformSyncstatusOutput' + summary: 同步NAS状态 + tags: + - file_system + /file_systems/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: file_system_PerformUnfreeze + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - file_system + /file_systems/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: file_system_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/file_system_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - file_system + /file_systems/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: file_system_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/file_system_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - file_system + /file_systems/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: file_system_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/file_system_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - file_system + /file_systems/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: file_system_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/file_system_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - file_system + /file_systems/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: file_system_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/file_system_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - file_system + /file_systems/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: file_system_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - file_system + /file_systems/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: file_system_GetPropertySplitable + responses: + "200": + $ref: '#/responses/file_system_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - file_system + /file_systems/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: file_system_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/file_system_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - file_system + /file_systems/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: file_system_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/file_system_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - file_system + /file_systems/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: file_system_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/file_system_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - file_system + /file_systems/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: file_system_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/file_system_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - file_system + /global_vpcs: + get: + description: 列表 + operationId: global_vpc_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以关联的vpc数量排序 + in: query + name: order_by_vpc_count + pattern: asc|desc + type: string + x-go-name: OrderByVpcCount + responses: + "200": + $ref: '#/responses/global_vpc_ListItemFilterOutput' + summary: 全局VPC列表 + tags: + - global_vpc + post: + description: 新建 + operationId: global_vpc_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + global_vpc: + $ref: '#/definitions/GlobalVpcCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_ValidateCreateDataOutput' + summary: 新建 + tags: + - global_vpc + /global_vpcs/{id}: + delete: + description: 删除 + operationId: global_vpc_CustomizeDelete + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_CustomizeDeleteOutput' + summary: 删除 + tags: + - global_vpc + get: + description: 获取详情 + operationId: global_vpc_FetchCustomizeColumns + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - global_vpc + put: + description: 更新 + operationId: global_vpc_ValidateUpdateData + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalvpcUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_ValidateUpdateDataOutput' + summary: 更新 + tags: + - global_vpc + /global_vpcs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: global_vpc_PerformChangeOwner + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - global_vpc + /global_vpcs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: global_vpc_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - global_vpc + /global_vpcs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: global_vpc_GetDetailsClassMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - global_vpc + post: + description: 执行操作ClassMetadata + operationId: global_vpc_PerformClassMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - global_vpc + /global_vpcs/{id}/disable: + post: + description: 执行操作Disable + operationId: global_vpc_PerformDisable + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformDisableOutput' + summary: 禁用资源 + tags: + - global_vpc + /global_vpcs/{id}/enable: + post: + description: 执行操作Enable + operationId: global_vpc_PerformEnable + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformEnableOutput' + summary: 启用资源 + tags: + - global_vpc + /global_vpcs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: global_vpc_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 global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - global_vpc + /global_vpcs/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: global_vpc_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - global_vpc + /global_vpcs/{id}/private: + post: + description: 执行操作Private + operationId: global_vpc_PerformPrivate + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformPrivateOutput' + summary: 执行操作Private + tags: + - global_vpc + /global_vpcs/{id}/public: + post: + description: 执行操作Public + operationId: global_vpc_PerformPublic + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformPublicOutput' + summary: 执行操作Public + tags: + - global_vpc + /global_vpcs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: global_vpc_PerformSetClassMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - global_vpc + /global_vpcs/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: global_vpc_PerformSetOrgMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - global_vpc + /global_vpcs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: global_vpc_PerformSetUserMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - global_vpc + /global_vpcs/{id}/status: + get: + description: 获取指定信息Status + operationId: global_vpc_GetDetailsStatus + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - global_vpc + post: + description: 执行操作Status + operationId: global_vpc_PerformStatus + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformStatusOutput' + summary: 更新资源状态 + tags: + - global_vpc + /global_vpcs/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: global_vpc_PerformSyncstatus + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/SyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformSyncstatusOutput' + summary: 同步全局VPC状态 + tags: + - global_vpc + /global_vpcs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: global_vpc_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - global_vpc + /global_vpcs/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: global_vpc_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - global_vpc + /global_vpcs/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: global_vpc_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - global_vpc + /global_vpcs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: global_vpc_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - global_vpc + /global_vpcs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: global_vpc_GetPropertySplitable + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - global_vpc + /global_vpcs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: global_vpc_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/global_vpc_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - global_vpc + /global_vpcs/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: global_vpc_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - global_vpc + /global_vpcs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: global_vpc_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - global_vpc + /global_vpcs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: global_vpc_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - global_vpc + /groupguests: + get: + description: 列表 + operationId: groupguest_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 实例组（ID或Name） + in: query + name: group_id + type: string + x-go-name: GroupId + - description: 按组名排序 + in: query + name: order_by_group + type: string + x-go-name: OrderByGroup + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 标签 + in: query + items: + type: string + name: tag + type: array + x-go-name: Tag + responses: + "200": + $ref: '#/responses/groupguest_ListItemFilterOutput' + summary: 列表 + tags: + - groupguest + post: + description: 新建 + operationId: groupguest_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + groupguest: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupguest_ValidateCreateDataOutput' + summary: 新建 + tags: + - groupguest + /groupguests/{id}: + delete: + description: 删除 + operationId: groupguest_CustomizeDelete + parameters: + - description: The Id or Name of groupguest + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/groupguest_CustomizeDeleteOutput' + summary: 删除 + tags: + - groupguest + get: + description: 获取详情 + operationId: groupguest_FetchCustomizeColumns + parameters: + - description: The Id or Name of groupguest + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/groupguest_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - groupguest + put: + description: 更新 + operationId: groupguest_ValidateUpdateData + parameters: + - description: The Id or Name of groupguest + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + groupguest: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupguest_ValidateUpdateDataOutput' + summary: 更新 + tags: + - groupguest + /groupguests/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: groupguest_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/groupguest_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - groupguest + /groupguests/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: groupguest_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + groupguest: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupguest_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - groupguest + /groupguests/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: groupguest_GetPropertySplitable + responses: + "200": + $ref: '#/responses/groupguest_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - groupguest + /groupguests/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: groupguest_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/groupguest_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - groupguest + /groupnetworks: + get: + description: 列表 + operationId: groupnetwork_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 实例组（ID或Name） + in: query + name: group_id + type: string + x-go-name: GroupId + - description: 按组名排序 + in: query + name: order_by_group + type: string + x-go-name: OrderByGroup + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: IP地址 + in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + - description: IPv6地址 + in: query + items: + type: string + name: ip6_addr + type: array + x-go-name: Ip6Addr + responses: + "200": + $ref: '#/responses/groupnetwork_ListItemFilterOutput' + summary: 列表 + tags: + - groupnetwork + post: + description: 新建 + operationId: groupnetwork_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + groupnetwork: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupnetwork_ValidateCreateDataOutput' + summary: 新建 + tags: + - groupnetwork + /groupnetworks/{id}: + delete: + description: 删除 + operationId: groupnetwork_CustomizeDelete + parameters: + - description: The Id or Name of groupnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/groupnetwork_CustomizeDeleteOutput' + summary: 删除 + tags: + - groupnetwork + get: + description: 获取详情 + operationId: groupnetwork_FetchCustomizeColumns + parameters: + - description: The Id or Name of groupnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/groupnetwork_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - groupnetwork + put: + description: 更新 + operationId: groupnetwork_ValidateUpdateData + parameters: + - description: The Id or Name of groupnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + groupnetwork: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupnetwork_ValidateUpdateDataOutput' + summary: 更新 + tags: + - groupnetwork + /groupnetworks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: groupnetwork_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/groupnetwork_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - groupnetwork + /groupnetworks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: groupnetwork_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + groupnetwork: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupnetwork_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - groupnetwork + /groupnetworks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: groupnetwork_GetPropertySplitable + responses: + "200": + $ref: '#/responses/groupnetwork_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - groupnetwork + /groupnetworks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: groupnetwork_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/groupnetwork_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - groupnetwork + /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: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 以service_type过滤列表结果 + in: query + name: service_type + type: string + x-go-name: ServiceType + - description: 以parent_id过滤列表结果 + in: query + name: parent_id + type: string + x-go-name: ParentId + - description: 调度策略 + in: query + name: sched_strategy + type: string + x-go-name: SchedStrategy + - description: 按ip地址排序 + in: query + name: order_by_vips + pattern: asc|desc + type: string + x-go-name: OrderByVips + - description: 按关联的虚拟机数量排序 + in: query + name: order_by_guest_count + pattern: asc|desc + type: string + x-go-name: OrderByGuestCount + 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/VirtualResourceCreateInput' + 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/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - group + /groups/{id}/associate-eip: + post: + description: 执行操作AssociateEip + operationId: group_PerformAssociateEip + 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/ServerAssociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformAssociateEipOutput' + summary: 执行操作AssociateEip + tags: + - group + /groups/{id}/attachnetwork: + post: + description: 执行操作Attachnetwork + operationId: group_PerformAttachnetwork + 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/GroupAttachNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformAttachnetworkOutput' + summary: 执行操作Attachnetwork + tags: + - group + /groups/{id}/bind-guests: + post: + description: 执行操作BindGuests + operationId: group_PerformBindGuests + 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_PerformBindGuestsOutput' + summary: 执行操作BindGuests + tags: + - group + /groups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: group_PerformCancelDelete + 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_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - group + /groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: group_PerformChangeOwner + 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/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - group + /groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: group_GetDetailsChangeOwnerCandidateDomains + 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_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + 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}/create-eip: + post: + description: 执行操作CreateEip + operationId: group_PerformCreateEip + 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/ServerCreateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformCreateEipOutput' + summary: 执行操作CreateEip + tags: + - group + /groups/{id}/detachnetwork: + post: + description: 执行操作Detachnetwork + operationId: group_PerformDetachnetwork + 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/GroupDetachNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformDetachnetworkOutput' + summary: 执行操作Detachnetwork + tags: + - group + /groups/{id}/disable: + post: + description: 执行操作Disable + operationId: group_PerformDisable + 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/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformDisableOutput' + summary: 执行操作Disable + tags: + - group + /groups/{id}/dissociate-eip: + post: + description: 执行操作DissociateEip + operationId: group_PerformDissociateEip + 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/ServerDissociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformDissociateEipOutput' + summary: 执行操作DissociateEip + tags: + - group + /groups/{id}/enable: + post: + description: 执行操作Enable + operationId: group_PerformEnable + 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/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformEnableOutput' + summary: 执行操作Enable + tags: + - group + /groups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: group_PerformFreeze + 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/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: group_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: group_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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/{id}/status: + get: + description: 获取指定信息Status + operationId: group_GetDetailsStatus + 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_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - group + post: + description: 执行操作Status + operationId: group_PerformStatus + 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/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - group + /groups/{id}/unbind-guests: + post: + description: 执行操作UnbindGuests + operationId: group_PerformUnbindGuests + 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_PerformUnbindGuestsOutput' + summary: 执行操作UnbindGuests + tags: + - group + /groups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: group_PerformUnfreeze + 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/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - group + /groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - group + /groups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: group_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/group_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - group + /groups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: group_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/group_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - group + /groups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: group_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/group_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - group + /groups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: group_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/group_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + 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/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + 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 + /guest_templates: + get: + description: 列表 + operationId: guest_template_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: billing_type + type: string + x-go-name: BillingType + - in: query + name: brand + type: string + x-go-name: Brand + responses: + "200": + $ref: '#/responses/guest_template_ListItemFilterOutput' + summary: 主机模板列表 + tags: + - guest_template + post: + description: 新建 + operationId: guest_template_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guest_template: + $ref: '#/definitions/GuestTemplateCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_ValidateCreateDataOutput' + summary: 新建 + tags: + - guest_template + /guest_templates/{id}: + delete: + description: 删除 + operationId: guest_template_CustomizeDelete + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_CustomizeDeleteOutput' + summary: 删除 + tags: + - guest_template + get: + description: 获取详情 + operationId: guest_template_FetchCustomizeColumns + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guest_template + put: + description: 更新 + operationId: guest_template_ValidateUpdateData + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guest_template + /guest_templates/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: guest_template_PerformCancelDelete + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - guest_template + /guest_templates/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: guest_template_PerformChangeOwner + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - guest_template + /guest_templates/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: guest_template_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - guest_template + /guest_templates/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: guest_template_GetDetailsClassMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - guest_template + post: + description: 执行操作ClassMetadata + operationId: guest_template_PerformClassMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - guest_template + /guest_templates/{id}/freeze: + post: + description: 执行操作Freeze + operationId: guest_template_PerformFreeze + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - guest_template + /guest_templates/{id}/inspect: + post: + description: 执行操作Inspect + operationId: guest_template_PerformInspect + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_PerformInspectOutput' + summary: 执行操作Inspect + tags: + - guest_template + /guest_templates/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: guest_template_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 guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - guest_template + /guest_templates/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: guest_template_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - guest_template + /guest_templates/{id}/private: + post: + description: 执行操作Private + operationId: guest_template_PerformPrivate + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformPrivateOutput' + summary: 执行操作Private + tags: + - guest_template + /guest_templates/{id}/public: + post: + description: 执行操作Public + operationId: guest_template_PerformPublic + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformPublicOutput' + summary: 执行操作Public + tags: + - guest_template + /guest_templates/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: guest_template_PerformSetClassMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - guest_template + /guest_templates/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: guest_template_PerformSetOrgMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - guest_template + /guest_templates/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: guest_template_PerformSetUserMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - guest_template + /guest_templates/{id}/status: + get: + description: 获取指定信息Status + operationId: guest_template_GetDetailsStatus + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - guest_template + post: + description: 执行操作Status + operationId: guest_template_PerformStatus + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformStatusOutput' + summary: 更新资源状态 + tags: + - guest_template + /guest_templates/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: guest_template_PerformUnfreeze + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - guest_template + /guest_templates/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guest_template_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guest_template + /guest_templates/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: guest_template_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - guest_template + /guest_templates/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: guest_template_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - guest_template + /guest_templates/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: guest_template_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - guest_template + /guest_templates/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: guest_template_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - guest_template + /guest_templates/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guest_template_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guest_template + /guest_templates/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guest_template_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guest_template_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guest_template + /guest_templates/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guest_template_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/guest_template_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guest_template + /guest_templates/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: guest_template_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - guest_template + /guest_templates/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: guest_template_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - guest_template + /guest_templates/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: guest_template_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - guest_template + /guestdisks: + get: + description: 列表 + operationId: guestdisk_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: 以存储名称排序 + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 虚拟磁盘（ID或Name） + in: query + name: disk_id + type: string + x-go-name: DiskId + - description: 以磁盘名称排序 + in: query + name: order_by_disk + pattern: asc|desc + type: string + x-go-name: OrderByDisk + - in: query + items: + type: string + name: driver + type: array + x-go-name: Driver + - in: query + items: + type: string + name: cache_mode + type: array + x-go-name: CacheMode + - in: query + items: + type: string + name: aio_mode + type: array + x-go-name: AioMode + responses: + "200": + $ref: '#/responses/guestdisk_ListItemFilterOutput' + summary: 列表 + tags: + - guestdisk + post: + description: 新建 + operationId: guestdisk_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guestdisk: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestdisk_ValidateCreateDataOutput' + summary: 新建 + tags: + - guestdisk + /guestdisks/{id}: + delete: + description: 删除 + operationId: guestdisk_CustomizeDelete + parameters: + - description: The Id or Name of guestdisk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestdisk_CustomizeDeleteOutput' + summary: 删除 + tags: + - guestdisk + get: + description: 获取详情 + operationId: guestdisk_FetchCustomizeColumns + parameters: + - description: The Id or Name of guestdisk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestdisk_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guestdisk + put: + description: 更新 + operationId: guestdisk_ValidateUpdateData + parameters: + - description: The Id or Name of guestdisk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestdiskUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestdisk_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guestdisk + /guestdisks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guestdisk_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guestdisk_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guestdisk + /guestdisks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guestdisk_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guestdisk: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestdisk_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guestdisk + /guestdisks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guestdisk_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guestdisk_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guestdisk + /guestdisks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guestdisk_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/guestdisk_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guestdisk + /guestnetworks: + get: + description: 列表 + operationId: guestnetwork_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - in: query + items: + type: string + name: mac_addr + type: array + x-go-name: MacAddr + - in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + - in: query + items: + type: string + name: ip6_addr + type: array + x-go-name: Ip6Addr + - in: query + items: + type: string + name: driver + type: array + x-go-name: Driver + - in: query + items: + type: string + name: ifname + type: array + x-go-name: Ifname + - in: query + items: + type: string + name: team_with + type: array + x-go-name: TeamWith + responses: + "200": + $ref: '#/responses/guestnetwork_ListItemFilterOutput' + summary: 列表 + tags: + - guestnetwork + post: + description: 新建 + operationId: guestnetwork_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guestnetwork: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestnetwork_ValidateCreateDataOutput' + summary: 新建 + tags: + - guestnetwork + /guestnetworks/{id}: + delete: + description: 删除 + operationId: guestnetwork_CustomizeDelete + parameters: + - description: The Id or Name of guestnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestnetwork_CustomizeDeleteOutput' + summary: 删除 + tags: + - guestnetwork + get: + description: 获取详情 + operationId: guestnetwork_FetchCustomizeColumns + parameters: + - description: The Id or Name of guestnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestnetwork_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guestnetwork + put: + description: 更新 + operationId: guestnetwork_ValidateUpdateData + parameters: + - description: The Id or Name of guestnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestnetwork_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guestnetwork + /guestnetworks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guestnetwork_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guestnetwork_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guestnetwork + /guestnetworks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guestnetwork_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guestnetwork: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestnetwork_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guestnetwork + /guestnetworks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guestnetwork_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guestnetwork_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guestnetwork + /guestnetworks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guestnetwork_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/guestnetwork_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guestnetwork + /guestsecgroups: + get: + description: 列表 + operationId: guestsecgroup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + responses: + "200": + $ref: '#/responses/guestsecgroup_ListItemFilterOutput' + summary: 列表 + tags: + - guestsecgroup + post: + description: 新建 + operationId: guestsecgroup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guestsecgroup: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestsecgroup_ValidateCreateDataOutput' + summary: 新建 + tags: + - guestsecgroup + /guestsecgroups/{id}: + delete: + description: 删除 + operationId: guestsecgroup_CustomizeDelete + parameters: + - description: The Id or Name of guestsecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestsecgroup_CustomizeDeleteOutput' + summary: 删除 + tags: + - guestsecgroup + get: + description: 获取详情 + operationId: guestsecgroup_FetchCustomizeColumns + parameters: + - description: The Id or Name of guestsecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestsecgroup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guestsecgroup + put: + description: 更新 + operationId: guestsecgroup_ValidateUpdateData + parameters: + - description: The Id or Name of guestsecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestJointBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestsecgroup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guestsecgroup + /guestsecgroups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guestsecgroup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guestsecgroup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guestsecgroup + /guestsecgroups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guestsecgroup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guestsecgroup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestsecgroup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guestsecgroup + /guestsecgroups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guestsecgroup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guestsecgroup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guestsecgroup + /guestsecgroups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guestsecgroup_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/guestsecgroup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guestsecgroup + /host_backupstorages: + get: + description: 列表 + operationId: host_backupstorage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 备份存储（ID或Name） + in: query + name: backupstorage_id + type: string + x-go-name: BackupstorageId + - description: 以备份存储名称排序 + in: query + name: order_by_backupstorage + pattern: asc|desc + type: string + x-go-name: OrderByBackupstorage + responses: + "200": + $ref: '#/responses/host_backupstorage_ListItemFilterOutput' + summary: 列表 + tags: + - host_backupstorage + post: + description: 新建 + operationId: host_backupstorage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + host_backupstorage: + $ref: '#/definitions/HostBackupstorageCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_backupstorage_ValidateCreateDataOutput' + summary: 新建 + tags: + - host_backupstorage + /host_backupstorages/{id}: + delete: + description: 删除 + operationId: host_backupstorage_CustomizeDelete + parameters: + - description: The Id or Name of host_backupstorage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_backupstorage_CustomizeDeleteOutput' + summary: 删除 + tags: + - host_backupstorage + get: + description: 获取详情 + operationId: host_backupstorage_FetchCustomizeColumns + parameters: + - description: The Id or Name of host_backupstorage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_backupstorage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - host_backupstorage + put: + description: 更新 + operationId: host_backupstorage_ValidateUpdateData + parameters: + - description: The Id or Name of host_backupstorage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host_backupstorage: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_backupstorage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - host_backupstorage + /host_backupstorages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: host_backupstorage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/host_backupstorage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - host_backupstorage + /host_backupstorages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: host_backupstorage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + host_backupstorage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_backupstorage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - host_backupstorage + /host_backupstorages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: host_backupstorage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/host_backupstorage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - host_backupstorage + /host_backupstorages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: host_backupstorage_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/host_backupstorage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - host_backupstorage + /host_isolated_device_models: + get: + description: 列表 + operationId: host_isolated_device_model_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + responses: + "200": + $ref: '#/responses/host_isolated_device_model_ListItemFilterOutput' + summary: 列表 + tags: + - host_isolated_device_model + post: + description: 新建 + operationId: host_isolated_device_model_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + host_isolated_device_model: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_isolated_device_model_ValidateCreateDataOutput' + summary: 新建 + tags: + - host_isolated_device_model + /host_isolated_device_models/{id}: + delete: + description: 删除 + operationId: host_isolated_device_model_CustomizeDelete + parameters: + - description: The Id or Name of host_isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_isolated_device_model_CustomizeDeleteOutput' + summary: 删除 + tags: + - host_isolated_device_model + get: + description: 获取详情 + operationId: host_isolated_device_model_FetchCustomizeColumns + parameters: + - description: The Id or Name of host_isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_isolated_device_model_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - host_isolated_device_model + put: + description: 更新 + operationId: host_isolated_device_model_ValidateUpdateData + parameters: + - description: The Id or Name of host_isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host_isolated_device_model: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_isolated_device_model_ValidateUpdateDataOutput' + summary: 更新 + tags: + - host_isolated_device_model + /host_isolated_device_models/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: host_isolated_device_model_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/host_isolated_device_model_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - host_isolated_device_model + /host_isolated_device_models/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: host_isolated_device_model_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + host_isolated_device_model: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_isolated_device_model_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - host_isolated_device_model + /host_isolated_device_models/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: host_isolated_device_model_GetPropertySplitable + responses: + "200": + $ref: '#/responses/host_isolated_device_model_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - host_isolated_device_model + /host_isolated_device_models/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: host_isolated_device_model_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/host_isolated_device_model_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - host_isolated_device_model + /hostnetworks: + get: + description: 列表 + operationId: hostnetwork_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: IP地址 + in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + - description: MAC地址 + in: query + items: + type: string + name: mac_addr + type: array + x-go-name: MacAddr + responses: + "200": + $ref: '#/responses/hostnetwork_ListItemFilterOutput' + summary: 列表 + tags: + - hostnetwork + post: + description: 新建 + operationId: hostnetwork_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + hostnetwork: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hostnetwork_ValidateCreateDataOutput' + summary: 新建 + tags: + - hostnetwork + /hostnetworks/{id}: + delete: + description: 删除 + operationId: hostnetwork_CustomizeDelete + parameters: + - description: The Id or Name of hostnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hostnetwork_CustomizeDeleteOutput' + summary: 删除 + tags: + - hostnetwork + get: + description: 获取详情 + operationId: hostnetwork_FetchCustomizeColumns + parameters: + - description: The Id or Name of hostnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hostnetwork_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - hostnetwork + put: + description: 更新 + operationId: hostnetwork_ValidateUpdateData + parameters: + - description: The Id or Name of hostnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + hostnetwork: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hostnetwork_ValidateUpdateDataOutput' + summary: 更新 + tags: + - hostnetwork + /hostnetworks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: hostnetwork_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/hostnetwork_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - hostnetwork + /hostnetworks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: hostnetwork_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + hostnetwork: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hostnetwork_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - hostnetwork + /hostnetworks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: hostnetwork_GetPropertySplitable + responses: + "200": + $ref: '#/responses/hostnetwork_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - hostnetwork + /hostnetworks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: hostnetwork_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/hostnetwork_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - hostnetwork + /hosts: + get: + description: 列表 + operationId: host_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: 备份存储（ID或Name） + in: query + name: backupstorage_id + type: string + x-go-name: BackupstorageId + - description: 以备份存储名称排序 + in: query + name: order_by_backupstorage + pattern: asc|desc + type: string + x-go-name: OrderByBackupstorage + - description: filter by ResourceType + in: query + name: resource_type + type: string + x-go-name: ResourceType + - description: filter by mac of any network interface + in: query + name: any_mac + type: string + x-go-name: AnyMac + - description: filter by ip of any network interface + in: query + items: + type: string + name: any_ip + type: array + x-go-name: AnyIp + - description: filter storages not attached to this host + in: query + name: storage_not_attached + type: boolean + x-go-name: StorageNotAttached + - description: filter by Hypervisor + in: query + name: hypervisor + type: string + x-go-name: Hypervisor + - description: filter host that is empty + in: query + name: is_empty + type: boolean + x-go-name: IsEmpty + - description: filter host that is baremetal + in: query + name: baremetal + type: boolean + x-go-name: Baremetal + - description: 机架 + in: query + items: + type: string + name: rack + type: array + x-go-name: Rack + - description: 机位 + in: query + items: + type: string + name: slots + type: array + x-go-name: Slots + - description: 管理口MAC + in: query + items: + type: string + name: access_mac + type: array + x-go-name: AccessMac + - description: 管理口Ip地址 + in: query + items: + type: string + name: access_ip + type: array + x-go-name: AccessIp + - description: 物理机序列号信息 + in: query + items: + type: string + name: sn + type: array + x-go-name: SN + - description: CPU大小 + in: query + items: + format: int64 + type: integer + name: cpu_count + type: array + x-go-name: CpuCount + - description: 内存大小,单位Mb + in: query + items: + format: int64 + type: integer + name: mem_size + type: array + x-go-name: MemSize + - description: 存储类型(磁盘类型，sdd, rotate, hybrid) + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - description: 宿主机绑定存储类型 + in: query + items: + type: string + name: host_storage_type + type: array + x-go-name: HostStorageType + - description: IPMI地址 + in: query + items: + type: string + name: ipmi_ip + type: array + x-go-name: IpmiIp + - description: 宿主机状态 + example: online + in: query + items: + type: string + name: host_status + type: array + x-go-name: HostStatus + - description: 宿主机类型 + in: query + items: + type: string + name: host_type + type: array + x-go-name: HostType + - description: host服务软件版本 + in: query + items: + type: string + name: version + type: array + x-go-name: Version + - description: OVN软件版本 + in: query + items: + type: string + name: ovn_version + type: array + x-go-name: OvnVersion + - description: 是否处于维护状态 + in: query + name: is_maintenance + type: boolean + x-go-name: IsMaintenance + - description: 是否为导入的宿主机 + in: query + name: is_import + type: boolean + x-go-name: IsImport + - description: 是否允许PXE启动 + in: query + name: enable_pxe_boot + type: boolean + x-go-name: EnablePxeBoot + - description: 主机UUID + in: query + items: + type: string + name: uuid + type: array + x-go-name: Uuid + - description: 主机启动模式, 可能值位PXE和ISO + in: query + items: + type: string + name: boot_mode + type: array + x-go-name: BootMode + - description: 虚拟机所在的二层网络 + in: query + name: server_id_for_network + type: string + x-go-name: ServerIdForNetwork + - description: 宿主机 cpu 架构 + in: query + items: + type: string + name: cpu_architecture + type: array + x-go-name: CpuArchitecture + - in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - description: 按虚拟机数量排序 + enum: + - asc + - desc + in: query + name: order_by_server_count + type: string + x-go-name: OrderByServerCount + - description: |- + 按存储大小排序 + enmu: asc,desc + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: |- + 按存储超分率排序 + enmu: asc,desc + in: query + name: order_by_storage_commit_rate + type: string + x-go-name: OrderByStorageCommitRate + - description: |- + 按cpu超分率排序 + enmu: asc,desc + in: query + name: order_by_cpu_commit_rate + type: string + x-go-name: OrderByCpuCommitRate + - description: |- + 按内存超分率排序 + enmu: asc,desc + in: query + name: order_by_mem_commit_rate + type: string + x-go-name: OrderByMemCommitRate + responses: + "200": + $ref: '#/responses/host_ListItemFilterOutput' + summary: 宿主机/物理机列表 + tags: + - host + post: + description: 新建 + operationId: host_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + host: + $ref: '#/definitions/HostCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_ValidateCreateDataOutput' + summary: 新建 + tags: + - host + /hosts/{id}: + delete: + description: 删除 + operationId: host_CustomizeDelete + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_CustomizeDeleteOutput' + summary: 删除 + tags: + - host + get: + description: 获取详情 + operationId: host_FetchCustomizeColumns + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - host + put: + description: 更新 + operationId: host_ValidateUpdateData + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_ValidateUpdateDataOutput' + summary: 更新 + tags: + - host + /hosts/{id}/add-netif: + post: + description: 执行操作AddNetif + operationId: host_PerformAddNetif + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostAddNetifInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformAddNetifOutput' + summary: 执行操作AddNetif + tags: + - host + /hosts/{id}/app-options: + get: + description: 获取指定信息AppOptions + operationId: host_GetDetailsAppOptions + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsAppOptionsOutput' + summary: 获取指定信息AppOptions + tags: + - host + /hosts/{id}/auto-migrate-on-host-down: + post: + description: 执行操作AutoMigrateOnHostDown + operationId: host_PerformAutoMigrateOnHostDown + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostAutoMigrateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformAutoMigrateOnHostDownOutput' + summary: 执行操作AutoMigrateOnHostDown + tags: + - host + /hosts/{id}/cache-image: + post: + description: 执行操作CacheImage + operationId: host_PerformCacheImage + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/CacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformCacheImageOutput' + summary: 执行操作CacheImage + tags: + - host + /hosts/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: host_PerformChangeOwner + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - host + /hosts/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: host_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - host + /hosts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: host_GetDetailsClassMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - host + post: + description: 执行操作ClassMetadata + operationId: host_PerformClassMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - host + /hosts/{id}/convert-hypervisor: + post: + description: 执行操作ConvertHypervisor + operationId: host_PerformConvertHypervisor + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformConvertHypervisorOutput' + summary: 执行操作ConvertHypervisor + tags: + - host + /hosts/{id}/disable: + post: + description: 执行操作Disable + operationId: host_PerformDisable + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformDisableOutput' + summary: 执行操作Disable + tags: + - host + /hosts/{id}/disable-netif: + post: + description: 执行操作DisableNetif + operationId: host_PerformDisableNetif + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostDisableNetifInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformDisableNetifOutput' + summary: 执行操作DisableNetif + tags: + - host + /hosts/{id}/eject-iso: + post: + description: 执行操作EjectIso + operationId: host_PerformEjectIso + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformEjectIsoOutput' + summary: 执行操作EjectIso + tags: + - host + /hosts/{id}/enable: + post: + description: 执行操作Enable + operationId: host_PerformEnable + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformEnableOutput' + summary: 执行操作Enable + tags: + - host + /hosts/{id}/enable-netif: + post: + description: 执行操作EnableNetif + operationId: host_PerformEnableNetif + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostEnableNetifInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformEnableNetifOutput' + summary: 执行操作EnableNetif + tags: + - host + /hosts/{id}/host-exit-maintenance: + post: + description: 执行操作HostExitMaintenance + operationId: host_PerformHostExitMaintenance + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformHostExitMaintenanceOutput' + summary: 执行操作HostExitMaintenance + tags: + - host + /hosts/{id}/host-maintenance: + post: + description: 执行操作HostMaintenance + operationId: host_PerformHostMaintenance + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformHostMaintenanceOutput' + summary: 执行操作HostMaintenance + tags: + - host + /hosts/{id}/initialize: + post: + description: 执行操作Initialize + operationId: host_PerformInitialize + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformInitializeOutput' + summary: 执行操作Initialize + tags: + - host + /hosts/{id}/insert-iso: + post: + description: 执行操作InsertIso + operationId: host_PerformInsertIso + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformInsertIsoOutput' + summary: 执行操作InsertIso + tags: + - host + /hosts/{id}/ipmi: + get: + description: 获取指定信息Ipmi + operationId: host_GetDetailsIpmi + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsIpmiOutput' + summary: 获取指定信息Ipmi + tags: + - host + /hosts/{id}/ipmi-probe: + post: + description: 执行操作IpmiProbe + operationId: host_PerformIpmiProbe + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformIpmiProbeOutput' + summary: 执行操作IpmiProbe + tags: + - host + /hosts/{id}/jnlp: + get: + description: 获取指定信息Jnlp + operationId: host_GetDetailsJnlp + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsJnlpOutput' + summary: 获取指定信息Jnlp + tags: + - host + /hosts/{id}/login-info: + post: + description: 执行操作LoginInfo + operationId: host_PerformLoginInfo + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostLoginInfoInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformLoginInfoOutput' + summary: 执行操作LoginInfo + tags: + - host + /hosts/{id}/maintenance: + post: + description: 执行操作Maintenance + operationId: host_PerformMaintenance + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformMaintenanceOutput' + summary: 执行操作Maintenance + tags: + - host + /hosts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: host_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 host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - host + /hosts/{id}/nics: + get: + description: 获取指定信息Nics + operationId: host_GetDetailsNics + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsNicsOutput' + summary: 获取指定信息Nics + tags: + - host + /hosts/{id}/offline: + post: + description: 执行操作Offline + operationId: host_PerformOffline + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostOfflineInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformOfflineOutput' + summary: 执行操作Offline + tags: + - host + /hosts/{id}/online: + post: + description: 执行操作Online + operationId: host_PerformOnline + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformOnlineOutput' + summary: 执行操作Online + tags: + - host + /hosts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: host_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - host + /hosts/{id}/ping: + post: + description: 执行操作Ping + operationId: host_PerformPing + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/SHostPingInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformPingOutput' + summary: 执行操作Ping + tags: + - host + /hosts/{id}/prepare: + post: + description: 执行操作Prepare + operationId: host_PerformPrepare + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformPrepareOutput' + summary: 执行操作Prepare + tags: + - host + /hosts/{id}/private: + post: + description: 执行操作Private + operationId: host_PerformPrivate + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformPrivateOutput' + summary: 执行操作Private + tags: + - host + /hosts/{id}/probe-isolated-devices: + post: + description: 执行操作ProbeIsolatedDevices + operationId: host_PerformProbeIsolatedDevices + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformProbeIsolatedDevicesOutput' + summary: 执行操作ProbeIsolatedDevices + tags: + - host + /hosts/{id}/public: + post: + description: 执行操作Public + operationId: host_PerformPublic + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformPublicOutput' + summary: 执行操作Public + tags: + - host + /hosts/{id}/purge: + post: + description: 执行操作Purge + operationId: host_PerformPurge + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - host + /hosts/{id}/remove-all-netifs: + post: + description: 执行操作RemoveAllNetifs + operationId: host_PerformRemoveAllNetifs + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformRemoveAllNetifsOutput' + summary: 执行操作RemoveAllNetifs + tags: + - host + /hosts/{id}/remove-netif: + post: + description: 执行操作RemoveNetif + operationId: host_PerformRemoveNetif + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostRemoveNetifInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformRemoveNetifOutput' + summary: 执行操作RemoveNetif + tags: + - host + /hosts/{id}/renew-prepaid-recycle: + post: + description: 执行操作RenewPrepaidRecycle + operationId: host_PerformRenewPrepaidRecycle + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformRenewPrepaidRecycleOutput' + summary: 执行操作RenewPrepaidRecycle + tags: + - host + /hosts/{id}/reserve-cpus: + post: + description: 执行操作ReserveCpus + operationId: host_PerformReserveCpus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostReserveCpusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformReserveCpusOutput' + summary: 执行操作ReserveCpus + tags: + - host + /hosts/{id}/reset: + post: + description: 执行操作Reset + operationId: host_PerformReset + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformResetOutput' + summary: 执行操作Reset + tags: + - host + /hosts/{id}/restart-host-agent: + post: + description: 执行操作RestartHostAgent + operationId: host_PerformRestartHostAgent + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformRestartHostAgentOutput' + summary: 执行操作RestartHostAgent + tags: + - host + /hosts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: host_PerformSetClassMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - host + /hosts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: host_PerformSetOrgMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - host + /hosts/{id}/set-reserved-resource-for-isolated-device: + post: + description: 执行操作SetReservedResourceForIsolatedDevice + operationId: host_PerformSetReservedResourceForIsolatedDevice + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/IsolatedDeviceReservedResourceInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformSetReservedResourceForIsolatedDeviceOutput' + summary: 执行操作SetReservedResourceForIsolatedDevice + tags: + - host + /hosts/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: host_PerformSetSchedtag + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - host + /hosts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: host_PerformSetUserMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - host + /hosts/{id}/spec: + get: + description: 获取指定信息Spec + operationId: host_GetDetailsSpec + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsSpecOutput' + summary: 获取指定信息Spec + tags: + - host + /hosts/{id}/start: + post: + description: 执行操作Start + operationId: host_PerformStart + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostPerformStartInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformStartOutput' + summary: 执行操作Start + tags: + - host + /hosts/{id}/status: + get: + description: 获取指定信息Status + operationId: host_GetDetailsStatus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - host + post: + description: 执行操作Status + operationId: host_PerformStatus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformStatusOutput' + summary: 执行操作Status + tags: + - host + /hosts/{id}/stop: + post: + description: 执行操作Stop + operationId: host_PerformStop + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformStopOutput' + summary: 执行操作Stop + tags: + - host + /hosts/{id}/sync-config: + post: + description: 执行操作SyncConfig + operationId: host_PerformSyncConfig + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformSyncConfigOutput' + summary: 执行操作SyncConfig + tags: + - host + /hosts/{id}/sync-guest-nic-traffics: + post: + description: 执行操作SyncGuestNicTraffics + operationId: host_PerformSyncGuestNicTraffics + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformSyncGuestNicTrafficsOutput' + summary: 执行操作SyncGuestNicTraffics + tags: + - host + /hosts/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: host_PerformSyncstatus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - host + /hosts/{id}/tap-config: + get: + description: 获取指定信息TapConfig + operationId: host_GetDetailsTapConfig + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsTapConfigOutput' + summary: 获取指定信息TapConfig + tags: + - host + /hosts/{id}/undo-convert: + post: + description: 执行操作UndoConvert + operationId: host_PerformUndoConvert + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUndoConvertOutput' + summary: 执行操作UndoConvert + tags: + - host + /hosts/{id}/undo-prepaid-recycle: + post: + description: 执行操作UndoPrepaidRecycle + operationId: host_PerformUndoPrepaidRecycle + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUndoPrepaidRecycleOutput' + summary: 执行操作UndoPrepaidRecycle + tags: + - host + /hosts/{id}/unmaintenance: + post: + description: 执行操作Unmaintenance + operationId: host_PerformUnmaintenance + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUnmaintenanceOutput' + summary: 执行操作Unmaintenance + tags: + - host + /hosts/{id}/unreserve-cpus: + post: + description: 执行操作UnreserveCpus + operationId: host_PerformUnreserveCpus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUnreserveCpusOutput' + summary: 执行操作UnreserveCpus + tags: + - host + /hosts/{id}/update-storage: + post: + description: 执行操作UpdateStorage + operationId: host_PerformUpdateStorage + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUpdateStorageOutput' + summary: 执行操作UpdateStorage + tags: + - host + /hosts/{id}/vnc: + get: + description: 获取指定信息Vnc + operationId: host_GetDetailsVnc + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsVncOutput' + summary: 获取指定信息Vnc + tags: + - host + /hosts/bm-start-register-script: + get: + description: 获取指定资源类的信息BmStartRegisterScript + operationId: host_GetPropertyBmStartRegisterScript + responses: + "200": + $ref: '#/responses/host_GetPropertyBmStartRegisterScriptOutput' + summary: 获取指定资源类的信息BmStartRegisterScript + tags: + - host + /hosts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: host_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/host_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - host + /hosts/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: host_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/host_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - host + /hosts/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: host_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/host_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - host + /hosts/host-type-count: + get: + description: 获取指定资源类的信息HostTypeCount + operationId: host_GetPropertyHostTypeCount + 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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: 备份存储（ID或Name） + in: query + name: backupstorage_id + type: string + x-go-name: BackupstorageId + - description: 以备份存储名称排序 + in: query + name: order_by_backupstorage + pattern: asc|desc + type: string + x-go-name: OrderByBackupstorage + - description: filter by ResourceType + in: query + name: resource_type + type: string + x-go-name: ResourceType + - description: filter by mac of any network interface + in: query + name: any_mac + type: string + x-go-name: AnyMac + - description: filter by ip of any network interface + in: query + items: + type: string + name: any_ip + type: array + x-go-name: AnyIp + - description: filter storages not attached to this host + in: query + name: storage_not_attached + type: boolean + x-go-name: StorageNotAttached + - description: filter by Hypervisor + in: query + name: hypervisor + type: string + x-go-name: Hypervisor + - description: filter host that is empty + in: query + name: is_empty + type: boolean + x-go-name: IsEmpty + - description: filter host that is baremetal + in: query + name: baremetal + type: boolean + x-go-name: Baremetal + - description: 机架 + in: query + items: + type: string + name: rack + type: array + x-go-name: Rack + - description: 机位 + in: query + items: + type: string + name: slots + type: array + x-go-name: Slots + - description: 管理口MAC + in: query + items: + type: string + name: access_mac + type: array + x-go-name: AccessMac + - description: 管理口Ip地址 + in: query + items: + type: string + name: access_ip + type: array + x-go-name: AccessIp + - description: 物理机序列号信息 + in: query + items: + type: string + name: sn + type: array + x-go-name: SN + - description: CPU大小 + in: query + items: + format: int64 + type: integer + name: cpu_count + type: array + x-go-name: CpuCount + - description: 内存大小,单位Mb + in: query + items: + format: int64 + type: integer + name: mem_size + type: array + x-go-name: MemSize + - description: 存储类型(磁盘类型，sdd, rotate, hybrid) + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - description: 宿主机绑定存储类型 + in: query + items: + type: string + name: host_storage_type + type: array + x-go-name: HostStorageType + - description: IPMI地址 + in: query + items: + type: string + name: ipmi_ip + type: array + x-go-name: IpmiIp + - description: 宿主机状态 + example: online + in: query + items: + type: string + name: host_status + type: array + x-go-name: HostStatus + - description: 宿主机类型 + in: query + items: + type: string + name: host_type + type: array + x-go-name: HostType + - description: host服务软件版本 + in: query + items: + type: string + name: version + type: array + x-go-name: Version + - description: OVN软件版本 + in: query + items: + type: string + name: ovn_version + type: array + x-go-name: OvnVersion + - description: 是否处于维护状态 + in: query + name: is_maintenance + type: boolean + x-go-name: IsMaintenance + - description: 是否为导入的宿主机 + in: query + name: is_import + type: boolean + x-go-name: IsImport + - description: 是否允许PXE启动 + in: query + name: enable_pxe_boot + type: boolean + x-go-name: EnablePxeBoot + - description: 主机UUID + in: query + items: + type: string + name: uuid + type: array + x-go-name: Uuid + - description: 主机启动模式, 可能值位PXE和ISO + in: query + items: + type: string + name: boot_mode + type: array + x-go-name: BootMode + - description: 虚拟机所在的二层网络 + in: query + name: server_id_for_network + type: string + x-go-name: ServerIdForNetwork + - description: 宿主机 cpu 架构 + in: query + items: + type: string + name: cpu_architecture + type: array + x-go-name: CpuArchitecture + - in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - description: 按虚拟机数量排序 + enum: + - asc + - desc + in: query + name: order_by_server_count + type: string + x-go-name: OrderByServerCount + - description: |- + 按存储大小排序 + enmu: asc,desc + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: |- + 按存储超分率排序 + enmu: asc,desc + in: query + name: order_by_storage_commit_rate + type: string + x-go-name: OrderByStorageCommitRate + - description: |- + 按cpu超分率排序 + enmu: asc,desc + in: query + name: order_by_cpu_commit_rate + type: string + x-go-name: OrderByCpuCommitRate + - description: |- + 按内存超分率排序 + enmu: asc,desc + in: query + name: order_by_mem_commit_rate + type: string + x-go-name: OrderByMemCommitRate + responses: + "200": + $ref: '#/responses/host_GetPropertyHostTypeCountOutput' + summary: 获取指定资源类的信息HostTypeCount + tags: + - host + /hosts/k8s-master-node-ips: + get: + description: 获取指定资源类的信息K8sMasterNodeIps + operationId: host_GetPropertyK8sMasterNodeIps + responses: + "200": + $ref: '#/responses/host_GetPropertyK8sMasterNodeIpsOutput' + summary: 获取指定资源类的信息K8sMasterNodeIps + tags: + - host + /hosts/node-count: + get: + description: 获取指定资源类的信息NodeCount + operationId: host_GetPropertyNodeCount + 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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: 备份存储（ID或Name） + in: query + name: backupstorage_id + type: string + x-go-name: BackupstorageId + - description: 以备份存储名称排序 + in: query + name: order_by_backupstorage + pattern: asc|desc + type: string + x-go-name: OrderByBackupstorage + - description: filter by ResourceType + in: query + name: resource_type + type: string + x-go-name: ResourceType + - description: filter by mac of any network interface + in: query + name: any_mac + type: string + x-go-name: AnyMac + - description: filter by ip of any network interface + in: query + items: + type: string + name: any_ip + type: array + x-go-name: AnyIp + - description: filter storages not attached to this host + in: query + name: storage_not_attached + type: boolean + x-go-name: StorageNotAttached + - description: filter by Hypervisor + in: query + name: hypervisor + type: string + x-go-name: Hypervisor + - description: filter host that is empty + in: query + name: is_empty + type: boolean + x-go-name: IsEmpty + - description: filter host that is baremetal + in: query + name: baremetal + type: boolean + x-go-name: Baremetal + - description: 机架 + in: query + items: + type: string + name: rack + type: array + x-go-name: Rack + - description: 机位 + in: query + items: + type: string + name: slots + type: array + x-go-name: Slots + - description: 管理口MAC + in: query + items: + type: string + name: access_mac + type: array + x-go-name: AccessMac + - description: 管理口Ip地址 + in: query + items: + type: string + name: access_ip + type: array + x-go-name: AccessIp + - description: 物理机序列号信息 + in: query + items: + type: string + name: sn + type: array + x-go-name: SN + - description: CPU大小 + in: query + items: + format: int64 + type: integer + name: cpu_count + type: array + x-go-name: CpuCount + - description: 内存大小,单位Mb + in: query + items: + format: int64 + type: integer + name: mem_size + type: array + x-go-name: MemSize + - description: 存储类型(磁盘类型，sdd, rotate, hybrid) + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - description: 宿主机绑定存储类型 + in: query + items: + type: string + name: host_storage_type + type: array + x-go-name: HostStorageType + - description: IPMI地址 + in: query + items: + type: string + name: ipmi_ip + type: array + x-go-name: IpmiIp + - description: 宿主机状态 + example: online + in: query + items: + type: string + name: host_status + type: array + x-go-name: HostStatus + - description: 宿主机类型 + in: query + items: + type: string + name: host_type + type: array + x-go-name: HostType + - description: host服务软件版本 + in: query + items: + type: string + name: version + type: array + x-go-name: Version + - description: OVN软件版本 + in: query + items: + type: string + name: ovn_version + type: array + x-go-name: OvnVersion + - description: 是否处于维护状态 + in: query + name: is_maintenance + type: boolean + x-go-name: IsMaintenance + - description: 是否为导入的宿主机 + in: query + name: is_import + type: boolean + x-go-name: IsImport + - description: 是否允许PXE启动 + in: query + name: enable_pxe_boot + type: boolean + x-go-name: EnablePxeBoot + - description: 主机UUID + in: query + items: + type: string + name: uuid + type: array + x-go-name: Uuid + - description: 主机启动模式, 可能值位PXE和ISO + in: query + items: + type: string + name: boot_mode + type: array + x-go-name: BootMode + - description: 虚拟机所在的二层网络 + in: query + name: server_id_for_network + type: string + x-go-name: ServerIdForNetwork + - description: 宿主机 cpu 架构 + in: query + items: + type: string + name: cpu_architecture + type: array + x-go-name: CpuArchitecture + - in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - description: 按虚拟机数量排序 + enum: + - asc + - desc + in: query + name: order_by_server_count + type: string + x-go-name: OrderByServerCount + - description: |- + 按存储大小排序 + enmu: asc,desc + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: |- + 按存储超分率排序 + enmu: asc,desc + in: query + name: order_by_storage_commit_rate + type: string + x-go-name: OrderByStorageCommitRate + - description: |- + 按cpu超分率排序 + enmu: asc,desc + in: query + name: order_by_cpu_commit_rate + type: string + x-go-name: OrderByCpuCommitRate + - description: |- + 按内存超分率排序 + enmu: asc,desc + in: query + name: order_by_mem_commit_rate + type: string + x-go-name: OrderByMemCommitRate + responses: + "200": + $ref: '#/responses/host_GetPropertyNodeCountOutput' + summary: 获取指定资源类的信息NodeCount + tags: + - host + /hosts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: host_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - host + /hosts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: host_GetPropertySplitable + responses: + "200": + $ref: '#/responses/host_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - host + /hosts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: host_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/host_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - host + /hosts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: host_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/host_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - host + /hosts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: host_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/host_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - host + /hosts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: host_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/host_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - host + /hoststorages: + get: + description: 列表 + operationId: hoststorage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: 以存储名称排序 + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/hoststorage_ListItemFilterOutput' + summary: 列表 + tags: + - hoststorage + post: + description: 新建 + operationId: hoststorage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + hoststorage: + $ref: '#/definitions/HostStorageCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hoststorage_ValidateCreateDataOutput' + summary: 新建 + tags: + - hoststorage + /hoststorages/{id}: + delete: + description: 删除 + operationId: hoststorage_CustomizeDelete + parameters: + - description: The Id or Name of hoststorage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hoststorage_CustomizeDeleteOutput' + summary: 删除 + tags: + - hoststorage + get: + description: 获取详情 + operationId: hoststorage_FetchCustomizeColumns + parameters: + - description: The Id or Name of hoststorage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hoststorage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - hoststorage + put: + description: 更新 + operationId: hoststorage_ValidateUpdateData + parameters: + - description: The Id or Name of hoststorage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + hoststorage: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hoststorage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - hoststorage + /hoststorages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: hoststorage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/hoststorage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - hoststorage + /hoststorages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: hoststorage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + hoststorage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hoststorage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - hoststorage + /hoststorages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: hoststorage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/hoststorage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - hoststorage + /hoststorages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: hoststorage_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/hoststorage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - hoststorage + /infras_quotas/domains: + get: + description: 获取所有域的基础设施配额 + operationId: models_ListInfrasQuotas + 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_ListInfrasQuotasOutput' + summary: 获取所有域的基础设施配额 + tags: + - infras_quota + /infras_quotas/domains/{domainId}: + get: + description: 获取指定域的基础设施配额 + operationId: models_GetInfrasQuota + 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_GetInfrasQuotaOutput' + summary: 获取指定域的基础设施配额 + tags: + - infras_quota + post: + description: 设置指定域的基础设施配额 + operationId: models_SetInfrasQuotas + parameters: + - description: 指定域的ID + in: path + name: domainId + required: true + type: string + x-go-name: DomainId + - in: body + name: body + schema: + properties: + infras_quotas: + $ref: '#/definitions/SetInfrasQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetInfrasQuotasOutput' + summary: 设置指定域的基础设施配额 + tags: + - infras_quota + /instance_backups: + get: + description: 列表 + operationId: instance_backup_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 按虚拟机名称排序 + in: query + name: order_by_guest + pattern: asc|desc + type: string + x-go-name: OrderByGuest + - description: 操作系统类型 + in: query + items: + type: string + name: os_type + type: array + x-go-name: OsType + responses: + "200": + $ref: '#/responses/instance_backup_ListItemFilterOutput' + summary: 列表 + tags: + - instance_backup + post: + description: 新建 + operationId: instance_backup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + instance_backup: + $ref: '#/definitions/InstanceBackupManagerCreateFromPackageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_ValidateCreateDataOutput' + summary: 新建 + tags: + - instance_backup + /instance_backups/{id}: + delete: + description: 删除 + operationId: instance_backup_CustomizeDelete + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_CustomizeDeleteOutput' + summary: 删除 + tags: + - instance_backup + get: + description: 获取详情 + operationId: instance_backup_FetchCustomizeColumns + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - instance_backup + put: + description: 更新 + operationId: instance_backup_ValidateUpdateData + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - instance_backup + /instance_backups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: instance_backup_PerformCancelDelete + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - instance_backup + /instance_backups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: instance_backup_PerformChangeOwner + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - instance_backup + /instance_backups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: instance_backup_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - instance_backup + /instance_backups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: instance_backup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - instance_backup + post: + description: 执行操作ClassMetadata + operationId: instance_backup_PerformClassMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - instance_backup + /instance_backups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: instance_backup_PerformFreeze + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - instance_backup + /instance_backups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: instance_backup_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 instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - instance_backup + /instance_backups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: instance_backup_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - instance_backup + /instance_backups/{id}/pack: + post: + description: 执行操作Pack + operationId: instance_backup_PerformPack + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupPackInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformPackOutput' + summary: 执行操作Pack + tags: + - instance_backup + /instance_backups/{id}/recovery: + post: + description: 执行操作Recovery + operationId: instance_backup_PerformRecovery + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupRecoveryInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformRecoveryOutput' + summary: 执行操作Recovery + tags: + - instance_backup + /instance_backups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: instance_backup_PerformSetClassMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - instance_backup + /instance_backups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: instance_backup_PerformSetOrgMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - instance_backup + /instance_backups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: instance_backup_PerformSetUserMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - instance_backup + /instance_backups/{id}/status: + get: + description: 获取指定信息Status + operationId: instance_backup_GetDetailsStatus + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - instance_backup + post: + description: 执行操作Status + operationId: instance_backup_PerformStatus + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - instance_backup + /instance_backups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: instance_backup_PerformSyncstatus + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupManagerSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - instance_backup + /instance_backups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: instance_backup_PerformUnfreeze + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - instance_backup + /instance_backups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: instance_backup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - instance_backup + /instance_backups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: instance_backup_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - instance_backup + /instance_backups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: instance_backup_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - instance_backup + /instance_backups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: instance_backup_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - instance_backup + /instance_backups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: instance_backup_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - instance_backup + /instance_backups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: instance_backup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - instance_backup + /instance_backups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: instance_backup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - instance_backup + /instance_backups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: instance_backup_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/instance_backup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - instance_backup + /instance_backups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: instance_backup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - instance_backup + /instance_backups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: instance_backup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - instance_backup + /instance_backups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: instance_backup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - instance_backup + /instance_snapshots: + get: + description: 列表 + operationId: instance_snapshot_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 操作系统类型 + in: query + items: + type: string + name: os_type + type: array + x-go-name: OsType + - description: 包含内存快照 + in: query + name: with_memory + type: boolean + x-go-name: WithMemory + - description: 按磁盘快照数量排序 + in: query + name: order_by_disk_snapshot_count + pattern: asc|desc + type: string + x-go-name: OrderByDiskSnapshotCount + - description: 按虚拟机名称排序 + in: query + name: order_by_guest + pattern: asc|desc + type: string + x-go-name: OrderByGuest + responses: + "200": + $ref: '#/responses/instance_snapshot_ListItemFilterOutput' + summary: 主机快照列表 + tags: + - instance_snapshot + post: + description: 新建 + operationId: instance_snapshot_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + instance_snapshot: + $ref: '#/definitions/VirtualResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_ValidateCreateDataOutput' + summary: 新建 + tags: + - instance_snapshot + /instance_snapshots/{id}: + delete: + description: 删除 + operationId: instance_snapshot_CustomizeDelete + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_CustomizeDeleteOutput' + summary: 删除 + tags: + - instance_snapshot + get: + description: 获取详情 + operationId: instance_snapshot_FetchCustomizeColumns + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - instance_snapshot + put: + description: 更新 + operationId: instance_snapshot_ValidateUpdateData + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_ValidateUpdateDataOutput' + summary: 更新 + tags: + - instance_snapshot + /instance_snapshots/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: instance_snapshot_PerformCancelDelete + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - instance_snapshot + /instance_snapshots/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: instance_snapshot_PerformChangeOwner + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - instance_snapshot + /instance_snapshots/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: instance_snapshot_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - instance_snapshot + /instance_snapshots/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: instance_snapshot_GetDetailsClassMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - instance_snapshot + post: + description: 执行操作ClassMetadata + operationId: instance_snapshot_PerformClassMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - instance_snapshot + /instance_snapshots/{id}/freeze: + post: + description: 执行操作Freeze + operationId: instance_snapshot_PerformFreeze + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - instance_snapshot + /instance_snapshots/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: instance_snapshot_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 instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - instance_snapshot + /instance_snapshots/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: instance_snapshot_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - instance_snapshot + /instance_snapshots/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: instance_snapshot_PerformSetClassMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - instance_snapshot + /instance_snapshots/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: instance_snapshot_PerformSetOrgMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - instance_snapshot + /instance_snapshots/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: instance_snapshot_PerformSetUserMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - instance_snapshot + /instance_snapshots/{id}/status: + get: + description: 获取指定信息Status + operationId: instance_snapshot_GetDetailsStatus + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - instance_snapshot + post: + description: 执行操作Status + operationId: instance_snapshot_PerformStatus + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformStatusOutput' + summary: 更新资源状态 + tags: + - instance_snapshot + /instance_snapshots/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: instance_snapshot_PerformUnfreeze + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - instance_snapshot + /instance_snapshots/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: instance_snapshot_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - instance_snapshot + /instance_snapshots/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: instance_snapshot_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - instance_snapshot + /instance_snapshots/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: instance_snapshot_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - instance_snapshot + /instance_snapshots/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: instance_snapshot_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - instance_snapshot + /instance_snapshots/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: instance_snapshot_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - instance_snapshot + /instance_snapshots/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: instance_snapshot_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - instance_snapshot + /instance_snapshots/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: instance_snapshot_GetPropertySplitable + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - instance_snapshot + /instance_snapshots/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: instance_snapshot_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/instance_snapshot_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - instance_snapshot + /instance_snapshots/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: instance_snapshot_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - instance_snapshot + /instance_snapshots/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: instance_snapshot_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - instance_snapshot + /instance_snapshots/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: instance_snapshot_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - instance_snapshot + /inter_vpc_network_route_sets: + get: + description: 列表 + operationId: inter_vpc_network_route_set_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: InterVpcNetworkId + type: string + - in: query + name: cidr + type: string + x-go-name: Cidr + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_ListItemFilterOutput' + summary: 列表 + tags: + - inter_vpc_network_route_set + post: + description: 新建 + operationId: inter_vpc_network_route_set_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + inter_vpc_network_route_set: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_ValidateCreateDataOutput' + summary: 新建 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}: + delete: + description: 删除 + operationId: inter_vpc_network_route_set_CustomizeDelete + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_CustomizeDeleteOutput' + summary: 删除 + tags: + - inter_vpc_network_route_set + get: + description: 获取详情 + operationId: inter_vpc_network_route_set_FetchCustomizeColumns + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - inter_vpc_network_route_set + put: + description: 更新 + operationId: inter_vpc_network_route_set_ValidateUpdateData + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_ValidateUpdateDataOutput' + summary: 更新 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: inter_vpc_network_route_set_GetDetailsClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - inter_vpc_network_route_set + post: + description: 执行操作ClassMetadata + operationId: inter_vpc_network_route_set_PerformClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/disable: + post: + description: 执行操作Disable + operationId: inter_vpc_network_route_set_PerformDisable + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformDisableOutput' + summary: 执行操作Disable + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/enable: + post: + description: 执行操作Enable + operationId: inter_vpc_network_route_set_PerformEnable + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformEnableOutput' + summary: 执行操作Enable + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: inter_vpc_network_route_set_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 inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: inter_vpc_network_route_set_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: inter_vpc_network_route_set_PerformSetClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: inter_vpc_network_route_set_PerformSetOrgMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: inter_vpc_network_route_set_PerformSetUserMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/status: + get: + description: 获取指定信息Status + operationId: inter_vpc_network_route_set_GetDetailsStatus + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - inter_vpc_network_route_set + post: + description: 执行操作Status + operationId: inter_vpc_network_route_set_PerformStatus + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformStatusOutput' + summary: 更新资源状态 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: inter_vpc_network_route_set_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: inter_vpc_network_route_set_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: inter_vpc_network_route_set_GetPropertySplitable + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: inter_vpc_network_route_set_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/inter_vpc_network_route_set_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: inter_vpc_network_route_set_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: inter_vpc_network_route_set_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: inter_vpc_network_route_set_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - inter_vpc_network_route_set + /inter_vpc_network_vpcs: + get: + description: 列表 + operationId: inter_vpc_network_vpc_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/inter_vpc_network_vpc_ListItemFilterOutput' + summary: 列表 + tags: + - inter_vpc_network_vpc + post: + description: 新建 + operationId: inter_vpc_network_vpc_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + inter_vpc_network_vpc: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_ValidateCreateDataOutput' + summary: 新建 + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/{id}: + delete: + description: 删除 + operationId: inter_vpc_network_vpc_CustomizeDelete + parameters: + - description: The Id or Name of inter_vpc_network_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_CustomizeDeleteOutput' + summary: 删除 + tags: + - inter_vpc_network_vpc + get: + description: 获取详情 + operationId: inter_vpc_network_vpc_FetchCustomizeColumns + parameters: + - description: The Id or Name of inter_vpc_network_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - inter_vpc_network_vpc + put: + description: 更新 + operationId: inter_vpc_network_vpc_ValidateUpdateData + parameters: + - description: The Id or Name of inter_vpc_network_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_ValidateUpdateDataOutput' + summary: 更新 + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: inter_vpc_network_vpc_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: inter_vpc_network_vpc_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: inter_vpc_network_vpc_GetPropertySplitable + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: inter_vpc_network_vpc_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/inter_vpc_network_vpc_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - inter_vpc_network_vpc + /inter_vpc_networks: + get: + description: 列表 + operationId: inter_vpc_network_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/inter_vpc_network_ListItemFilterOutput' + summary: 列表 + tags: + - inter_vpc_network + post: + description: 新建 + operationId: inter_vpc_network_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_ValidateCreateDataOutput' + summary: 新建 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}: + delete: + description: 删除 + operationId: inter_vpc_network_CustomizeDelete + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_CustomizeDeleteOutput' + summary: 删除 + tags: + - inter_vpc_network + get: + description: 获取详情 + operationId: inter_vpc_network_FetchCustomizeColumns + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - inter_vpc_network + put: + description: 更新 + operationId: inter_vpc_network_ValidateUpdateData + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_ValidateUpdateDataOutput' + summary: 更新 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/addvpc: + post: + description: 执行操作Addvpc + operationId: inter_vpc_network_PerformAddvpc + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkAddVpcInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformAddvpcOutput' + summary: 执行操作Addvpc + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: inter_vpc_network_PerformChangeOwner + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: inter_vpc_network_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: inter_vpc_network_GetDetailsClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - inter_vpc_network + post: + description: 执行操作ClassMetadata + operationId: inter_vpc_network_PerformClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/disable: + post: + description: 执行操作Disable + operationId: inter_vpc_network_PerformDisable + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformDisableOutput' + summary: 禁用资源 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/enable: + post: + description: 执行操作Enable + operationId: inter_vpc_network_PerformEnable + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformEnableOutput' + summary: 启用资源 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: inter_vpc_network_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 inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: inter_vpc_network_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/private: + post: + description: 执行操作Private + operationId: inter_vpc_network_PerformPrivate + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformPrivateOutput' + summary: 执行操作Private + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/public: + post: + description: 执行操作Public + operationId: inter_vpc_network_PerformPublic + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformPublicOutput' + summary: 执行操作Public + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/removevpc: + post: + description: 执行操作Removevpc + operationId: inter_vpc_network_PerformRemovevpc + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkRemoveVpcInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformRemovevpcOutput' + summary: 执行操作Removevpc + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: inter_vpc_network_PerformSetClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: inter_vpc_network_PerformSetOrgMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: inter_vpc_network_PerformSetUserMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/status: + get: + description: 获取指定信息Status + operationId: inter_vpc_network_GetDetailsStatus + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - inter_vpc_network + post: + description: 执行操作Status + operationId: inter_vpc_network_PerformStatus + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformStatusOutput' + summary: 更新资源状态 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: inter_vpc_network_PerformSyncstatus + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - inter_vpc_network + /inter_vpc_networks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: inter_vpc_network_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - inter_vpc_network + /inter_vpc_networks/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: inter_vpc_network_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - inter_vpc_network + /inter_vpc_networks/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: inter_vpc_network_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - inter_vpc_network + /inter_vpc_networks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: inter_vpc_network_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - inter_vpc_network + /inter_vpc_networks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: inter_vpc_network_GetPropertySplitable + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - inter_vpc_network + /inter_vpc_networks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: inter_vpc_network_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/inter_vpc_network_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - inter_vpc_network + /inter_vpc_networks/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: inter_vpc_network_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - inter_vpc_network + /inter_vpc_networks/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: inter_vpc_network_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - inter_vpc_network + /inter_vpc_networks/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: inter_vpc_network_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - inter_vpc_network + /ipv6_gateways: + get: + description: 列表 + operationId: ipv6_gateway_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/ipv6_gateway_ListItemFilterOutput' + summary: IPv6网关列表 + tags: + - ipv6_gateway + post: + description: 新建 + operationId: ipv6_gateway_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_ValidateCreateDataOutput' + summary: 新建 + tags: + - ipv6_gateway + /ipv6_gateways/{id}: + delete: + description: 删除 + operationId: ipv6_gateway_CustomizeDelete + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_CustomizeDeleteOutput' + summary: 删除 + tags: + - ipv6_gateway + get: + description: 获取详情 + operationId: ipv6_gateway_FetchCustomizeColumns + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - ipv6_gateway + put: + description: 更新 + operationId: ipv6_gateway_ValidateUpdateData + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_ValidateUpdateDataOutput' + summary: 更新 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: ipv6_gateway_PerformCancelDelete + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - ipv6_gateway + /ipv6_gateways/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: ipv6_gateway_PerformChangeOwner + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - ipv6_gateway + /ipv6_gateways/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: ipv6_gateway_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - ipv6_gateway + /ipv6_gateways/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: ipv6_gateway_GetDetailsClassMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - ipv6_gateway + post: + description: 执行操作ClassMetadata + operationId: ipv6_gateway_PerformClassMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/freeze: + post: + description: 执行操作Freeze + operationId: ipv6_gateway_PerformFreeze + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - ipv6_gateway + /ipv6_gateways/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: ipv6_gateway_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 ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - ipv6_gateway + /ipv6_gateways/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: ipv6_gateway_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - ipv6_gateway + /ipv6_gateways/{id}/private: + post: + description: 执行操作Private + operationId: ipv6_gateway_PerformPrivate + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformPrivateOutput' + summary: 执行操作Private + tags: + - ipv6_gateway + /ipv6_gateways/{id}/public: + post: + description: 执行操作Public + operationId: ipv6_gateway_PerformPublic + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformPublicOutput' + summary: 执行操作Public + tags: + - ipv6_gateway + /ipv6_gateways/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: ipv6_gateway_PerformSetClassMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: ipv6_gateway_PerformSetOrgMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: ipv6_gateway_PerformSetUserMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/status: + get: + description: 获取指定信息Status + operationId: ipv6_gateway_GetDetailsStatus + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - ipv6_gateway + post: + description: 执行操作Status + operationId: ipv6_gateway_PerformStatus + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformStatusOutput' + summary: 更新资源状态 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: ipv6_gateway_PerformUnfreeze + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - ipv6_gateway + /ipv6_gateways/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: ipv6_gateway_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - ipv6_gateway + /ipv6_gateways/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: ipv6_gateway_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - ipv6_gateway + /ipv6_gateways/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: ipv6_gateway_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - ipv6_gateway + /ipv6_gateways/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: ipv6_gateway_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - ipv6_gateway + /ipv6_gateways/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: ipv6_gateway_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - ipv6_gateway + /ipv6_gateways/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: ipv6_gateway_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - ipv6_gateway + /ipv6_gateways/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: ipv6_gateway_GetPropertySplitable + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - ipv6_gateway + /ipv6_gateways/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: ipv6_gateway_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/ipv6_gateway_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - ipv6_gateway + /ipv6_gateways/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: ipv6_gateway_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - ipv6_gateway + /ipv6_gateways/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: ipv6_gateway_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - ipv6_gateway + /ipv6_gateways/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: ipv6_gateway_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - ipv6_gateway + /isolated_device_models: + get: + description: 列表 + operationId: isolated_device_model_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: 设备类型 + example: NPU + in: query + items: + type: string + name: dev_type + type: array + x-go-name: DevType + - description: 设备型号 + in: query + items: + type: string + name: model + type: array + x-go-name: Model + - description: 设备VendorId + in: query + name: vendor_id + type: string + x-go-name: VendorId + - description: 设备DeviceId + in: query + name: device_id + type: string + x-go-name: DeviceId + - description: 支持热插拔 HotPluggable + in: query + name: hot_pluggable + type: boolean + x-go-name: HotPluggable + - description: 宿主机 Id + in: query + name: host_id + type: string + x-go-name: HostId + responses: + "200": + $ref: '#/responses/isolated_device_model_ListItemFilterOutput' + summary: 列表 + tags: + - isolated_device_model + post: + description: 新建 + operationId: isolated_device_model_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + isolated_device_model: + $ref: '#/definitions/IsolatedDeviceModelCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_ValidateCreateDataOutput' + summary: 新建 + tags: + - isolated_device_model + /isolated_device_models/{id}: + delete: + description: 删除 + operationId: isolated_device_model_CustomizeDelete + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_CustomizeDeleteOutput' + summary: 删除 + tags: + - isolated_device_model + get: + description: 获取详情 + operationId: isolated_device_model_FetchCustomizeColumns + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - isolated_device_model + put: + description: 更新 + operationId: isolated_device_model_ValidateUpdateData + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + $ref: '#/definitions/IsolatedDeviceModelUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_ValidateUpdateDataOutput' + summary: 更新 + tags: + - isolated_device_model + /isolated_device_models/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: isolated_device_model_GetDetailsClassMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - isolated_device_model + post: + description: 执行操作ClassMetadata + operationId: isolated_device_model_PerformClassMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - isolated_device_model + /isolated_device_models/{id}/hardware-info: + get: + description: 获取指定信息HardwareInfo + operationId: isolated_device_model_GetDetailsHardwareInfo + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_GetDetailsHardwareInfoOutput' + summary: 获取指定信息HardwareInfo + tags: + - isolated_device_model + /isolated_device_models/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: isolated_device_model_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 isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - isolated_device_model + /isolated_device_models/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: isolated_device_model_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - isolated_device_model + /isolated_device_models/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: isolated_device_model_PerformSetClassMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - isolated_device_model + /isolated_device_models/{id}/set-hardware-info: + post: + description: 执行操作SetHardwareInfo + operationId: isolated_device_model_PerformSetHardwareInfo + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + $ref: '#/definitions/IsolatedDeviceModelHardwareInfo' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformSetHardwareInfoOutput' + summary: 执行操作SetHardwareInfo + tags: + - isolated_device_model + /isolated_device_models/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: isolated_device_model_PerformSetOrgMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - isolated_device_model + /isolated_device_models/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: isolated_device_model_PerformSetUserMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - isolated_device_model + /isolated_device_models/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: isolated_device_model_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/isolated_device_model_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - isolated_device_model + /isolated_device_models/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: isolated_device_model_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + isolated_device_model: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - isolated_device_model + /isolated_device_models/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: isolated_device_model_GetPropertySplitable + responses: + "200": + $ref: '#/responses/isolated_device_model_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - isolated_device_model + /isolated_device_models/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: isolated_device_model_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/isolated_device_model_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - isolated_device_model + /isolated_device_models/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: isolated_device_model_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/isolated_device_model_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - isolated_device_model + /isolated_device_models/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: isolated_device_model_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/isolated_device_model_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - isolated_device_model + /isolated_devices: + get: + description: 列表 + operationId: isolated_device_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: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 只列出GPU直通设备 + in: query + name: gpu + type: boolean + x-go-name: Gpu + - description: 只列出USB直通设备 + in: query + name: usb + type: boolean + x-go-name: Usb + - description: 只列出未使用的直通设备 + in: query + name: unused + type: boolean + x-go-name: Unused + - description: |- + # PCI / GPU-HPC / GPU-VGA / USB / NIC + 设备类型 + in: query + items: + type: string + name: dev_type + type: array + x-go-name: DevType + - description: '# Specific device name read from lspci command, e.g. `Tesla K40m` ...' + in: query + items: + type: string + name: model + type: array + x-go-name: Model + - description: '# pci address of `Bus:Device.Function` format, or usb bus address of `bus.addr`' + in: query + items: + type: string + name: addr + type: array + x-go-name: Addr + - description: 设备VENDOE编号 + in: query + items: + type: string + name: vendor_device_id + type: array + x-go-name: VendorDeviceId + - description: 展示物理机的上的设备 + in: query + name: show_baremetal_isolated_devices + type: boolean + x-go-name: ShowBaremetalIsolatedDevices + - description: 列出虚拟机上挂载的设备 + in: query + name: guest_id + type: string + x-go-name: GuestId + responses: + "200": + $ref: '#/responses/isolated_device_ListItemFilterOutput' + summary: 直通设备（GPU等）列表 + tags: + - isolated_device + post: + description: 新建 + operationId: isolated_device_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + isolated_device: + $ref: '#/definitions/IsolatedDeviceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_ValidateCreateDataOutput' + summary: 新建 + tags: + - isolated_device + /isolated_devices/{id}: + delete: + description: 删除 + operationId: isolated_device_CustomizeDelete + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_CustomizeDeleteOutput' + summary: 删除 + tags: + - isolated_device + get: + description: 获取详情 + operationId: isolated_device_FetchCustomizeColumns + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - isolated_device + put: + description: 更新 + operationId: isolated_device_ValidateUpdateData + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolatedDeviceUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_ValidateUpdateDataOutput' + summary: 更新 + tags: + - isolated_device + /isolated_devices/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: isolated_device_GetDetailsClassMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - isolated_device + post: + description: 执行操作ClassMetadata + operationId: isolated_device_PerformClassMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - isolated_device + /isolated_devices/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: isolated_device_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 isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - isolated_device + /isolated_devices/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: isolated_device_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - isolated_device + /isolated_devices/{id}/purge: + post: + description: 执行操作Purge + operationId: isolated_device_PerformPurge + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - isolated_device + /isolated_devices/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: isolated_device_PerformSetClassMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - isolated_device + /isolated_devices/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: isolated_device_PerformSetOrgMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - isolated_device + /isolated_devices/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: isolated_device_PerformSetUserMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - isolated_device + /isolated_devices/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: isolated_device_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/isolated_device_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - isolated_device + /isolated_devices/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: isolated_device_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + isolated_device: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - isolated_device + /isolated_devices/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: isolated_device_GetPropertySplitable + responses: + "200": + $ref: '#/responses/isolated_device_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - isolated_device + /isolated_devices/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: isolated_device_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/isolated_device_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - isolated_device + /isolated_devices/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: isolated_device_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/isolated_device_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - isolated_device + /isolated_devices/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: isolated_device_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/isolated_device_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - isolated_device + /kafkas: + get: + description: 列表 + operationId: kafka_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/kafka_ListItemFilterOutput' + summary: Kafka实例列表 + tags: + - kafka + post: + description: 新建 + operationId: kafka_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + kafka: + $ref: '#/definitions/KafkaCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_ValidateCreateDataOutput' + summary: 新建 + tags: + - kafka + /kafkas/{id}: + delete: + description: 删除 + operationId: kafka_CustomizeDelete + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_CustomizeDeleteOutput' + summary: 删除 + tags: + - kafka + get: + description: 获取详情 + operationId: kafka_FetchCustomizeColumns + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - kafka + put: + description: 更新 + operationId: kafka_ValidateUpdateData + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_ValidateUpdateDataOutput' + summary: 更新 + tags: + - kafka + /kafkas/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: kafka_PerformCancelDelete + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - kafka + /kafkas/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: kafka_PerformChangeOwner + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - kafka + /kafkas/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: kafka_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - kafka + /kafkas/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: kafka_GetDetailsClassMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - kafka + post: + description: 执行操作ClassMetadata + operationId: kafka_PerformClassMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - kafka + /kafkas/{id}/freeze: + post: + description: 执行操作Freeze + operationId: kafka_PerformFreeze + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - kafka + /kafkas/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: kafka_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 kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - kafka + /kafkas/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: kafka_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - kafka + /kafkas/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: kafka_PerformSetClassMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kafka + /kafkas/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: kafka_PerformSetOrgMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kafka + /kafkas/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: kafka_PerformSetUserMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - kafka + /kafkas/{id}/status: + get: + description: 获取指定信息Status + operationId: kafka_GetDetailsStatus + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - kafka + post: + description: 执行操作Status + operationId: kafka_PerformStatus + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformStatusOutput' + summary: 更新资源状态 + tags: + - kafka + /kafkas/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: kafka_PerformSyncstatus + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_PerformSyncstatusOutput' + summary: 同步Kafka实例状态 + tags: + - kafka + /kafkas/{id}/topics: + get: + description: 获取指定信息Topics + operationId: kafka_GetDetailsTopics + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsTopicsOutput' + summary: 获取Kafka Topic列表 + tags: + - kafka + /kafkas/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: kafka_PerformUnfreeze + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - kafka + /kafkas/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: kafka_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/kafka_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - kafka + /kafkas/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: kafka_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/kafka_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - kafka + /kafkas/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: kafka_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/kafka_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - kafka + /kafkas/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: kafka_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/kafka_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - kafka + /kafkas/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: kafka_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/kafka_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - kafka + /kafkas/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: kafka_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - kafka + /kafkas/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: kafka_GetPropertySplitable + responses: + "200": + $ref: '#/responses/kafka_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - kafka + /kafkas/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: kafka_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/kafka_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - kafka + /kafkas/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: kafka_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/kafka_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - kafka + /kafkas/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: kafka_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/kafka_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - kafka + /kafkas/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: kafka_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/kafka_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - kafka + /keypairs: + get: + description: 列表 + operationId: keypair_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: user_id + type: string + x-go-name: UserId + - 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: 加密类型 + example: RSA + in: query + items: + type: string + name: scheme + type: array + x-go-name: Scheme + - description: 指纹信息 + example: 1d:3a:83:4a:a1:f3:75:97:ec:d1:ef:f8:3f:a7:5d:9e + in: query + items: + type: string + name: fingerprint + type: array + x-go-name: Fingerprint + responses: + "200": + $ref: '#/responses/keypair_ListItemFilterOutput' + summary: 列出ssh密钥对 + tags: + - keypair + post: + description: 新建 + operationId: keypair_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + keypair: + $ref: '#/definitions/KeypairCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_ValidateCreateDataOutput' + summary: 新建 + tags: + - keypair + /keypairs/{id}: + delete: + description: 删除 + operationId: keypair_CustomizeDelete + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_CustomizeDeleteOutput' + summary: 删除 + tags: + - keypair + get: + description: 获取详情 + operationId: keypair_FetchCustomizeColumns + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - keypair + put: + description: 更新 + operationId: keypair_ValidateUpdateData + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_ValidateUpdateDataOutput' + summary: 更新 + tags: + - keypair + /keypairs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: keypair_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - keypair + /keypairs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: keypair_GetDetailsClassMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - keypair + post: + description: 执行操作ClassMetadata + operationId: keypair_PerformClassMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - keypair + /keypairs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: keypair_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 keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - keypair + /keypairs/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: keypair_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - keypair + /keypairs/{id}/private: + post: + description: 执行操作Private + operationId: keypair_PerformPrivate + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformPrivateOutput' + summary: 执行操作Private + tags: + - keypair + /keypairs/{id}/privatekey: + get: + description: 获取指定信息Privatekey + operationId: keypair_GetDetailsPrivatekey + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_GetDetailsPrivatekeyOutput' + summary: 获取指定信息Privatekey + tags: + - keypair + /keypairs/{id}/public: + post: + description: 执行操作Public + operationId: keypair_PerformPublic + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformPublicOutput' + summary: 执行操作Public + tags: + - keypair + /keypairs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: keypair_PerformSetClassMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - keypair + /keypairs/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: keypair_PerformSetOrgMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - keypair + /keypairs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: keypair_PerformSetUserMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - keypair + /keypairs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: keypair_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/keypair_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - keypair + /keypairs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: keypair_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + keypair: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - keypair + /keypairs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: keypair_GetPropertySplitable + responses: + "200": + $ref: '#/responses/keypair_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - keypair + /keypairs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: keypair_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/keypair_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - keypair + /keypairs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: keypair_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/keypair_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - keypair + /keypairs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: keypair_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/keypair_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - keypair + /kube_clusters: + get: + description: 列表 + operationId: kube_cluster_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/kube_cluster_ListItemFilterOutput' + summary: 列出Kube Cluster + tags: + - kube_cluster + post: + description: 新建 + operationId: kube_cluster_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + kube_cluster: + $ref: '#/definitions/KubeClusterCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_ValidateCreateDataOutput' + summary: 新建 + tags: + - kube_cluster + /kube_clusters/{id}: + delete: + description: 删除 + operationId: kube_cluster_CustomizeDelete + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_CustomizeDeleteOutput' + summary: 删除 + tags: + - kube_cluster + get: + description: 获取详情 + operationId: kube_cluster_FetchCustomizeColumns + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - kube_cluster + put: + description: 更新 + operationId: kube_cluster_ValidateUpdateData + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_ValidateUpdateDataOutput' + summary: 更新 + tags: + - kube_cluster + /kube_clusters/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: kube_cluster_PerformChangeOwner + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - kube_cluster + /kube_clusters/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: kube_cluster_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - kube_cluster + /kube_clusters/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: kube_cluster_GetDetailsClassMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - kube_cluster + post: + description: 执行操作ClassMetadata + operationId: kube_cluster_PerformClassMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - kube_cluster + /kube_clusters/{id}/disable: + post: + description: 执行操作Disable + operationId: kube_cluster_PerformDisable + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformDisableOutput' + summary: 禁用资源 + tags: + - kube_cluster + /kube_clusters/{id}/enable: + post: + description: 执行操作Enable + operationId: kube_cluster_PerformEnable + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformEnableOutput' + summary: 启用资源 + tags: + - kube_cluster + /kube_clusters/{id}/kubeconfig: + get: + description: 获取指定信息Kubeconfig + operationId: kube_cluster_GetDetailsKubeconfig + parameters: + - description: 是否获取内网kubeconfig, 默认false即获取外网kubeconfig + in: query + name: private + type: boolean + x-go-name: Private + - description: |- + kubeconfig 到期时间 + 阿里云: 15（15分钟）～4320（3天） + 腾讯云不传此参数默认时效是20年 + format: int64 + in: query + name: expire_minutes + type: integer + x-go-name: ExpireMinutes + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsKubeconfigOutput' + summary: 获取指定信息Kubeconfig + tags: + - kube_cluster + /kube_clusters/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: kube_cluster_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 kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - kube_cluster + /kube_clusters/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: kube_cluster_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - kube_cluster + /kube_clusters/{id}/private: + post: + description: 执行操作Private + operationId: kube_cluster_PerformPrivate + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformPrivateOutput' + summary: 执行操作Private + tags: + - kube_cluster + /kube_clusters/{id}/public: + post: + description: 执行操作Public + operationId: kube_cluster_PerformPublic + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformPublicOutput' + summary: 执行操作Public + tags: + - kube_cluster + /kube_clusters/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: kube_cluster_PerformSetClassMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kube_cluster + /kube_clusters/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: kube_cluster_PerformSetOrgMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kube_cluster + /kube_clusters/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: kube_cluster_PerformSetUserMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - kube_cluster + /kube_clusters/{id}/status: + get: + description: 获取指定信息Status + operationId: kube_cluster_GetDetailsStatus + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - kube_cluster + post: + description: 执行操作Status + operationId: kube_cluster_PerformStatus + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformStatusOutput' + summary: 更新资源状态 + tags: + - kube_cluster + /kube_clusters/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: kube_cluster_PerformSyncstatus + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/SyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformSyncstatusOutput' + summary: 同步Kube Cluster状态 + tags: + - kube_cluster + /kube_clusters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: kube_cluster_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - kube_cluster + /kube_clusters/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: kube_cluster_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - kube_cluster + /kube_clusters/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: kube_cluster_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - kube_cluster + /kube_clusters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: kube_cluster_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - kube_cluster + /kube_clusters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: kube_cluster_GetPropertySplitable + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - kube_cluster + /kube_clusters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: kube_cluster_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/kube_cluster_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - kube_cluster + /kube_clusters/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: kube_cluster_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - kube_cluster + /kube_clusters/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: kube_cluster_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - kube_cluster + /kube_clusters/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: kube_cluster_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - kube_cluster + /kube_node_pools: + get: + description: 列表 + operationId: kube_node_pool_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: cloud_kube_cluster_id + type: string + x-go-name: CloudKubeClusterId + responses: + "200": + $ref: '#/responses/kube_node_pool_ListItemFilterOutput' + summary: Kube Node Pool列表 + tags: + - kube_node_pool + post: + description: 新建 + operationId: kube_node_pool_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + kube_node_pool: + $ref: '#/definitions/KubeNodePoolCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_ValidateCreateDataOutput' + summary: 新建 + tags: + - kube_node_pool + /kube_node_pools/{id}: + delete: + description: 删除 + operationId: kube_node_pool_CustomizeDelete + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_CustomizeDeleteOutput' + summary: 删除 + tags: + - kube_node_pool + get: + description: 获取详情 + operationId: kube_node_pool_FetchCustomizeColumns + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - kube_node_pool + put: + description: 更新 + operationId: kube_node_pool_ValidateUpdateData + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_ValidateUpdateDataOutput' + summary: 更新 + tags: + - kube_node_pool + /kube_node_pools/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: kube_node_pool_GetDetailsClassMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - kube_node_pool + post: + description: 执行操作ClassMetadata + operationId: kube_node_pool_PerformClassMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - kube_node_pool + /kube_node_pools/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: kube_node_pool_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 kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - kube_node_pool + /kube_node_pools/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: kube_node_pool_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - kube_node_pool + /kube_node_pools/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: kube_node_pool_PerformSetClassMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kube_node_pool + /kube_node_pools/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: kube_node_pool_PerformSetOrgMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kube_node_pool + /kube_node_pools/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: kube_node_pool_PerformSetUserMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - kube_node_pool + /kube_node_pools/{id}/status: + get: + description: 获取指定信息Status + operationId: kube_node_pool_GetDetailsStatus + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - kube_node_pool + post: + description: 执行操作Status + operationId: kube_node_pool_PerformStatus + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformStatusOutput' + summary: 更新资源状态 + tags: + - kube_node_pool + /kube_node_pools/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: kube_node_pool_PerformSyncstatus + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + $ref: '#/definitions/SyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformSyncstatusOutput' + summary: 同步Kube Node Pool 状态 + tags: + - kube_node_pool + /kube_node_pools/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: kube_node_pool_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - kube_node_pool + /kube_node_pools/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: kube_node_pool_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + kube_node_pool: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - kube_node_pool + /kube_node_pools/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: kube_node_pool_GetPropertySplitable + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - kube_node_pool + /kube_node_pools/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: kube_node_pool_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/kube_node_pool_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - kube_node_pool + /kube_node_pools/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: kube_node_pool_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - kube_node_pool + /kube_node_pools/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: kube_node_pool_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - kube_node_pool + /kube_node_pools/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: kube_node_pool_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - kube_node_pool + /kube_nodes: + get: + description: 列表 + operationId: kube_node_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/kube_node_ListItemFilterOutput' + summary: Kube Node列表 + tags: + - kube_node + post: + description: 新建 + operationId: kube_node_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + kube_node: + $ref: '#/definitions/KubeNodeCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_ValidateCreateDataOutput' + summary: 新建 + tags: + - kube_node + /kube_nodes/{id}: + delete: + description: 删除 + operationId: kube_node_CustomizeDelete + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_CustomizeDeleteOutput' + summary: 删除 + tags: + - kube_node + get: + description: 获取详情 + operationId: kube_node_FetchCustomizeColumns + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - kube_node + put: + description: 更新 + operationId: kube_node_ValidateUpdateData + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_ValidateUpdateDataOutput' + summary: 更新 + tags: + - kube_node + /kube_nodes/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: kube_node_GetDetailsClassMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - kube_node + post: + description: 执行操作ClassMetadata + operationId: kube_node_PerformClassMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - kube_node + /kube_nodes/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: kube_node_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 kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - kube_node + /kube_nodes/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: kube_node_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - kube_node + /kube_nodes/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: kube_node_PerformSetClassMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kube_node + /kube_nodes/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: kube_node_PerformSetOrgMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kube_node + /kube_nodes/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: kube_node_PerformSetUserMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - kube_node + /kube_nodes/{id}/status: + get: + description: 获取指定信息Status + operationId: kube_node_GetDetailsStatus + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - kube_node + post: + description: 执行操作Status + operationId: kube_node_PerformStatus + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformStatusOutput' + summary: 更新资源状态 + tags: + - kube_node + /kube_nodes/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: kube_node_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/kube_node_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - kube_node + /kube_nodes/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: kube_node_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + kube_node: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - kube_node + /kube_nodes/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: kube_node_GetPropertySplitable + responses: + "200": + $ref: '#/responses/kube_node_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - kube_node + /kube_nodes/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: kube_node_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/kube_node_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - kube_node + /kube_nodes/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: kube_node_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/kube_node_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - kube_node + /kube_nodes/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: kube_node_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/kube_node_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - kube_node + /kube_nodes/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: kube_node_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/kube_node_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - kube_node + /loadbalancer_acls: + get: + description: 列表 + operationId: loadbalancer_acl_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/loadbalancer_acl_ListItemFilterOutput' + summary: 负载均衡ACL规则列表 + tags: + - loadbalancer_acl + post: + description: 新建 + operationId: loadbalancer_acl_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}: + delete: + description: 删除 + operationId: loadbalancer_acl_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_acl + get: + description: 获取详情 + operationId: loadbalancer_acl_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_acl + put: + description: 更新 + operationId: loadbalancer_acl_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: loadbalancer_acl_PerformCancelDelete + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: loadbalancer_acl_PerformChangeOwner + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: loadbalancer_acl_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_acl_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_acl + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_acl_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/freeze: + post: + description: 执行操作Freeze + operationId: loadbalancer_acl_PerformFreeze + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_acl_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 loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: loadbalancer_acl_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/patch: + post: + description: This is intended mainly for command line operations. + operationId: loadbalancer_acl_PerformPatch + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclPatchInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPatchOutput' + summary: PerformPatch patches acl entries by adding then deleting the specified acls. + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/private: + post: + description: 执行操作Private + operationId: loadbalancer_acl_PerformPrivate + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPrivateOutput' + summary: 执行操作Private + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/public: + post: + description: 执行操作Public + operationId: loadbalancer_acl_PerformPublic + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPublicOutput' + summary: 执行操作Public + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_acl_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_acl_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: loadbalancer_acl_PerformSetOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_acl_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_acl_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_acl + post: + description: 执行操作Status + operationId: loadbalancer_acl_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: loadbalancer_acl_PerformSyncstatus + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: loadbalancer_acl_PerformUnfreeze + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - loadbalancer_acl + /loadbalancer_acls/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_acl_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_acl + /loadbalancer_acls/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: loadbalancer_acl_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - loadbalancer_acl + /loadbalancer_acls/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: loadbalancer_acl_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - loadbalancer_acl + /loadbalancer_acls/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: loadbalancer_acl_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - loadbalancer_acl + /loadbalancer_acls/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: loadbalancer_acl_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - loadbalancer_acl + /loadbalancer_acls/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_acl_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_acl + /loadbalancer_acls/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_acl_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_acl + /loadbalancer_acls/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_acl_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/loadbalancer_acl_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_acl + /loadbalancer_acls/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_acl_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_acl + /loadbalancer_acls/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_acl_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_acl + /loadbalancer_acls/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_acl_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_acl + /loadbalancer_agents: + get: + description: 列表 + operationId: loadbalancer_agent_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: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 负载均衡集群ID或名称 + in: query + name: cluster_id + type: string + x-go-name: ClusterId + - description: 以负载均衡集群排序 + in: query + name: order_by_cluster + type: string + x-go-name: OrderByCluster + - in: query + items: + type: string + name: version + type: array + x-go-name: Version + - in: query + items: + type: string + name: ip + type: array + x-go-name: IP + - in: query + items: + type: string + name: ha_state + type: array + x-go-name: HaState + responses: + "200": + $ref: '#/responses/loadbalancer_agent_ListItemFilterOutput' + summary: 负载均衡Agent列表 + tags: + - loadbalancer_agent + post: + description: 新建 + operationId: loadbalancer_agent_ValidateCreateData + responses: + "200": + $ref: '#/responses/loadbalancer_agent_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}: + delete: + description: 删除 + operationId: loadbalancer_agent_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_agent + get: + description: 获取详情 + operationId: loadbalancer_agent_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_agent + put: + description: 更新 + operationId: loadbalancer_agent_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_agent_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_agent + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_agent_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/deploy: + post: + description: 执行操作Deploy + operationId: loadbalancer_agent_PerformDeploy + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDeployInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformDeployOutput' + summary: 执行操作Deploy + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/hb: + post: + description: 执行操作Hb + operationId: loadbalancer_agent_PerformHb + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformHbOutput' + summary: 执行操作Hb + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/join-cluster: + post: + description: 执行操作JoinCluster + operationId: loadbalancer_agent_PerformJoinCluster + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentJoinClusterInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformJoinClusterOutput' + summary: 执行操作JoinCluster + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/leave-cluster: + post: + description: 执行操作LeaveCluster + operationId: loadbalancer_agent_PerformLeaveCluster + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentLeaveClusterInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformLeaveClusterOutput' + summary: 执行操作LeaveCluster + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_agent_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 loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: loadbalancer_agent_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/params-patch: + post: + description: 执行操作ParamsPatch + operationId: loadbalancer_agent_PerformParamsPatch + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformParamsPatchOutput' + summary: 执行操作ParamsPatch + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_agent_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: loadbalancer_agent_PerformSetOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_agent_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/undeploy: + post: + description: 执行操作Undeploy + operationId: loadbalancer_agent_PerformUndeploy + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformUndeployOutput' + summary: 执行操作Undeploy + tags: + - loadbalancer_agent + /loadbalancer_agents/default-params: + get: + description: 获取指定资源类的信息DefaultParams + operationId: loadbalancer_agent_GetPropertyDefaultParams + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertyDefaultParamsOutput' + summary: 获取指定资源类的信息DefaultParams + tags: + - loadbalancer_agent + /loadbalancer_agents/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_agent_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_agent + /loadbalancer_agents/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_agent_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_agent + /loadbalancer_agents/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_agent_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_agent + /loadbalancer_agents/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_agent_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/loadbalancer_agent_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_agent + /loadbalancer_agents/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_agent_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_agent + /loadbalancer_agents/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_agent_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_agent + /loadbalancer_backend_groups: + get: + description: 列表 + operationId: loadbalancer_backend_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: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: filter LoadbalancerBackendGroup with no reference + in: query + name: no_ref + type: boolean + x-go-name: NoRef + - in: query + items: + type: string + name: type + type: array + x-go-name: Type + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_ListItemFilterOutput' + summary: 负载均衡后端服务器组列表 + tags: + - loadbalancer_backend_group + post: + description: 新建 + operationId: loadbalancer_backend_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}: + delete: + description: 删除 + operationId: loadbalancer_backend_group_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_backend_group + get: + description: 获取详情 + operationId: loadbalancer_backend_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_backend_group + put: + description: 更新 + operationId: loadbalancer_backend_group_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_backend_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_backend_group + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_backend_group_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_backend_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 loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: loadbalancer_backend_group_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_backend_group_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_backend_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: loadbalancer_backend_group_PerformSetOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_backend_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_backend_group_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_backend_group + post: + description: 执行操作Status + operationId: loadbalancer_backend_group_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_backend_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_backend_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_backend_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_backend_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/loadbalancer_backend_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_backend_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_backend_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_backend_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_backend_group + /loadbalancer_backends: + get: + description: 列表 + operationId: loadbalancer_backend_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: 负载均衡后端组ID或名称 + in: query + name: backend_group_id + type: string + x-go-name: BackendGroupId + - description: 以负载均衡后端组名称排序 + in: query + name: order_by_backend_group + type: string + x-go-name: OrderByBackendGroup + - description: filter by backend server + in: query + name: backend + type: string + x-go-name: Backend + - in: query + items: + type: string + name: backend_type + type: array + x-go-name: BackendType + - in: query + items: + type: string + name: backend_role + type: array + x-go-name: BackendRole + - in: query + items: + type: string + name: address + type: array + x-go-name: Address + - in: query + items: + type: string + name: send_proxy + type: array + x-go-name: SendProxy + - in: query + items: + type: string + name: ssl + type: array + x-go-name: Ssl + responses: + "200": + $ref: '#/responses/loadbalancer_backend_ListItemFilterOutput' + summary: 负载均衡后端列表 + tags: + - loadbalancer_backend + post: + description: 新建 + operationId: loadbalancer_backend_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}: + delete: + description: 删除 + operationId: loadbalancer_backend_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_backend + get: + description: 获取详情 + operationId: loadbalancer_backend_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_backend + put: + description: 更新 + operationId: loadbalancer_backend_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_backend_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_backend + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_backend_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_backend_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 loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: loadbalancer_backend_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_backend_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_backend_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: loadbalancer_backend_PerformSetOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_backend_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_backend_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_backend + post: + description: 执行操作Status + operationId: loadbalancer_backend_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_backend + /loadbalancer_backends/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_backend_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_backend + /loadbalancer_backends/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_backend_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_backend + /loadbalancer_backends/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_backend_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_backend + /loadbalancer_backends/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_backend_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/loadbalancer_backend_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_backend + /loadbalancer_backends/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_backend_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_backend + /loadbalancer_backends/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_backend_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_backend + /loadbalancer_backends/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_backend_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_backend + /loadbalancer_certificates: + get: + description: 列表 + operationId: loadbalancer_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 + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + items: + type: string + name: common_name + type: array + x-go-name: CommonName + - in: query + items: + type: string + name: subject_alternative_names + type: array + x-go-name: SubjectAlternativeNames + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_ListItemFilterOutput' + summary: 列表 + tags: + - loadbalancer_certificate + post: + description: 新建 + operationId: loadbalancer_certificate_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}: + delete: + description: 删除 + operationId: loadbalancer_certificate_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_certificate + get: + description: 获取详情 + operationId: loadbalancer_certificate_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_certificate + put: + description: 更新 + operationId: loadbalancer_certificate_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: loadbalancer_certificate_PerformCancelDelete + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: loadbalancer_certificate_PerformChangeOwner + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: loadbalancer_certificate_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_certificate_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_certificate + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_certificate_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/freeze: + post: + description: 执行操作Freeze + operationId: loadbalancer_certificate_PerformFreeze + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_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 loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: loadbalancer_certificate_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/private: + post: + description: 执行操作Private + operationId: loadbalancer_certificate_PerformPrivate + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformPrivateOutput' + summary: 执行操作Private + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/public: + post: + description: 执行操作Public + operationId: loadbalancer_certificate_PerformPublic + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformPublicOutput' + summary: 执行操作Public + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_certificate_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: loadbalancer_certificate_PerformSetOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_certificate_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_certificate_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_certificate + post: + description: 执行操作Status + operationId: loadbalancer_certificate_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: loadbalancer_certificate_PerformSyncstatus + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: loadbalancer_certificate_PerformUnfreeze + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - loadbalancer_certificate + /loadbalancer_certificates/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_certificate_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_certificate + /loadbalancer_certificates/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: loadbalancer_certificate_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - loadbalancer_certificate + /loadbalancer_certificates/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: loadbalancer_certificate_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - loadbalancer_certificate + /loadbalancer_certificates/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: loadbalancer_certificate_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - loadbalancer_certificate + /loadbalancer_certificates/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: loadbalancer_certificate_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - loadbalancer_certificate + /loadbalancer_certificates/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_certificate_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_certificate + /loadbalancer_certificates/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_certificate_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_certificate + /loadbalancer_certificates/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_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/loadbalancer_certificate_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_certificate + /loadbalancer_certificates/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_certificate_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_certificate + /loadbalancer_certificates/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_certificate_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_certificate + /loadbalancer_certificates/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_certificate_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_certificate + /loadbalancer_clusters: + get: + description: 列表 + operationId: loadbalancer_cluster_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: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_ListItemFilterOutput' + summary: 负载均衡集群列表 + tags: + - loadbalancer_cluster + post: + description: 新建 + operationId: loadbalancer_cluster_ValidateCreateData + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}: + delete: + description: 删除 + operationId: loadbalancer_cluster_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_cluster + get: + description: 获取详情 + operationId: loadbalancer_cluster_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_cluster + put: + description: 更新 + operationId: loadbalancer_cluster_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_cluster_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_cluster + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_cluster_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_cluster_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 loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: loadbalancer_cluster_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/params-patch: + post: + description: 执行操作ParamsPatch + operationId: loadbalancer_cluster_PerformParamsPatch + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformParamsPatchOutput' + summary: 执行操作ParamsPatch + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_cluster_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: loadbalancer_cluster_PerformSetOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_cluster_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_cluster_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_cluster + /loadbalancer_clusters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_cluster_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_cluster + /loadbalancer_clusters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_cluster_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_cluster + /loadbalancer_clusters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_cluster_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/loadbalancer_cluster_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_cluster + /loadbalancer_clusters/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_cluster_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_cluster + /loadbalancer_clusters/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_cluster_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_cluster + /loadbalancer_listener_rules: + get: + description: 列表 + operationId: loadbalancer_listener_rule_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: 负载均衡监听器 + in: query + name: listener_id + type: string + x-go-name: ListenerId + - description: 以负载均衡监听器名称排序 + in: query + name: order_by_listener + type: string + x-go-name: OrderByListener + - description: filter by backend_group + in: query + name: backend_group + type: string + x-go-name: BackendGroup + - description: 默认转发策略，目前只有aws用到其它云都是false + in: query + name: is_default + type: boolean + x-go-name: IsDefault + - in: query + items: + type: string + name: domain + type: array + x-go-name: Domain + - in: query + items: + type: string + name: path + type: array + x-go-name: Path + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_ListItemFilterOutput' + summary: 负载均衡监听器规则列表 + tags: + - loadbalancer_listener_rule + post: + description: 新建 + operationId: loadbalancer_listener_rule_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}: + delete: + description: 删除 + operationId: loadbalancer_listener_rule_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_listener_rule + get: + description: 获取详情 + operationId: loadbalancer_listener_rule_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_listener_rule + put: + description: 更新 + operationId: loadbalancer_listener_rule_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/backend-status: + get: + description: 获取指定信息BackendStatus + operationId: loadbalancer_listener_rule_GetDetailsBackendStatus + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetDetailsBackendStatusOutput' + summary: 获取指定信息BackendStatus + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_listener_rule_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_listener_rule + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_listener_rule_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_listener_rule_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 loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: loadbalancer_listener_rule_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_listener_rule_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_listener_rule_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: loadbalancer_listener_rule_PerformSetOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_listener_rule_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_listener_rule_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_listener_rule + post: + description: 执行操作Status + operationId: loadbalancer_listener_rule_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_listener_rule_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_listener_rule_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_listener_rule_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_listener_rule_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/loadbalancer_listener_rule_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_listener_rule_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_listener_rule_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_listener_rule_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_listener_rule + /loadbalancer_listeners: + get: + description: 列表 + operationId: loadbalancer_listener_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: ACL名称或ID + in: query + name: acl_id + type: string + x-go-name: AclId + - description: filter by backend_group + in: query + name: backend_group + type: string + x-go-name: BackendGroup + - in: query + items: + type: string + name: listener_type + type: array + x-go-name: ListenerType + - in: query + items: + format: int64 + type: integer + name: listener_port + type: array + x-go-name: ListenerPort + - in: query + items: + type: string + name: scheduler + type: array + x-go-name: Scheduler + - in: query + items: + type: string + name: certificate_id + type: array + x-go-name: Certificate + - in: query + items: + type: string + name: send_proxy + type: array + x-go-name: SendProxy + - in: query + items: + type: string + name: acl_status + type: array + x-go-name: AclStatus + - in: query + items: + type: string + name: acl_type + type: array + x-go-name: AclType + responses: + "200": + $ref: '#/responses/loadbalancer_listener_ListItemFilterOutput' + summary: 负载均衡监听器Listener列表 + tags: + - loadbalancer_listener + post: + description: 新建 + operationId: loadbalancer_listener_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}: + delete: + description: 删除 + operationId: loadbalancer_listener_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_listener + get: + description: 获取详情 + operationId: loadbalancer_listener_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_listener + put: + description: 更新 + operationId: loadbalancer_listener_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/backend-status: + get: + description: 获取指定信息BackendStatus + operationId: loadbalancer_listener_GetDetailsBackendStatus + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetDetailsBackendStatusOutput' + summary: 获取指定信息BackendStatus + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_listener_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_listener + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_listener_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_listener_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 loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: loadbalancer_listener_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_listener_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_listener_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: loadbalancer_listener_PerformSetOrgMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_listener_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_listener_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_listener + post: + description: 执行操作Status + operationId: loadbalancer_listener_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformStatusOutput' + summary: 执行操作Status + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/sync: + post: + description: 执行操作Sync + operationId: loadbalancer_listener_PerformSync + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformSyncOutput' + summary: 执行操作Sync + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: loadbalancer_listener_PerformSyncstatus + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - loadbalancer_listener + /loadbalancer_listeners/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_listener_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_listener + /loadbalancer_listeners/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_listener_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_listener + /loadbalancer_listeners/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_listener_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_listener + /loadbalancer_listeners/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_listener_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/loadbalancer_listener_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_listener + /loadbalancer_listeners/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_listener_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_listener + /loadbalancer_listeners/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_listener_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_listener + /loadbalancer_listeners/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_listener_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_listener + /loadbalancer_security_groups: + get: + description: 列表 + operationId: loadbalancer_security_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 + responses: + "200": + $ref: '#/responses/loadbalancer_security_group_ListItemFilterOutput' + summary: 列表 + tags: + - loadbalancer_security_group + post: + description: 新建 + operationId: loadbalancer_security_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_security_group: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_security_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_security_group + /loadbalancer_security_groups/{id}: + delete: + description: 删除 + operationId: loadbalancer_security_group_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_security_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_security_group + get: + description: 获取详情 + operationId: loadbalancer_security_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_security_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_security_group + put: + description: 更新 + operationId: loadbalancer_security_group_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_security_group: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_security_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_security_group + /loadbalancer_security_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_security_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_security_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_security_group + /loadbalancer_security_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_security_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_security_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_security_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_security_group + /loadbalancer_security_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_security_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_security_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_security_group + /loadbalancer_security_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_security_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/loadbalancer_security_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_security_group + /loadbalancers: + get: + description: 列表 + operationId: loadbalancer_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: filter by cluster + in: query + name: cluster + type: string + x-go-name: Cluster + - in: query + items: + type: string + name: address + type: array + x-go-name: Address + - description: 地址类型 + in: query + items: + type: string + name: address_type + type: array + x-go-name: AddressType + - description: 网络类型 + in: query + items: + type: string + name: network_type + type: array + x-go-name: NetworkType + - description: 计费类型 + in: query + items: + type: string + name: charge_type + type: array + x-go-name: ChargeType + - description: 套餐名称 + in: query + items: + type: string + name: loadbalancer_spec + type: array + x-go-name: LoadbalancerSpec + - description: filter by security group + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: filter for EIP + in: query + name: with_eip + type: boolean + x-go-name: WithEip + - in: query + name: without_eip + type: boolean + x-go-name: WithoutEip + - in: query + name: eip_associable + type: boolean + x-go-name: EipAssociable + - in: query + name: usable_loadbalancer_for_eip + type: string + x-go-name: UsableLoadbalancerForEip + responses: + "200": + $ref: '#/responses/loadbalancer_ListItemFilterOutput' + summary: 负载均衡实例列表 + tags: + - loadbalancer + post: + description: 新建 + operationId: loadbalancer_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer: + $ref: '#/definitions/LoadbalancerCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer + /loadbalancers/{id}: + delete: + description: 删除 + operationId: loadbalancer_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer + get: + description: 获取详情 + operationId: loadbalancer_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer + put: + description: 更新 + operationId: loadbalancer_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer + /loadbalancers/{id}/associate-eip: + post: + description: 执行操作AssociateEip + operationId: loadbalancer_PerformAssociateEip + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerAssociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformAssociateEipOutput' + summary: 绑定弹性公网IP, 仅支持kvm + tags: + - loadbalancer + /loadbalancers/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: loadbalancer_PerformCancelDelete + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - loadbalancer + /loadbalancers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: loadbalancer_PerformChangeOwner + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - loadbalancer + /loadbalancers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: loadbalancer_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - loadbalancer + /loadbalancers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer + /loadbalancers/{id}/create-eip: + post: + description: 执行操作CreateEip + operationId: loadbalancer_PerformCreateEip + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerCreateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformCreateEipOutput' + summary: 执行操作CreateEip + tags: + - loadbalancer + /loadbalancers/{id}/dissociate-eip: + post: + description: 执行操作DissociateEip + operationId: loadbalancer_PerformDissociateEip + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDissociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformDissociateEipOutput' + summary: 解绑弹性公网IP，仅支持kvm + tags: + - loadbalancer + /loadbalancers/{id}/freeze: + post: + description: 执行操作Freeze + operationId: loadbalancer_PerformFreeze + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - loadbalancer + /loadbalancers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_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 loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer + /loadbalancers/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: loadbalancer_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - loadbalancer + /loadbalancers/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_PerformPurge + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer + /loadbalancers/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: loadbalancer_PerformRemoteUpdate + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - loadbalancer + /loadbalancers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer + /loadbalancers/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: loadbalancer_PerformSetOrgMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer + /loadbalancers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer + /loadbalancers/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer + post: + description: 执行操作Status + operationId: loadbalancer_PerformStatus + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformStatusOutput' + summary: 执行操作Status + tags: + - loadbalancer + /loadbalancers/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: loadbalancer_PerformSyncstatus + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - loadbalancer + /loadbalancers/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: loadbalancer_PerformUnfreeze + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - loadbalancer + /loadbalancers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer + /loadbalancers/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: loadbalancer_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - loadbalancer + /loadbalancers/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: loadbalancer_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - loadbalancer + /loadbalancers/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: loadbalancer_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - loadbalancer + /loadbalancers/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: loadbalancer_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - loadbalancer + /loadbalancers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer + /loadbalancers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer + /loadbalancers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_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/loadbalancer_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer + /loadbalancers/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer + /loadbalancers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer + /loadbalancers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer + /misc_resources: + get: + description: 列表 + operationId: misc_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 + - $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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/misc_resource_ListItemFilterOutput' + summary: 列出Misc Resource + tags: + - misc_resource + post: + description: 新建 + operationId: misc_resource_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + misc_resource: + $ref: '#/definitions/MiscResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_ValidateCreateDataOutput' + summary: 新建 + tags: + - misc_resource + /misc_resources/{id}: + delete: + description: 删除 + operationId: misc_resource_CustomizeDelete + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_CustomizeDeleteOutput' + summary: 删除 + tags: + - misc_resource + get: + description: 获取详情 + operationId: misc_resource_FetchCustomizeColumns + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - misc_resource + put: + description: 更新 + operationId: misc_resource_ValidateUpdateData + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_ValidateUpdateDataOutput' + summary: 更新 + tags: + - misc_resource + /misc_resources/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: misc_resource_PerformCancelDelete + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - misc_resource + /misc_resources/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: misc_resource_PerformChangeOwner + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - misc_resource + /misc_resources/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: misc_resource_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - misc_resource + /misc_resources/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: misc_resource_GetDetailsClassMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - misc_resource + post: + description: 执行操作ClassMetadata + operationId: misc_resource_PerformClassMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - misc_resource + /misc_resources/{id}/freeze: + post: + description: 执行操作Freeze + operationId: misc_resource_PerformFreeze + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - misc_resource + /misc_resources/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: misc_resource_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 misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - misc_resource + /misc_resources/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: misc_resource_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - misc_resource + /misc_resources/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: misc_resource_PerformSetClassMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - misc_resource + /misc_resources/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: misc_resource_PerformSetOrgMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - misc_resource + /misc_resources/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: misc_resource_PerformSetUserMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - misc_resource + /misc_resources/{id}/status: + get: + description: 获取指定信息Status + operationId: misc_resource_GetDetailsStatus + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - misc_resource + post: + description: 执行操作Status + operationId: misc_resource_PerformStatus + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformStatusOutput' + summary: 更新资源状态 + tags: + - misc_resource + /misc_resources/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: misc_resource_PerformUnfreeze + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - misc_resource + /misc_resources/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: misc_resource_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - misc_resource + /misc_resources/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: misc_resource_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - misc_resource + /misc_resources/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: misc_resource_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - misc_resource + /misc_resources/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: misc_resource_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - misc_resource + /misc_resources/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: misc_resource_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - misc_resource + /misc_resources/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: misc_resource_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - misc_resource + /misc_resources/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: misc_resource_GetPropertySplitable + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - misc_resource + /misc_resources/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: misc_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/misc_resource_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - misc_resource + /misc_resources/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: misc_resource_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - misc_resource + /misc_resources/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: misc_resource_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - misc_resource + /misc_resources/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: misc_resource_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - misc_resource + /modelarts_pool_skus: + get: + description: 列表 + operationId: modelarts_pool_sku_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - in: query + name: ProcessorType + type: string + - in: query + name: CpuArch + type: string + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_ListItemFilterOutput' + summary: 列表 + tags: + - modelarts_pool_sku + post: + description: 新建 + operationId: modelarts_pool_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + modelarts_pool_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}: + delete: + description: 删除 + operationId: modelarts_pool_sku_CustomizeDelete + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - modelarts_pool_sku + get: + description: 获取详情 + operationId: modelarts_pool_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - modelarts_pool_sku + put: + description: 更新 + operationId: modelarts_pool_sku_ValidateUpdateData + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: modelarts_pool_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - modelarts_pool_sku + post: + description: 执行操作ClassMetadata + operationId: modelarts_pool_sku_PerformClassMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: modelarts_pool_sku_PerformDisable + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: modelarts_pool_sku_PerformEnable + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: modelarts_pool_sku_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 modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: modelarts_pool_sku_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: modelarts_pool_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: modelarts_pool_sku_PerformSetOrgMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: modelarts_pool_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: modelarts_pool_sku_GetDetailsStatus + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - modelarts_pool_sku + post: + description: 执行操作Status + operationId: modelarts_pool_sku_PerformStatus + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: modelarts_pool_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - modelarts_pool_sku + /modelarts_pool_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: modelarts_pool_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - modelarts_pool_sku + /modelarts_pool_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: modelarts_pool_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - modelarts_pool_sku + /modelarts_pool_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: modelarts_pool_sku_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/modelarts_pool_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - modelarts_pool_sku + /modelarts_pool_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: modelarts_pool_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - modelarts_pool_sku + /modelarts_pool_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: modelarts_pool_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - modelarts_pool_sku + /modelarts_pool_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: modelarts_pool_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - modelarts_pool_sku + /modelarts_pools: + get: + description: 列表 + operationId: modelarts_pool_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + responses: + "200": + $ref: '#/responses/modelarts_pool_ListItemFilterOutput' + summary: Pool实例列表 + tags: + - modelarts_pool + post: + description: 新建 + operationId: modelarts_pool_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + modelarts_pool: + $ref: '#/definitions/ModelartsPoolCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_ValidateCreateDataOutput' + summary: 新建 + tags: + - modelarts_pool + /modelarts_pools/{id}: + delete: + description: 删除 + operationId: modelarts_pool_CustomizeDelete + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_CustomizeDeleteOutput' + summary: 进入删除任务 + tags: + - modelarts_pool + get: + description: 获取详情 + operationId: modelarts_pool_FetchCustomizeColumns + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - modelarts_pool + put: + description: 更新 + operationId: modelarts_pool_ValidateUpdateData + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_ValidateUpdateDataOutput' + summary: 更新 + tags: + - modelarts_pool + /modelarts_pools/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: modelarts_pool_PerformCancelDelete + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - modelarts_pool + /modelarts_pools/{id}/change-config: + post: + description: 执行操作ChangeConfig + operationId: modelarts_pool_PerformChangeConfig + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolChangeConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformChangeConfigOutput' + summary: 执行操作ChangeConfig + tags: + - modelarts_pool + /modelarts_pools/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: modelarts_pool_PerformChangeOwner + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - modelarts_pool + /modelarts_pools/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: modelarts_pool_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - modelarts_pool + /modelarts_pools/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: modelarts_pool_GetDetailsClassMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - modelarts_pool + post: + description: 执行操作ClassMetadata + operationId: modelarts_pool_PerformClassMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - modelarts_pool + /modelarts_pools/{id}/freeze: + post: + description: 执行操作Freeze + operationId: modelarts_pool_PerformFreeze + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - modelarts_pool + /modelarts_pools/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: modelarts_pool_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 modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - modelarts_pool + /modelarts_pools/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: modelarts_pool_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - modelarts_pool + /modelarts_pools/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: modelarts_pool_PerformSetClassMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - modelarts_pool + /modelarts_pools/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: modelarts_pool_PerformSetOrgMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - modelarts_pool + /modelarts_pools/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: modelarts_pool_PerformSetUserMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - modelarts_pool + /modelarts_pools/{id}/status: + get: + description: 获取指定信息Status + operationId: modelarts_pool_GetDetailsStatus + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - modelarts_pool + post: + description: 执行操作Status + operationId: modelarts_pool_PerformStatus + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformStatusOutput' + summary: 更新资源状态 + tags: + - modelarts_pool + /modelarts_pools/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: modelarts_pool_PerformSyncstatus + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - modelarts_pool + /modelarts_pools/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: modelarts_pool_PerformUnfreeze + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - modelarts_pool + /modelarts_pools/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: modelarts_pool_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - modelarts_pool + /modelarts_pools/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: modelarts_pool_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - modelarts_pool + /modelarts_pools/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: modelarts_pool_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - modelarts_pool + /modelarts_pools/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: modelarts_pool_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - modelarts_pool + /modelarts_pools/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: modelarts_pool_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - modelarts_pool + /modelarts_pools/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: modelarts_pool_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - modelarts_pool + /modelarts_pools/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: modelarts_pool_GetPropertySplitable + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - modelarts_pool + /modelarts_pools/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: modelarts_pool_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/modelarts_pool_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - modelarts_pool + /modelarts_pools/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: modelarts_pool_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - modelarts_pool + /modelarts_pools/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: modelarts_pool_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - modelarts_pool + /modelarts_pools/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: modelarts_pool_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - modelarts_pool + /mongo_dbs: + get: + description: 列表 + operationId: mongo_db_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - format: int64 + in: query + name: vcpu_count + type: integer + x-go-name: VcpuCount + - format: int64 + in: query + name: vmem_size_mb + type: integer + x-go-name: VmemSizeMb + - in: query + name: category + type: string + x-go-name: Category + - in: query + name: engine + type: string + x-go-name: Engine + - in: query + name: engine_version + type: string + x-go-name: EngineVersion + - in: query + name: instance_type + type: string + x-go-name: InstanceType + responses: + "200": + $ref: '#/responses/mongo_db_ListItemFilterOutput' + summary: MongoDB实例列表 + tags: + - mongo_db + post: + description: 新建 + operationId: mongo_db_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + mongo_db: + $ref: '#/definitions/MongoDBCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_ValidateCreateDataOutput' + summary: 新建 + tags: + - mongo_db + /mongo_dbs/{id}: + delete: + description: 删除 + operationId: mongo_db_CustomizeDelete + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_CustomizeDeleteOutput' + summary: 删除 + tags: + - mongo_db + get: + description: 获取详情 + operationId: mongo_db_FetchCustomizeColumns + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - mongo_db + put: + description: 更新 + operationId: mongo_db_ValidateUpdateData + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_ValidateUpdateDataOutput' + summary: 更新 + tags: + - mongo_db + /mongo_dbs/{id}/backups: + get: + description: 获取指定信息Backups + operationId: mongo_db_GetDetailsBackups + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsBackupsOutput' + summary: 获取备份列表 + tags: + - mongo_db + /mongo_dbs/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: mongo_db_PerformCancelDelete + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - mongo_db + /mongo_dbs/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: mongo_db_PerformCancelExpire + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_PerformCancelExpireOutput' + summary: 执行操作CancelExpire + tags: + - mongo_db + /mongo_dbs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: mongo_db_PerformChangeOwner + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - mongo_db + /mongo_dbs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: mongo_db_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - mongo_db + /mongo_dbs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: mongo_db_GetDetailsClassMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - mongo_db + post: + description: 执行操作ClassMetadata + operationId: mongo_db_PerformClassMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - mongo_db + /mongo_dbs/{id}/freeze: + post: + description: 执行操作Freeze + operationId: mongo_db_PerformFreeze + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - mongo_db + /mongo_dbs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: mongo_db_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 mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - mongo_db + /mongo_dbs/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: mongo_db_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - mongo_db + /mongo_dbs/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: mongo_db_PerformPostpaidExpire + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformPostpaidExpireOutput' + summary: 执行操作PostpaidExpire + tags: + - mongo_db + /mongo_dbs/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: mongo_db_PerformRemoteUpdate + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - mongo_db + /mongo_dbs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: mongo_db_PerformSetClassMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - mongo_db + /mongo_dbs/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: mongo_db_PerformSetOrgMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - mongo_db + /mongo_dbs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: mongo_db_PerformSetUserMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - mongo_db + /mongo_dbs/{id}/status: + get: + description: 获取指定信息Status + operationId: mongo_db_GetDetailsStatus + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - mongo_db + post: + description: 执行操作Status + operationId: mongo_db_PerformStatus + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformStatusOutput' + summary: 更新资源状态 + tags: + - mongo_db + /mongo_dbs/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: mongo_db_PerformSyncstatus + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_PerformSyncstatusOutput' + summary: 同步MongoDB实例状态 + tags: + - mongo_db + /mongo_dbs/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: mongo_db_PerformUnfreeze + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - mongo_db + /mongo_dbs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: mongo_db_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - mongo_db + /mongo_dbs/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: mongo_db_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - mongo_db + /mongo_dbs/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: mongo_db_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - mongo_db + /mongo_dbs/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: mongo_db_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - mongo_db + /mongo_dbs/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: mongo_db_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - mongo_db + /mongo_dbs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: mongo_db_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - mongo_db + /mongo_dbs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: mongo_db_GetPropertySplitable + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - mongo_db + /mongo_dbs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: mongo_db_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/mongo_db_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - mongo_db + /mongo_dbs/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: mongo_db_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - mongo_db + /mongo_dbs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: mongo_db_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - mongo_db + /mongo_dbs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: mongo_db_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - mongo_db + /mount_targets: + get: + description: 列表 + operationId: mount_target_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 权限组Id + in: query + name: access_group_id + type: string + x-go-name: AccessGroupId + - description: 以权限组排序 + in: query + name: order_by_access_group + type: string + x-go-name: OrderByAccessGroup + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: 文件系统Id + in: query + name: file_system_id + type: string + x-go-name: FileSystemId + responses: + "200": + $ref: '#/responses/mount_target_ListItemFilterOutput' + summary: 列表 + tags: + - mount_target + post: + description: 新建 + operationId: mount_target_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + mount_target: + $ref: '#/definitions/MountTargetCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_ValidateCreateDataOutput' + summary: 新建 + tags: + - mount_target + /mount_targets/{id}: + delete: + description: 删除 + operationId: mount_target_CustomizeDelete + parameters: + - default: false + description: 是否越过回收站直接删除 + in: query + name: OverridePendingDelete + type: boolean + - default: false + description: 是否仅删除本地资源 + in: query + name: Purge + type: boolean + - default: false + description: 是否删除快照 + in: query + name: DeleteSnapshots + type: boolean + - default: false + description: 是否删除关联的EIP + in: query + name: DeleteEip + type: boolean + - default: false + description: 是否删除关联的数据盘 + in: query + name: DeleteDisks + type: boolean + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/NatgatewayDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_CustomizeDeleteOutput' + summary: 删除挂载点 + tags: + - mount_target + get: + description: 获取详情 + operationId: mount_target_FetchCustomizeColumns + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mount_target_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - mount_target + put: + description: 更新 + operationId: mount_target_ValidateUpdateData + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_ValidateUpdateDataOutput' + summary: 更新 + tags: + - mount_target + /mount_targets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: mount_target_GetDetailsClassMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mount_target_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - mount_target + post: + description: 执行操作ClassMetadata + operationId: mount_target_PerformClassMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - mount_target + /mount_targets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: mount_target_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 mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mount_target_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - mount_target + /mount_targets/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: mount_target_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mount_target_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - mount_target + /mount_targets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: mount_target_PerformSetClassMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - mount_target + /mount_targets/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: mount_target_PerformSetOrgMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - mount_target + /mount_targets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: mount_target_PerformSetUserMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - mount_target + /mount_targets/{id}/status: + get: + description: 获取指定信息Status + operationId: mount_target_GetDetailsStatus + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mount_target_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - mount_target + post: + description: 执行操作Status + operationId: mount_target_PerformStatus + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformStatusOutput' + summary: 更新资源状态 + tags: + - mount_target + /mount_targets/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: mount_target_PerformSyncstatus + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformSyncstatusOutput' + summary: 同步挂载点状态 + tags: + - mount_target + /mount_targets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: mount_target_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/mount_target_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - mount_target + /mount_targets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: mount_target_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - mount_target + /mount_targets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: mount_target_GetPropertySplitable + responses: + "200": + $ref: '#/responses/mount_target_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - mount_target + /mount_targets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: mount_target_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/mount_target_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - mount_target + /mount_targets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: mount_target_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/mount_target_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - mount_target + /mount_targets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: mount_target_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/mount_target_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - mount_target + /mount_targets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: mount_target_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/mount_target_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - mount_target + /nas_skus: + get: + description: 列表 + operationId: nas_sku_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - in: query + name: postpaid_stauts + type: string + x-go-name: PostpaidStatus + - in: query + name: prepaid_status + type: string + x-go-name: PrepaidStatus + - in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + responses: + "200": + $ref: '#/responses/nas_sku_ListItemFilterOutput' + summary: 列表 + tags: + - nas_sku + post: + description: 新建 + operationId: nas_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nas_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - nas_sku + /nas_skus/{id}: + delete: + description: 删除 + operationId: nas_sku_CustomizeDelete + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - nas_sku + get: + description: 获取详情 + operationId: nas_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nas_sku + put: + description: 更新 + operationId: nas_sku_ValidateUpdateData + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nas_sku + /nas_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nas_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nas_sku + post: + description: 执行操作ClassMetadata + operationId: nas_sku_PerformClassMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nas_sku + /nas_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: nas_sku_PerformDisable + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - nas_sku + /nas_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: nas_sku_PerformEnable + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - nas_sku + /nas_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nas_sku_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 nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nas_sku + /nas_skus/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: nas_sku_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - nas_sku + /nas_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nas_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nas_sku + /nas_skus/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: nas_sku_PerformSetOrgMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nas_sku + /nas_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nas_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nas_sku + /nas_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: nas_sku_GetDetailsStatus + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nas_sku + post: + description: 执行操作Status + operationId: nas_sku_PerformStatus + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nas_sku + /nas_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nas_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nas_sku + /nas_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nas_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nas_sku + /nas_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nas_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nas_sku + /nas_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nas_sku_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/nas_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nas_sku + /nas_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nas_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nas_sku + /nas_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: nas_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - nas_sku + /nas_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: nas_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - nas_sku + /nas_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nas_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nas_sku + /nas_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nas_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nas_sku + /nat_dentries: + get: + description: 列表 + operationId: nat_dentry_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: NAT网关ID or Name + in: query + name: natgateway_id + type: string + x-go-name: NatgatewayId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以NAT网关名字排序 + in: query + name: order_by_natgateway + type: string + x-go-name: OrderByNatgateway + - in: query + items: + type: string + name: external_ip + type: array + x-go-name: ExternalIP + - in: query + items: + format: int64 + type: integer + name: external_port + type: array + x-go-name: ExternalPort + - in: query + items: + type: string + name: internal_ip + type: array + x-go-name: InternalIP + - in: query + items: + format: int64 + type: integer + name: internal_port + type: array + x-go-name: InternalPort + - in: query + items: + type: string + name: ip_protocol + type: array + x-go-name: IpProtocol + responses: + "200": + $ref: '#/responses/nat_dentry_ListItemFilterOutput' + summary: NAT网关的目的地址转换规则列表 + tags: + - nat_dentry + post: + description: 新建 + operationId: nat_dentry_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_dentry: + $ref: '#/definitions/SNatDCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_dentry + /nat_dentries/{id}: + delete: + description: 删除 + operationId: nat_dentry_CustomizeDelete + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_CustomizeDeleteOutput' + summary: 删除 + tags: + - nat_dentry + get: + description: 获取详情 + operationId: nat_dentry_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_dentry + put: + description: 更新 + operationId: nat_dentry_ValidateUpdateData + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_dentry + /nat_dentries/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: nat_dentry_PerformChangeOwner + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - nat_dentry + /nat_dentries/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: nat_dentry_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - nat_dentry + /nat_dentries/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_dentry_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_dentry + post: + description: 执行操作ClassMetadata + operationId: nat_dentry_PerformClassMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_dentry + /nat_dentries/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_dentry_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 nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_dentry + /nat_dentries/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: nat_dentry_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - nat_dentry + /nat_dentries/{id}/private: + post: + description: 执行操作Private + operationId: nat_dentry_PerformPrivate + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformPrivateOutput' + summary: 执行操作Private + tags: + - nat_dentry + /nat_dentries/{id}/public: + post: + description: 执行操作Public + operationId: nat_dentry_PerformPublic + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformPublicOutput' + summary: 执行操作Public + tags: + - nat_dentry + /nat_dentries/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_dentry_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_dentry + /nat_dentries/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: nat_dentry_PerformSetOrgMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_dentry + /nat_dentries/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_dentry_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_dentry + /nat_dentries/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_dentry_GetDetailsStatus + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_dentry + post: + description: 执行操作Status + operationId: nat_dentry_PerformStatus + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_dentry + /nat_dentries/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_dentry_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_dentry + /nat_dentries/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: nat_dentry_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - nat_dentry + /nat_dentries/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: nat_dentry_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - nat_dentry + /nat_dentries/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_dentry_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_dentry + /nat_dentries/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_dentry_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_dentry + /nat_dentries/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_dentry_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/nat_dentry_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_dentry + /nat_dentries/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_dentry_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_dentry + /nat_dentries/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_dentry_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_dentry + /nat_dentries/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_dentry_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_dentry + /nat_entries: + get: + description: 列表 + operationId: nat_entry_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: NAT网关ID or Name + in: query + name: natgateway_id + type: string + x-go-name: NatgatewayId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以NAT网关名字排序 + in: query + name: order_by_natgateway + type: string + x-go-name: OrderByNatgateway + responses: + "200": + $ref: '#/responses/nat_entry_ListItemFilterOutput' + summary: NAT网关转发规则列表 + tags: + - nat_entry + post: + description: 新建 + operationId: nat_entry_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_entry: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_entry + /nat_entries/{id}: + delete: + description: 删除 + operationId: nat_entry_CustomizeDelete + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_CustomizeDeleteOutput' + summary: 删除 + tags: + - nat_entry + get: + description: 获取详情 + operationId: nat_entry_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_entry + put: + description: 更新 + operationId: nat_entry_ValidateUpdateData + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_entry + /nat_entries/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: nat_entry_PerformChangeOwner + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - nat_entry + /nat_entries/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: nat_entry_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - nat_entry + /nat_entries/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_entry_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_entry + post: + description: 执行操作ClassMetadata + operationId: nat_entry_PerformClassMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_entry + /nat_entries/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_entry_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 nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_entry + /nat_entries/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: nat_entry_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - nat_entry + /nat_entries/{id}/private: + post: + description: 执行操作Private + operationId: nat_entry_PerformPrivate + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformPrivateOutput' + summary: 执行操作Private + tags: + - nat_entry + /nat_entries/{id}/public: + post: + description: 执行操作Public + operationId: nat_entry_PerformPublic + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformPublicOutput' + summary: 执行操作Public + tags: + - nat_entry + /nat_entries/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_entry_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_entry + /nat_entries/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: nat_entry_PerformSetOrgMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_entry + /nat_entries/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_entry_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_entry + /nat_entries/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_entry_GetDetailsStatus + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_entry + post: + description: 执行操作Status + operationId: nat_entry_PerformStatus + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_entry + /nat_entries/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_entry_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_entry + /nat_entries/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: nat_entry_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - nat_entry + /nat_entries/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: nat_entry_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - nat_entry + /nat_entries/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_entry_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_entry + /nat_entries/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_entry_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_entry + /nat_entries/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_entry_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/nat_entry_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_entry + /nat_entries/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_entry_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_entry + /nat_entries/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_entry_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_entry + /nat_entries/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_entry_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_entry + /nat_gateways: + get: + description: 列表 + operationId: nat_gateway_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/nat_gateway_ListItemFilterOutput' + summary: NAT网关列表 + tags: + - nat_gateway + post: + description: 新建 + operationId: nat_gateway_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_gateway: + $ref: '#/definitions/NatgatewayCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_gateway + /nat_gateways/{id}: + delete: + description: 删除 + operationId: nat_gateway_CustomizeDelete + parameters: + - default: false + description: 是否越过回收站直接删除 + in: query + name: OverridePendingDelete + type: boolean + - default: false + description: 是否仅删除本地资源 + in: query + name: Purge + type: boolean + - default: false + description: 是否删除快照 + in: query + name: DeleteSnapshots + type: boolean + - default: false + description: 是否删除关联的EIP + in: query + name: DeleteEip + type: boolean + - default: false + description: 是否删除关联的数据盘 + in: query + name: DeleteDisks + type: boolean + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_CustomizeDeleteOutput' + summary: 删除NAT + tags: + - nat_gateway + get: + description: 获取详情 + operationId: nat_gateway_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_gateway + put: + description: 更新 + operationId: nat_gateway_ValidateUpdateData + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_gateway + /nat_gateways/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: nat_gateway_PerformCancelExpire + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_PerformCancelExpireOutput' + summary: 执行操作CancelExpire + tags: + - nat_gateway + /nat_gateways/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: nat_gateway_PerformChangeOwner + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - nat_gateway + /nat_gateways/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: nat_gateway_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - nat_gateway + /nat_gateways/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_gateway_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_gateway + post: + description: 执行操作ClassMetadata + operationId: nat_gateway_PerformClassMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_gateway + /nat_gateways/{id}/dnat-resources: + post: + description: 执行操作DnatResources + operationId: nat_gateway_PerformDnatResources + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_PerformDnatResourcesOutput' + summary: 执行操作DnatResources + tags: + - nat_gateway + /nat_gateways/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_gateway_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 nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_gateway + /nat_gateways/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: nat_gateway_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - nat_gateway + /nat_gateways/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: nat_gateway_PerformPostpaidExpire + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformPostpaidExpireOutput' + summary: 执行操作PostpaidExpire + tags: + - nat_gateway + /nat_gateways/{id}/private: + post: + description: 执行操作Private + operationId: nat_gateway_PerformPrivate + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformPrivateOutput' + summary: 执行操作Private + tags: + - nat_gateway + /nat_gateways/{id}/public: + post: + description: 执行操作Public + operationId: nat_gateway_PerformPublic + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformPublicOutput' + summary: 执行操作Public + tags: + - nat_gateway + /nat_gateways/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: nat_gateway_PerformRemoteUpdate + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - nat_gateway + /nat_gateways/{id}/renew: + post: + description: 执行操作Renew + operationId: nat_gateway_PerformRenew + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/RenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformRenewOutput' + summary: 执行操作Renew + tags: + - nat_gateway + /nat_gateways/{id}/set-auto-renew: + post: + description: |- + 要求NAT状态为available + 要求NAT计费类型为包年包月(预付费) + operationId: nat_gateway_PerformSetAutoRenew + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/AutoRenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSetAutoRenewOutput' + summary: 设置自动续费 + tags: + - nat_gateway + /nat_gateways/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_gateway_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_gateway + /nat_gateways/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: nat_gateway_PerformSetOrgMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_gateway + /nat_gateways/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_gateway_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_gateway + /nat_gateways/{id}/snat-resources: + post: + description: 执行操作SnatResources + operationId: nat_gateway_PerformSnatResources + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSnatResourcesOutput' + summary: 执行操作SnatResources + tags: + - nat_gateway + /nat_gateways/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_gateway_GetDetailsStatus + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_gateway + post: + description: 执行操作Status + operationId: nat_gateway_PerformStatus + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_gateway + /nat_gateways/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: nat_gateway_PerformSyncstatus + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatGatewaySyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSyncstatusOutput' + summary: 同步NAT网关状态 + tags: + - nat_gateway + /nat_gateways/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_gateway_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_gateway + /nat_gateways/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: nat_gateway_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - nat_gateway + /nat_gateways/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: nat_gateway_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - nat_gateway + /nat_gateways/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_gateway_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_gateway + /nat_gateways/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_gateway_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_gateway + /nat_gateways/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_gateway_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/nat_gateway_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_gateway + /nat_gateways/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_gateway_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_gateway + /nat_gateways/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_gateway_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_gateway + /nat_gateways/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_gateway_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_gateway + /nat_sentries: + get: + description: 列表 + operationId: nat_sentry_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: NAT网关ID or Name + in: query + name: natgateway_id + type: string + x-go-name: NatgatewayId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以NAT网关名字排序 + in: query + name: order_by_natgateway + type: string + x-go-name: OrderByNatgateway + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - in: query + items: + type: string + name: ip + type: array + x-go-name: IP + - in: query + items: + type: string + name: source_cidr + type: array + x-go-name: SourceCIDR + responses: + "200": + $ref: '#/responses/nat_sentry_ListItemFilterOutput' + summary: NAT网关的源地址转换规则列表 + tags: + - nat_sentry + post: + description: 新建 + operationId: nat_sentry_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_sentry: + $ref: '#/definitions/SNatSCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_sentry + /nat_sentries/{id}: + delete: + description: 删除 + operationId: nat_sentry_CustomizeDelete + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_CustomizeDeleteOutput' + summary: 删除 + tags: + - nat_sentry + get: + description: 获取详情 + operationId: nat_sentry_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_sentry + put: + description: 更新 + operationId: nat_sentry_ValidateUpdateData + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_sentry + /nat_sentries/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: nat_sentry_PerformChangeOwner + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - nat_sentry + /nat_sentries/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: nat_sentry_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - nat_sentry + /nat_sentries/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_sentry_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_sentry + post: + description: 执行操作ClassMetadata + operationId: nat_sentry_PerformClassMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_sentry + /nat_sentries/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_sentry_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 nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_sentry + /nat_sentries/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: nat_sentry_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - nat_sentry + /nat_sentries/{id}/private: + post: + description: 执行操作Private + operationId: nat_sentry_PerformPrivate + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformPrivateOutput' + summary: 执行操作Private + tags: + - nat_sentry + /nat_sentries/{id}/public: + post: + description: 执行操作Public + operationId: nat_sentry_PerformPublic + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformPublicOutput' + summary: 执行操作Public + tags: + - nat_sentry + /nat_sentries/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_sentry_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_sentry + /nat_sentries/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: nat_sentry_PerformSetOrgMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_sentry + /nat_sentries/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_sentry_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_sentry + /nat_sentries/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_sentry_GetDetailsStatus + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_sentry + post: + description: 执行操作Status + operationId: nat_sentry_PerformStatus + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_sentry + /nat_sentries/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_sentry_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_sentry + /nat_sentries/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: nat_sentry_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - nat_sentry + /nat_sentries/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: nat_sentry_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - nat_sentry + /nat_sentries/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_sentry_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_sentry + /nat_sentries/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_sentry_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_sentry + /nat_sentries/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_sentry_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/nat_sentry_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_sentry + /nat_sentries/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_sentry_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_sentry + /nat_sentries/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_sentry_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_sentry + /nat_sentries/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_sentry_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_sentry + /nat_skus: + get: + description: 列表 + operationId: nat_sku_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - in: query + name: postpaid_stauts + type: string + x-go-name: PostpaidStatus + - in: query + name: prepaid_status + type: string + x-go-name: PrepaidStatus + - in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + responses: + "200": + $ref: '#/responses/nat_sku_ListItemFilterOutput' + summary: 列表 + tags: + - nat_sku + post: + description: 新建 + operationId: nat_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_sku + /nat_skus/{id}: + delete: + description: 删除 + operationId: nat_sku_CustomizeDelete + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - nat_sku + get: + description: 获取详情 + operationId: nat_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_sku + put: + description: 更新 + operationId: nat_sku_ValidateUpdateData + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_sku + /nat_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_sku + post: + description: 执行操作ClassMetadata + operationId: nat_sku_PerformClassMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_sku + /nat_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: nat_sku_PerformDisable + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - nat_sku + /nat_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: nat_sku_PerformEnable + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - nat_sku + /nat_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_sku_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 nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_sku + /nat_skus/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: nat_sku_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - nat_sku + /nat_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_sku + /nat_skus/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: nat_sku_PerformSetOrgMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_sku + /nat_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_sku + /nat_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_sku_GetDetailsStatus + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_sku + post: + description: 执行操作Status + operationId: nat_sku_PerformStatus + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_sku + /nat_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_sku + /nat_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_sku + /nat_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_sku + /nat_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_sku_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/nat_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_sku + /nat_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_sku + /nat_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: nat_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - nat_sku + /nat_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: nat_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - nat_sku + /nat_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_sku + /nat_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_sku + /net_tap_flows: + get: + description: 列表 + operationId: net_tap_flow_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 + - in: query + name: tap_id + type: string + x-go-name: TapId + - in: query + name: host_id + type: string + x-go-name: HostId + responses: + "200": + $ref: '#/responses/net_tap_flow_ListItemFilterOutput' + summary: 列表 + tags: + - net_tap_flow + post: + description: 新建 + operationId: net_tap_flow_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + net_tap_flow: + $ref: '#/definitions/NetTapFlowCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_ValidateCreateDataOutput' + summary: 新建 + tags: + - net_tap_flow + /net_tap_flows/{id}: + delete: + description: 删除 + operationId: net_tap_flow_CustomizeDelete + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_CustomizeDeleteOutput' + summary: 删除 + tags: + - net_tap_flow + get: + description: 获取详情 + operationId: net_tap_flow_FetchCustomizeColumns + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - net_tap_flow + put: + description: 更新 + operationId: net_tap_flow_ValidateUpdateData + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_ValidateUpdateDataOutput' + summary: 更新 + tags: + - net_tap_flow + /net_tap_flows/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: net_tap_flow_GetDetailsClassMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - net_tap_flow + post: + description: 执行操作ClassMetadata + operationId: net_tap_flow_PerformClassMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - net_tap_flow + /net_tap_flows/{id}/disable: + post: + description: 执行操作Disable + operationId: net_tap_flow_PerformDisable + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformDisableOutput' + summary: 禁用资源 + tags: + - net_tap_flow + /net_tap_flows/{id}/enable: + post: + description: 执行操作Enable + operationId: net_tap_flow_PerformEnable + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformEnableOutput' + summary: 启用资源 + tags: + - net_tap_flow + /net_tap_flows/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: net_tap_flow_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 net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - net_tap_flow + /net_tap_flows/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: net_tap_flow_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - net_tap_flow + /net_tap_flows/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: net_tap_flow_PerformSetClassMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - net_tap_flow + /net_tap_flows/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: net_tap_flow_PerformSetOrgMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - net_tap_flow + /net_tap_flows/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: net_tap_flow_PerformSetUserMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - net_tap_flow + /net_tap_flows/{id}/status: + get: + description: 获取指定信息Status + operationId: net_tap_flow_GetDetailsStatus + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - net_tap_flow + post: + description: 执行操作Status + operationId: net_tap_flow_PerformStatus + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformStatusOutput' + summary: 更新资源状态 + tags: + - net_tap_flow + /net_tap_flows/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: net_tap_flow_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - net_tap_flow + /net_tap_flows/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: net_tap_flow_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - net_tap_flow + /net_tap_flows/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: net_tap_flow_GetPropertySplitable + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - net_tap_flow + /net_tap_flows/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: net_tap_flow_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/net_tap_flow_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - net_tap_flow + /net_tap_flows/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: net_tap_flow_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - net_tap_flow + /net_tap_flows/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: net_tap_flow_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - net_tap_flow + /net_tap_flows/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: net_tap_flow_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - net_tap_flow + /net_tap_services: + get: + description: 列表 + operationId: net_tap_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: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - in: query + name: host_id + type: string + x-go-name: HostId + - description: 按目的ip地址排序 + in: query + name: order_by_ip + pattern: asc|desc + type: string + x-go-name: OrderByIp + - description: 按镜像源数量排序 + in: query + name: order_by_flow_count + pattern: asc|desc + type: string + x-go-name: OrderByFlowCount + responses: + "200": + $ref: '#/responses/net_tap_service_ListItemFilterOutput' + summary: 列表 + tags: + - net_tap_service + post: + description: 新建 + operationId: net_tap_service_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + net_tap_service: + $ref: '#/definitions/NetTapServiceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_ValidateCreateDataOutput' + summary: 新建 + tags: + - net_tap_service + /net_tap_services/{id}: + delete: + description: 删除 + operationId: net_tap_service_CustomizeDelete + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_CustomizeDeleteOutput' + summary: 删除 + tags: + - net_tap_service + get: + description: 获取详情 + operationId: net_tap_service_FetchCustomizeColumns + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - net_tap_service + put: + description: 更新 + operationId: net_tap_service_ValidateUpdateData + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_ValidateUpdateDataOutput' + summary: 更新 + tags: + - net_tap_service + /net_tap_services/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: net_tap_service_GetDetailsClassMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - net_tap_service + post: + description: 执行操作ClassMetadata + operationId: net_tap_service_PerformClassMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - net_tap_service + /net_tap_services/{id}/disable: + post: + description: 执行操作Disable + operationId: net_tap_service_PerformDisable + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformDisableOutput' + summary: 执行操作Disable + tags: + - net_tap_service + /net_tap_services/{id}/enable: + post: + description: 执行操作Enable + operationId: net_tap_service_PerformEnable + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformEnableOutput' + summary: 执行操作Enable + tags: + - net_tap_service + /net_tap_services/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: net_tap_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 net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - net_tap_service + /net_tap_services/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: net_tap_service_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - net_tap_service + /net_tap_services/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: net_tap_service_PerformSetClassMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - net_tap_service + /net_tap_services/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: net_tap_service_PerformSetOrgMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - net_tap_service + /net_tap_services/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: net_tap_service_PerformSetUserMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - net_tap_service + /net_tap_services/{id}/status: + get: + description: 获取指定信息Status + operationId: net_tap_service_GetDetailsStatus + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - net_tap_service + post: + description: 执行操作Status + operationId: net_tap_service_PerformStatus + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformStatusOutput' + summary: 更新资源状态 + tags: + - net_tap_service + /net_tap_services/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: net_tap_service_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - net_tap_service + /net_tap_services/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: net_tap_service_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - net_tap_service + /net_tap_services/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: net_tap_service_GetPropertySplitable + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - net_tap_service + /net_tap_services/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: net_tap_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/net_tap_service_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - net_tap_service + /net_tap_services/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: net_tap_service_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - net_tap_service + /net_tap_services/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: net_tap_service_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - net_tap_service + /net_tap_services/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: net_tap_service_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - net_tap_service + /network_additional_wires: + get: + description: 列表 + operationId: network_additional_wire_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/network_additional_wire_ListItemFilterOutput' + summary: 列表 + tags: + - network_additional_wire + post: + description: 新建 + operationId: network_additional_wire_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + network_additional_wire: + $ref: '#/definitions/ModelBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_additional_wire_ValidateCreateDataOutput' + summary: 新建 + tags: + - network_additional_wire + /network_additional_wires/{id}: + delete: + description: 删除 + operationId: network_additional_wire_CustomizeDelete + parameters: + - description: The Id or Name of network_additional_wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_additional_wire_CustomizeDeleteOutput' + summary: 删除 + tags: + - network_additional_wire + get: + description: 获取详情 + operationId: network_additional_wire_FetchCustomizeColumns + parameters: + - description: The Id or Name of network_additional_wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_additional_wire_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - network_additional_wire + put: + description: 更新 + operationId: network_additional_wire_ValidateUpdateData + parameters: + - description: The Id or Name of network_additional_wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_additional_wire: + $ref: '#/definitions/ModelBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_additional_wire_ValidateUpdateDataOutput' + summary: 更新 + tags: + - network_additional_wire + /network_additional_wires/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: network_additional_wire_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/network_additional_wire_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - network_additional_wire + /network_additional_wires/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: network_additional_wire_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + network_additional_wire: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_additional_wire_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - network_additional_wire + /network_additional_wires/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: network_additional_wire_GetPropertySplitable + responses: + "200": + $ref: '#/responses/network_additional_wire_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - network_additional_wire + /network_additional_wires/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: network_additional_wire_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/network_additional_wire_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - network_additional_wire + /network_addresses: + get: + description: 列表 + operationId: network_address_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: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + items: + type: string + name: GuestId + type: array + responses: + "200": + $ref: '#/responses/network_address_ListItemFilterOutput' + summary: 列表 + tags: + - network_address + post: + description: 新建 + operationId: network_address_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + network_address: + $ref: '#/definitions/NetworkAddressCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_ValidateCreateDataOutput' + summary: 新建 + tags: + - network_address + /network_addresses/{id}: + delete: + description: 删除 + operationId: network_address_CustomizeDelete + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_address_CustomizeDeleteOutput' + summary: 删除 + tags: + - network_address + get: + description: 获取详情 + operationId: network_address_FetchCustomizeColumns + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_address_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - network_address + put: + description: 更新 + operationId: network_address_ValidateUpdateData + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_address: + $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_ValidateUpdateDataOutput' + summary: 更新 + tags: + - network_address + /network_addresses/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: network_address_GetDetailsClassMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_address_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - network_address + post: + description: 执行操作ClassMetadata + operationId: network_address_PerformClassMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - network_address + /network_addresses/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: network_address_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 network_address + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_address_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - network_address + /network_addresses/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: network_address_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_address_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - network_address + /network_addresses/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: network_address_PerformSetClassMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network_address + /network_addresses/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: network_address_PerformSetOrgMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network_address + /network_addresses/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: network_address_PerformSetUserMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - network_address + /network_addresses/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: network_address_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/network_address_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - network_address + /network_addresses/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: network_address_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + network_address: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - network_address + /network_addresses/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: network_address_GetPropertySplitable + responses: + "200": + $ref: '#/responses/network_address_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - network_address + /network_addresses/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: network_address_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/network_address_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - network_address + /network_addresses/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: network_address_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/network_address_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - network_address + /network_addresses/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: network_address_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/network_address_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - network_address + /network_interfaces: + get: + description: 列表 + operationId: network_interface_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: MAC地址 + in: query + items: + type: string + name: mac + type: array + x-go-name: Mac + - description: 绑定资源类型 + in: query + items: + type: string + name: associate_type + type: array + x-go-name: AssociateType + - description: 绑定资源Id + in: query + items: + type: string + name: associate_id + type: array + x-go-name: AssociateId + responses: + "200": + $ref: '#/responses/network_interface_ListItemFilterOutput' + summary: 虚拟网卡列表 + tags: + - network_interface + post: + description: 新建 + operationId: network_interface_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + network_interface: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_ValidateCreateDataOutput' + summary: 新建 + tags: + - network_interface + /network_interfaces/{id}: + delete: + description: 删除 + operationId: network_interface_CustomizeDelete + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_CustomizeDeleteOutput' + summary: 删除 + tags: + - network_interface + get: + description: 获取详情 + operationId: network_interface_FetchCustomizeColumns + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - network_interface + put: + description: 更新 + operationId: network_interface_ValidateUpdateData + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_ValidateUpdateDataOutput' + summary: 更新 + tags: + - network_interface + /network_interfaces/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: network_interface_PerformChangeOwner + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - network_interface + /network_interfaces/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: network_interface_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - network_interface + /network_interfaces/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: network_interface_GetDetailsClassMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - network_interface + post: + description: 执行操作ClassMetadata + operationId: network_interface_PerformClassMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - network_interface + /network_interfaces/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: network_interface_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 network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - network_interface + /network_interfaces/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: network_interface_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - network_interface + /network_interfaces/{id}/private: + post: + description: 执行操作Private + operationId: network_interface_PerformPrivate + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformPrivateOutput' + summary: 执行操作Private + tags: + - network_interface + /network_interfaces/{id}/public: + post: + description: 执行操作Public + operationId: network_interface_PerformPublic + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformPublicOutput' + summary: 执行操作Public + tags: + - network_interface + /network_interfaces/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: network_interface_PerformSetClassMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network_interface + /network_interfaces/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: network_interface_PerformSetOrgMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network_interface + /network_interfaces/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: network_interface_PerformSetUserMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - network_interface + /network_interfaces/{id}/status: + get: + description: 获取指定信息Status + operationId: network_interface_GetDetailsStatus + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - network_interface + post: + description: 执行操作Status + operationId: network_interface_PerformStatus + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformStatusOutput' + summary: 更新资源状态 + tags: + - network_interface + /network_interfaces/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: network_interface_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - network_interface + /network_interfaces/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: network_interface_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - network_interface + /network_interfaces/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: network_interface_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - network_interface + /network_interfaces/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: network_interface_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - network_interface + /network_interfaces/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: network_interface_GetPropertySplitable + responses: + "200": + $ref: '#/responses/network_interface_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - network_interface + /network_interfaces/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: network_interface_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/network_interface_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - network_interface + /network_interfaces/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: network_interface_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - network_interface + /network_interfaces/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: network_interface_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - network_interface + /network_interfaces/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: network_interface_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - network_interface + /network_ip_macs: + get: + description: 列表 + operationId: network_ip_mac_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 + - in: query + name: network_id + type: string + x-go-name: NetworkId + - in: query + items: + type: string + name: mac_addr + type: array + x-go-name: MacAddr + - in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + responses: + "200": + $ref: '#/responses/network_ip_mac_ListItemFilterOutput' + summary: 列表 + tags: + - network_ip_mac + post: + description: 新建 + operationId: network_ip_mac_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + network_ip_mac: + $ref: '#/definitions/NetworkIpMacCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_ValidateCreateDataOutput' + summary: 新建 + tags: + - network_ip_mac + /network_ip_macs/{id}: + delete: + description: 删除 + operationId: network_ip_mac_CustomizeDelete + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_ip_mac_CustomizeDeleteOutput' + summary: 删除 + tags: + - network_ip_mac + get: + description: 获取详情 + operationId: network_ip_mac_FetchCustomizeColumns + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_ip_mac_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - network_ip_mac + put: + description: 更新 + operationId: network_ip_mac_ValidateUpdateData + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_ValidateUpdateDataOutput' + summary: 更新 + tags: + - network_ip_mac + /network_ip_macs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: network_ip_mac_GetDetailsClassMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_ip_mac_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - network_ip_mac + post: + description: 执行操作ClassMetadata + operationId: network_ip_mac_PerformClassMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - network_ip_mac + /network_ip_macs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: network_ip_mac_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 network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_ip_mac_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - network_ip_mac + /network_ip_macs/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: network_ip_mac_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_ip_mac_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - network_ip_mac + /network_ip_macs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: network_ip_mac_PerformSetClassMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network_ip_mac + /network_ip_macs/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: network_ip_mac_PerformSetOrgMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network_ip_mac + /network_ip_macs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: network_ip_mac_PerformSetUserMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - network_ip_mac + /network_ip_macs/batch-create: + post: + description: 执行操作BatchCreate + operationId: network_ip_mac_PerformBatchCreate + parameters: + - in: body + name: body + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacBatchCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformBatchCreateOutput' + summary: 执行操作BatchCreate + tags: + - network_ip_mac + /network_ip_macs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: network_ip_mac_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/network_ip_mac_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - network_ip_mac + /network_ip_macs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: network_ip_mac_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + network_ip_mac: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - network_ip_mac + /network_ip_macs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: network_ip_mac_GetPropertySplitable + responses: + "200": + $ref: '#/responses/network_ip_mac_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - network_ip_mac + /network_ip_macs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: network_ip_mac_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/network_ip_mac_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - network_ip_mac + /network_ip_macs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: network_ip_mac_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/network_ip_mac_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - network_ip_mac + /network_ip_macs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: network_ip_mac_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/network_ip_mac_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - network_ip_mac + /networkinterfacenetworks: + get: + description: 列表 + operationId: networkinterfacenetwork_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/networkinterfacenetwork_ListItemFilterOutput' + summary: 列表 + tags: + - networkinterfacenetwork + post: + description: 新建 + operationId: networkinterfacenetwork_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + networkinterfacenetwork: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_ValidateCreateDataOutput' + summary: 新建 + tags: + - networkinterfacenetwork + /networkinterfacenetworks/{id}: + delete: + description: 删除 + operationId: networkinterfacenetwork_CustomizeDelete + parameters: + - description: The Id or Name of networkinterfacenetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_CustomizeDeleteOutput' + summary: 删除 + tags: + - networkinterfacenetwork + get: + description: 获取详情 + operationId: networkinterfacenetwork_FetchCustomizeColumns + parameters: + - description: The Id or Name of networkinterfacenetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - networkinterfacenetwork + put: + description: 更新 + operationId: networkinterfacenetwork_ValidateUpdateData + parameters: + - description: The Id or Name of networkinterfacenetwork + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_ValidateUpdateDataOutput' + summary: 更新 + tags: + - networkinterfacenetwork + /networkinterfacenetworks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: networkinterfacenetwork_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - networkinterfacenetwork + /networkinterfacenetworks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: networkinterfacenetwork_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - networkinterfacenetwork + /networkinterfacenetworks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: networkinterfacenetwork_GetPropertySplitable + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - networkinterfacenetwork + /networkinterfacenetworks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: networkinterfacenetwork_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/networkinterfacenetwork_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - networkinterfacenetwork + /networks: + get: + description: 列表 + operationId: network_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by route table which associate with it + in: query + name: route_table_id + type: string + x-go-name: RouteTableId + - description: 'description: Exact matching ip address in network.' + example: 10.168.222.1 + in: query + items: + type: string + name: ip + type: array + x-go-name: Ip + - description: 'description: Fuzzy matching ip address in network.' + example: 10.168.222.1 + in: query + items: + type: string + name: ip_match + type: array + x-go-name: IpMatch + - in: query + items: + type: string + name: ifname_hint + type: array + x-go-name: IfnameHint + - description: 起始IP地址 + in: query + items: + type: string + name: guest_ip_start + type: array + x-go-name: GuestIpStart + - description: 接收IP地址 + in: query + items: + type: string + name: guest_ip_end + type: array + x-go-name: GuestIpEnd + - description: 掩码 + in: query + items: + format: int8 + type: integer + name: guest_ip_mask + type: array + x-go-name: GuestIpMask + - description: 网关地址 + in: query + name: guest_gateway + type: string + x-go-name: GuestGateway + - description: DNS + in: query + items: + type: string + name: guest_dns + type: array + x-go-name: GuestDns + - description: allow multiple dhcp, seperated by "," + in: query + items: + type: string + name: guest_dhcp + type: array + x-go-name: GuestDhcp + - description: NTP + in: query + items: + type: string + name: guest_ntp + type: array + x-go-name: GuestNtp + - in: query + items: + type: string + name: guest_domain + type: array + x-go-name: GuestDomain + - in: query + items: + type: string + name: guest_ip6_start + type: array + x-go-name: GuestIp6Start + - in: query + items: + type: string + name: guest_ip6_end + type: array + x-go-name: GuestIp6End + - in: query + items: + format: int8 + type: integer + name: guest_ip6_mask + type: array + x-go-name: GuestIp6Mask + - in: query + items: + type: string + name: guest_gateway6 + type: array + x-go-name: GuestGateway6 + - in: query + items: + type: string + name: guest_dns6 + type: array + x-go-name: GuestDns6 + - in: query + items: + type: string + name: guest_domain6 + type: array + x-go-name: GuestDomain6 + - description: vlanId 1~4096 + in: query + items: + format: int64 + type: integer + name: vlan_id + type: array + x-go-name: VlanId + - description: 服务器类型 + example: server + in: query + items: + type: string + name: server_type + type: array + x-go-name: ServerType + - description: 分配策略 + in: query + items: + type: string + name: alloc_policy + type: array + x-go-name: AllocPolicy + - description: 是否加入自动分配地址池 + in: query + name: is_auto_alloc + type: boolean + x-go-name: IsAutoAlloc + - description: 是否为基础网络（underlay） + in: query + name: is_classic + type: boolean + x-go-name: IsClassic + - description: filter by Host schedtag + in: query + name: host_schedtag_id + type: string + x-go-name: HostSchedtagId + - description: filter by BGP types + in: query + items: + type: string + name: bgp_type + type: array + x-go-name: BgpType + - in: query + name: host_type + type: string + x-go-name: HostType + - description: 按起始ip地址排序 + in: query + name: order_by_ip_start + pattern: asc|desc + type: string + x-go-name: OrderByIpStart + - description: 按终止ip地址排序 + in: query + name: order_by_ip_end + pattern: asc|desc + type: string + x-go-name: OrderByIpEnd + responses: + "200": + $ref: '#/responses/network_ListItemFilterOutput' + summary: IP子网列表 + tags: + - network + post: + description: 新建 + operationId: network_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + network: + $ref: '#/definitions/NetworkCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ValidateCreateDataOutput' + summary: 新建 + tags: + - network + /networks/{id}: + delete: + description: 删除 + operationId: network_CustomizeDelete + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_CustomizeDeleteOutput' + summary: 删除 + tags: + - network + get: + description: 获取详情 + operationId: network_FetchCustomizeColumns + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - network + put: + description: 更新 + operationId: network_ValidateUpdateData + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ValidateUpdateDataOutput' + summary: 更新 + tags: + - network + /networks/{id}/addresses: + get: + description: 获取指定信息Addresses + operationId: network_GetDetailsAddresses + parameters: + - description: 获取资源的范围，例如 project|domain|system + in: query + name: scope + type: string + x-go-name: Scope + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsAddressesOutput' + summary: 获取指定信息Addresses + tags: + - network + /networks/{id}/available-addresses: + get: + description: 获取指定信息AvailableAddresses + operationId: network_GetDetailsAvailableAddresses + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsAvailableAddressesOutput' + summary: 获取指定信息AvailableAddresses + tags: + - network + /networks/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: network_PerformCancelDelete + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - network + /networks/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: network_PerformChangeOwner + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - network + /networks/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: network_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - network + /networks/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: network_GetDetailsClassMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - network + post: + description: 执行操作ClassMetadata + operationId: network_PerformClassMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - network + /networks/{id}/freeze: + post: + description: 执行操作Freeze + operationId: network_PerformFreeze + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - network + /networks/{id}/merge: + post: + description: 将两个相连的IP子网合并成一个IP子网 + operationId: network_PerformMerge + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkMergeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformMergeOutput' + summary: 合并IP子网 + tags: + - network + /networks/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: network_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 network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - network + /networks/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: network_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - network + /networks/{id}/private: + post: + description: 执行操作Private + operationId: network_PerformPrivate + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformPrivateOutput' + summary: 执行操作Private + tags: + - network + /networks/{id}/public: + post: + description: 执行操作Public + operationId: network_PerformPublic + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformPublicOutput' + summary: 执行操作Public + tags: + - network + /networks/{id}/purge: + post: + description: 要求IP子网内没有被分配IP,若清除接入云,要求接入云账号处于禁用状态 + operationId: network_PerformPurge + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkPurgeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformPurgeOutput' + summary: 清除IP子网数据 + tags: + - network + /networks/{id}/release-reserved-ip: + post: + description: 执行操作ReleaseReservedIp + operationId: network_PerformReleaseReservedIp + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkReleaseReservedIpInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformReleaseReservedIpOutput' + summary: 释放预留IP + tags: + - network + /networks/{id}/reserve-ip: + post: + description: 预留的IP不会被调度使用 + operationId: network_PerformReserveIp + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkReserveIpInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformReserveIpOutput' + summary: 预留IP + tags: + - network + /networks/{id}/reserved-ips: + get: + description: 获取指定信息ReservedIps + operationId: network_GetDetailsReservedIps + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsReservedIpsOutput' + summary: 获取指定信息ReservedIps + tags: + - network + /networks/{id}/set-bgp-type: + post: + description: 执行操作SetBgpType + operationId: network_PerformSetBgpType + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSetBgpTypeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSetBgpTypeOutput' + summary: 执行操作SetBgpType + tags: + - network + /networks/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: network_PerformSetClassMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network + /networks/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: network_PerformSetOrgMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network + /networks/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: network_PerformSetSchedtag + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - network + /networks/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: network_PerformSetUserMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - network + /networks/{id}/split: + post: + description: 将一个IP子网分割成两个子网,仅本地IDC支持此操作 + operationId: network_PerformSplit + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSplitInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSplitOutput' + summary: 分割IP子网 + tags: + - network + /networks/{id}/status: + get: + description: 获取指定信息Status + operationId: network_GetDetailsStatus + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - network + post: + description: 执行操作Status + operationId: network_PerformStatus + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformStatusOutput' + summary: 更改IP子网状态 + tags: + - network + /networks/{id}/switch-wire: + post: + description: 执行操作SwitchWire + operationId: network_PerformSwitchWire + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSwitchWireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSwitchWireOutput' + summary: 执行操作SwitchWire + tags: + - network + /networks/{id}/sync: + post: + description: 本地IDC不支持此操作 + operationId: network_PerformSync + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSyncOutput' + summary: 同步接入云IP子网状态 + tags: + - network + /networks/{id}/sync-additional-wires: + post: + description: 执行操作SyncAdditionalWires + operationId: network_PerformSyncAdditionalWires + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworSyncAdditionalWiresInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSyncAdditionalWiresOutput' + summary: 执行操作SyncAdditionalWires + tags: + - network + /networks/{id}/syncstatus: + post: + description: 本地IDC不支持此操作 + operationId: network_PerformSyncstatus + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSyncstatusOutput' + summary: 同步接入云IP子网状态 + tags: + - network + /networks/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: network_PerformUnfreeze + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - network + /networks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: network_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/network_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - network + /networks/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: network_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/network_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - network + /networks/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: network_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/network_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - network + /networks/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: network_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/network_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - network + /networks/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: network_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/network_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - network + /networks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: network_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - network + /networks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: network_GetPropertySplitable + responses: + "200": + $ref: '#/responses/network_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - network + /networks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: network_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/network_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - network + /networks/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: network_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/network_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - network + /networks/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: network_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/network_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - network + /networks/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: network_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/network_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - network + /networks/try-create-network: + post: + description: 执行操作TryCreateNetwork + operationId: network_PerformTryCreateNetwork + parameters: + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkTryCreateNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformTryCreateNetworkOutput' + summary: 执行操作TryCreateNetwork + tags: + - network + /policy_assignments: + get: + description: 列表 + operationId: policy_assignment_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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: Policydefinition + type: string + responses: + "200": + $ref: '#/responses/policy_assignment_ListItemFilterOutput' + summary: 策略分配列表 + tags: + - policy_assignment + post: + description: 新建 + operationId: policy_assignment_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + policy_assignment: + $ref: '#/definitions/PolicyAssignmentCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_ValidateCreateDataOutput' + summary: 新建 + tags: + - policy_assignment + /policy_assignments/{id}: + delete: + description: 删除 + operationId: policy_assignment_CustomizeDelete + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_CustomizeDeleteOutput' + summary: 删除 + tags: + - policy_assignment + get: + description: 获取详情 + operationId: policy_assignment_FetchCustomizeColumns + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - policy_assignment + put: + description: 更新 + operationId: policy_assignment_ValidateUpdateData + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + $ref: '#/definitions/DomainLevelResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_ValidateUpdateDataOutput' + summary: 更新 + tags: + - policy_assignment + /policy_assignments/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: policy_assignment_PerformChangeOwner + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - policy_assignment + /policy_assignments/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: policy_assignment_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - policy_assignment + /policy_assignments/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: policy_assignment_GetDetailsClassMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - policy_assignment + post: + description: 执行操作ClassMetadata + operationId: policy_assignment_PerformClassMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - policy_assignment + /policy_assignments/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: policy_assignment_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_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - policy_assignment + /policy_assignments/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: policy_assignment_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - policy_assignment + /policy_assignments/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: policy_assignment_PerformSetClassMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - policy_assignment + /policy_assignments/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: policy_assignment_PerformSetOrgMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - policy_assignment + /policy_assignments/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: policy_assignment_PerformSetUserMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - policy_assignment + /policy_assignments/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: policy_assignment_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - policy_assignment + /policy_assignments/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: policy_assignment_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - policy_assignment + /policy_assignments/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: policy_assignment_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - policy_assignment + /policy_assignments/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: policy_assignment_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + policy_assignment: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - policy_assignment + /policy_assignments/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: policy_assignment_GetPropertySplitable + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - policy_assignment + /policy_assignments/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: policy_assignment_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_assignment_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - policy_assignment + /policy_assignments/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: policy_assignment_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - policy_assignment + /policy_assignments/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: policy_assignment_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - policy_assignment + /policy_definitions: + get: + description: 列表 + operationId: policy_definition_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: 指定查询的权限范围，可能值为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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/policy_definition_ListItemFilterOutput' + summary: 策略列表 + tags: + - policy_definition + post: + description: 新建 + operationId: policy_definition_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + policy_definition: + $ref: '#/definitions/PolicyDefinitionCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_ValidateCreateDataOutput' + summary: 新建 + tags: + - policy_definition + /policy_definitions/{id}: + delete: + description: 删除 + operationId: policy_definition_CustomizeDelete + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_CustomizeDeleteOutput' + summary: 删除 + tags: + - policy_definition + get: + description: 获取详情 + operationId: policy_definition_FetchCustomizeColumns + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - policy_definition + put: + description: 更新 + operationId: policy_definition_ValidateUpdateData + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_ValidateUpdateDataOutput' + summary: 更新 + tags: + - policy_definition + /policy_definitions/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: policy_definition_GetDetailsClassMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - policy_definition + post: + description: 执行操作ClassMetadata + operationId: policy_definition_PerformClassMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - policy_definition + /policy_definitions/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: policy_definition_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_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - policy_definition + /policy_definitions/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: policy_definition_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - policy_definition + /policy_definitions/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: policy_definition_PerformSetClassMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - policy_definition + /policy_definitions/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: policy_definition_PerformSetOrgMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - policy_definition + /policy_definitions/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: policy_definition_PerformSetUserMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - policy_definition + /policy_definitions/{id}/status: + get: + description: 获取指定信息Status + operationId: policy_definition_GetDetailsStatus + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - policy_definition + post: + description: 执行操作Status + operationId: policy_definition_PerformStatus + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformStatusOutput' + summary: 更新资源状态 + tags: + - policy_definition + /policy_definitions/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: policy_definition_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - policy_definition + /policy_definitions/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: policy_definition_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + policy_definition: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - policy_definition + /policy_definitions/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: policy_definition_GetPropertySplitable + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - policy_definition + /policy_definitions/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: policy_definition_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_definition_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - policy_definition + /policy_definitions/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: policy_definition_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - policy_definition + /policy_definitions/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: policy_definition_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - policy_definition + /policy_definitions/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: policy_definition_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - policy_definition + /project_mappings: + get: + description: 列表 + operationId: project_mapping_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/project_mapping_ListItemFilterOutput' + summary: 列出项目映射表 + tags: + - project_mapping + post: + description: 新建 + operationId: project_mapping_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + project_mapping: + $ref: '#/definitions/ProjectMappingCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_ValidateCreateDataOutput' + summary: 新建 + tags: + - project_mapping + /project_mappings/{id}: + delete: + description: 删除 + operationId: project_mapping_CustomizeDelete + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_CustomizeDeleteOutput' + summary: 删除 + tags: + - project_mapping + get: + description: 获取详情 + operationId: project_mapping_FetchCustomizeColumns + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - project_mapping + put: + description: 更新 + operationId: project_mapping_ValidateUpdateData + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_ValidateUpdateDataOutput' + summary: 更新 + tags: + - project_mapping + /project_mappings/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: project_mapping_PerformChangeOwner + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - project_mapping + /project_mappings/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: project_mapping_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - project_mapping + /project_mappings/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: project_mapping_GetDetailsClassMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - project_mapping + post: + description: 执行操作ClassMetadata + operationId: project_mapping_PerformClassMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - project_mapping + /project_mappings/{id}/disable: + post: + description: 执行操作Disable + operationId: project_mapping_PerformDisable + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformDisableOutput' + summary: 禁用资源映射 + tags: + - project_mapping + /project_mappings/{id}/enable: + post: + description: 执行操作Enable + operationId: project_mapping_PerformEnable + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformEnableOutput' + summary: 启用资源映射 + tags: + - project_mapping + /project_mappings/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: project_mapping_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_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - project_mapping + /project_mappings/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: project_mapping_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - project_mapping + /project_mappings/{id}/private: + post: + description: 执行操作Private + operationId: project_mapping_PerformPrivate + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformPrivateOutput' + summary: 执行操作Private + tags: + - project_mapping + /project_mappings/{id}/public: + post: + description: 执行操作Public + operationId: project_mapping_PerformPublic + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformPublicOutput' + summary: 执行操作Public + tags: + - project_mapping + /project_mappings/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: project_mapping_PerformSetClassMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - project_mapping + /project_mappings/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: project_mapping_PerformSetOrgMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - project_mapping + /project_mappings/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: project_mapping_PerformSetUserMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - project_mapping + /project_mappings/{id}/status: + get: + description: 获取指定信息Status + operationId: project_mapping_GetDetailsStatus + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - project_mapping + post: + description: 执行操作Status + operationId: project_mapping_PerformStatus + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformStatusOutput' + summary: 更新资源状态 + tags: + - project_mapping + /project_mappings/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: project_mapping_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - project_mapping + /project_mappings/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: project_mapping_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - project_mapping + /project_mappings/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: project_mapping_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - project_mapping + /project_mappings/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: project_mapping_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - project_mapping + /project_mappings/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: project_mapping_GetPropertySplitable + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - project_mapping + /project_mappings/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: project_mapping_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_mapping_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - project_mapping + /project_mappings/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: project_mapping_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - project_mapping + /project_mappings/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: project_mapping_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - project_mapping + /project_mappings/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: project_mapping_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - project_mapping + /project_quotas/{scope}: + get: + description: 获取所有项目或者域的项目配额 + operationId: models_ListProjectQuotas + 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListProjectQuotasOutput' + summary: 获取所有项目或者域的项目配额 + tags: + - project_quota + /project_quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的项目配额 + operationId: models_GetProjectQuota + 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: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + responses: + "200": + $ref: '#/responses/models_GetProjectQuotaOutput' + summary: 获取指定项目或者域的项目配额 + tags: + - project_quota + post: + description: 设置指定项目或者域的项目配额 + operationId: models_SetProjectQuotas + parameters: + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - in: body + name: body + schema: + properties: + project_quotas: + $ref: '#/definitions/SetProjectQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetProjectQuotasOutput' + summary: 设置指定项目或者域的项目配额 + tags: + - project_quota + /quotas/{scope}: + get: + description: 获取所有项目或者域的主机配额 + operationId: models_ListQuotas + 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListQuotasOutput' + summary: 获取所有项目或者域的主机配额 + tags: + - quota + /quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的主机配额 + operationId: models_GetQuota + 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: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + responses: + "200": + $ref: '#/responses/models_GetQuotaOutput' + summary: 获取指定项目或者域的主机配额 + tags: + - quota + post: + description: 设置指定项目或者域的主机配额 + operationId: models_SetQuotas + parameters: + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - in: body + name: body + schema: + properties: + quotas: + $ref: '#/definitions/SetQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetQuotasOutput' + summary: 设置指定项目或者域的主机配额 + tags: + - quota + /region_quotas/{scope}: + get: + description: 获取所有项目或者域的区域配额 + operationId: models_ListRegionQuotas + 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListRegionQuotasOutput' + summary: 获取所有项目或者域的区域配额 + tags: + - region_quota + /region_quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的区域配额 + operationId: models_GetRegionQuota + 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: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + responses: + "200": + $ref: '#/responses/models_GetRegionQuotaOutput' + summary: 获取指定项目或者域的区域配额 + tags: + - region_quota + post: + description: 设置指定项目或者域的区域配额 + operationId: models_SetRegionQuotas + parameters: + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - in: body + name: body + schema: + properties: + region_quotas: + $ref: '#/definitions/SetRegionQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetRegionQuotasOutput' + summary: 设置指定项目或者域的区域配额 + tags: + - region_quota + /reservedips: + get: + description: 列表 + operationId: reservedip_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: list all reserved ips, including expired ones + in: query + name: all + type: boolean + x-go-name: All + - description: ip_addr + in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + - description: 状态 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/reservedip_ListItemFilterOutput' + summary: 预留IP地址列表 + tags: + - reservedip + post: + description: 新建 + operationId: reservedip_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + reservedip: + $ref: '#/definitions/ResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/reservedip_ValidateCreateDataOutput' + summary: 新建 + tags: + - reservedip + /reservedips/{id}: + delete: + description: 删除 + operationId: reservedip_CustomizeDelete + parameters: + - description: The Id or Name of reservedip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/reservedip_CustomizeDeleteOutput' + summary: 删除 + tags: + - reservedip + get: + description: 获取详情 + operationId: reservedip_FetchCustomizeColumns + parameters: + - description: The Id or Name of reservedip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/reservedip_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - reservedip + put: + description: 更新 + operationId: reservedip_ValidateUpdateData + parameters: + - description: The Id or Name of reservedip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + reservedip: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/reservedip_ValidateUpdateDataOutput' + summary: 更新 + tags: + - reservedip + /reservedips/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: reservedip_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/reservedip_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - reservedip + /reservedips/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: reservedip_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + reservedip: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/reservedip_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - reservedip + /reservedips/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: reservedip_GetPropertySplitable + responses: + "200": + $ref: '#/responses/reservedip_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - reservedip + /reservedips/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: reservedip_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/reservedip_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - reservedip + /route_table_associations: + get: + description: 列表 + operationId: route_table_association_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - in: query + name: RouteTableId + type: string + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/route_table_association_ListItemFilterOutput' + summary: 列表 + tags: + - route_table_association + post: + description: 新建 + operationId: route_table_association_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_ValidateCreateDataOutput' + summary: 新建 + tags: + - route_table_association + /route_table_associations/{id}: + delete: + description: 删除 + operationId: route_table_association_CustomizeDelete + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_CustomizeDeleteOutput' + summary: 删除 + tags: + - route_table_association + get: + description: 获取详情 + operationId: route_table_association_FetchCustomizeColumns + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - route_table_association + put: + description: 更新 + operationId: route_table_association_ValidateUpdateData + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_ValidateUpdateDataOutput' + summary: 更新 + tags: + - route_table_association + /route_table_associations/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: route_table_association_GetDetailsClassMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - route_table_association + post: + description: 执行操作ClassMetadata + operationId: route_table_association_PerformClassMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - route_table_association + /route_table_associations/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: route_table_association_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 route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - route_table_association + /route_table_associations/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: route_table_association_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - route_table_association + /route_table_associations/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: route_table_association_PerformSetClassMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - route_table_association + /route_table_associations/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: route_table_association_PerformSetOrgMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - route_table_association + /route_table_associations/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: route_table_association_PerformSetUserMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - route_table_association + /route_table_associations/{id}/status: + get: + description: 获取指定信息Status + operationId: route_table_association_GetDetailsStatus + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - route_table_association + post: + description: 执行操作Status + operationId: route_table_association_PerformStatus + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformStatusOutput' + summary: 更新资源状态 + tags: + - route_table_association + /route_table_associations/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: route_table_association_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - route_table_association + /route_table_associations/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: route_table_association_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + route_table_association: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - route_table_association + /route_table_associations/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: route_table_association_GetPropertySplitable + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - route_table_association + /route_table_associations/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: route_table_association_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/route_table_association_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - route_table_association + /route_table_associations/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: route_table_association_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - route_table_association + /route_table_associations/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: route_table_association_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - route_table_association + /route_table_associations/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: route_table_association_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - route_table_association + /route_table_route_sets: + get: + description: 列表 + operationId: route_table_route_set_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - in: query + name: RouteTableId + type: string + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: type + type: string + x-go-name: Type + - in: query + name: next_hop_type + type: string + x-go-name: NextHopType + - in: query + name: next_hop_id + type: string + x-go-name: NextHopId + - in: query + name: cidr + type: string + x-go-name: Cidr + responses: + "200": + $ref: '#/responses/route_table_route_set_ListItemFilterOutput' + summary: 列表 + tags: + - route_table_route_set + post: + description: 新建 + operationId: route_table_route_set_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + route_table_route_set: + $ref: '#/definitions/RouteTableRouteSetCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_ValidateCreateDataOutput' + summary: 新建 + tags: + - route_table_route_set + /route_table_route_sets/{id}: + delete: + description: 删除 + operationId: route_table_route_set_CustomizeDelete + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_CustomizeDeleteOutput' + summary: 删除 + tags: + - route_table_route_set + get: + description: 获取详情 + operationId: route_table_route_set_FetchCustomizeColumns + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - route_table_route_set + put: + description: 更新 + operationId: route_table_route_set_ValidateUpdateData + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + $ref: '#/definitions/RouteTableRouteSetUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_ValidateUpdateDataOutput' + summary: 更新 + tags: + - route_table_route_set + /route_table_route_sets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: route_table_route_set_GetDetailsClassMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - route_table_route_set + post: + description: 执行操作ClassMetadata + operationId: route_table_route_set_PerformClassMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - route_table_route_set + /route_table_route_sets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: route_table_route_set_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 route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - route_table_route_set + /route_table_route_sets/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: route_table_route_set_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - route_table_route_set + /route_table_route_sets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: route_table_route_set_PerformSetClassMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - route_table_route_set + /route_table_route_sets/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: route_table_route_set_PerformSetOrgMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - route_table_route_set + /route_table_route_sets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: route_table_route_set_PerformSetUserMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - route_table_route_set + /route_table_route_sets/{id}/status: + get: + description: 获取指定信息Status + operationId: route_table_route_set_GetDetailsStatus + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - route_table_route_set + post: + description: 执行操作Status + operationId: route_table_route_set_PerformStatus + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformStatusOutput' + summary: 更新资源状态 + tags: + - route_table_route_set + /route_table_route_sets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: route_table_route_set_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - route_table_route_set + /route_table_route_sets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: route_table_route_set_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + route_table_route_set: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - route_table_route_set + /route_table_route_sets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: route_table_route_set_GetPropertySplitable + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - route_table_route_set + /route_table_route_sets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: route_table_route_set_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/route_table_route_set_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - route_table_route_set + /route_table_route_sets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: route_table_route_set_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - route_table_route_set + /route_table_route_sets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: route_table_route_set_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - route_table_route_set + /route_table_route_sets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: route_table_route_set_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - route_table_route_set + /route_tables: + get: + description: 列表 + operationId: route_table_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by type + in: query + items: + type: string + name: type + type: array + x-go-name: Type + responses: + "200": + $ref: '#/responses/route_table_ListItemFilterOutput' + summary: VPC虚拟路由表列表 + tags: + - route_table + post: + description: 新建 + operationId: route_table_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + route_table: + $ref: '#/definitions/RouteTableCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_ValidateCreateDataOutput' + summary: 新建 + tags: + - route_table + /route_tables/{id}: + delete: + description: 删除 + operationId: route_table_CustomizeDelete + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_CustomizeDeleteOutput' + summary: 删除 + tags: + - route_table + get: + description: 获取详情 + operationId: route_table_FetchCustomizeColumns + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - route_table + put: + description: 更新 + operationId: route_table_ValidateUpdateData + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_ValidateUpdateDataOutput' + summary: 更新 + tags: + - route_table + /route_tables/{id}/add-routes: + post: + description: This is intended mainly for command line operations. + operationId: route_table_PerformAddRoutes + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_PerformAddRoutesOutput' + summary: PerformAddRoutes patches acl entries by adding then deleting the specified acls. + tags: + - route_table + /route_tables/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: route_table_PerformChangeOwner + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - route_table + /route_tables/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: route_table_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - route_table + /route_tables/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: route_table_GetDetailsClassMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - route_table + post: + description: 执行操作ClassMetadata + operationId: route_table_PerformClassMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - route_table + /route_tables/{id}/del-routes: + post: + description: 执行操作DelRoutes + operationId: route_table_PerformDelRoutes + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_PerformDelRoutesOutput' + summary: 执行操作DelRoutes + tags: + - route_table + /route_tables/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: route_table_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 route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - route_table + /route_tables/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: route_table_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - route_table + /route_tables/{id}/private: + post: + description: 执行操作Private + operationId: route_table_PerformPrivate + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformPrivateOutput' + summary: 执行操作Private + tags: + - route_table + /route_tables/{id}/public: + post: + description: 执行操作Public + operationId: route_table_PerformPublic + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformPublicOutput' + summary: 执行操作Public + tags: + - route_table + /route_tables/{id}/purge: + post: + description: 执行操作Purge + operationId: route_table_PerformPurge + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - route_table + /route_tables/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: route_table_PerformSetClassMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - route_table + /route_tables/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: route_table_PerformSetOrgMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - route_table + /route_tables/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: route_table_PerformSetUserMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - route_table + /route_tables/{id}/status: + get: + description: 获取指定信息Status + operationId: route_table_GetDetailsStatus + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - route_table + post: + description: 执行操作Status + operationId: route_table_PerformStatus + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformStatusOutput' + summary: 更新资源状态 + tags: + - route_table + /route_tables/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: route_table_PerformSyncstatus + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/VpcSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - route_table + /route_tables/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: route_table_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/route_table_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - route_table + /route_tables/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: route_table_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/route_table_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - route_table + /route_tables/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: route_table_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/route_table_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - route_table + /route_tables/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: route_table_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - route_table + /route_tables/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: route_table_GetPropertySplitable + responses: + "200": + $ref: '#/responses/route_table_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - route_table + /route_tables/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: route_table_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/route_table_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - route_table + /route_tables/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: route_table_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/route_table_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - route_table + /route_tables/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: route_table_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/route_table_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - route_table + /route_tables/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: route_table_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/route_table_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - route_table + /scaling_activities: + get: + description: 列表 + operationId: scaling_activity_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: 'description: 伸缩组 Id or Name' + example: sg-1234 + in: query + name: scaling_group + type: string + x-go-name: ScalingGroup + responses: + "200": + $ref: '#/responses/scaling_activity_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_activity + post: + description: 新建 + operationId: scaling_activity_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_activity: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_activity + /scaling_activities/{id}: + delete: + description: 删除 + operationId: scaling_activity_CustomizeDelete + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_activity + get: + description: 获取详情 + operationId: scaling_activity_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_activity + put: + description: 更新 + operationId: scaling_activity_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_activity + /scaling_activities/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_activity_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_activity + post: + description: 执行操作ClassMetadata + operationId: scaling_activity_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_activity + /scaling_activities/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_activity_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 scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_activity + /scaling_activities/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: scaling_activity_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - scaling_activity + /scaling_activities/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_activity_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_activity + /scaling_activities/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: scaling_activity_PerformSetOrgMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_activity + /scaling_activities/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_activity_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_activity + /scaling_activities/{id}/status: + get: + description: 获取指定信息Status + operationId: scaling_activity_GetDetailsStatus + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - scaling_activity + post: + description: 执行操作Status + operationId: scaling_activity_PerformStatus + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformStatusOutput' + summary: 更新资源状态 + tags: + - scaling_activity + /scaling_activities/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_activity_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_activity + /scaling_activities/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_activity_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_activity: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_activity + /scaling_activities/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_activity_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_activity + /scaling_activities/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_activity_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/scaling_activity_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_activity + /scaling_activities/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: scaling_activity_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - scaling_activity + /scaling_activities/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_activity_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_activity + /scaling_activities/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_activity_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_activity + /scaling_alarms: + get: + description: 列表 + operationId: scaling_alarm_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/scaling_alarm_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_alarm + post: + description: 新建 + operationId: scaling_alarm_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_alarm: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_alarm + /scaling_alarms/{id}: + delete: + description: 删除 + operationId: scaling_alarm_CustomizeDelete + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_alarm_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_alarm + get: + description: 获取详情 + operationId: scaling_alarm_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_alarm_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_alarm + put: + description: 更新 + operationId: scaling_alarm_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_alarm + /scaling_alarms/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_alarm_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_alarm_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_alarm + post: + description: 执行操作ClassMetadata + operationId: scaling_alarm_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_alarm + /scaling_alarms/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_alarm_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 scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_alarm_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_alarm + /scaling_alarms/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: scaling_alarm_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_alarm_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - scaling_alarm + /scaling_alarms/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_alarm_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_alarm + /scaling_alarms/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: scaling_alarm_PerformSetOrgMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_alarm + /scaling_alarms/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_alarm_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_alarm + /scaling_alarms/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_alarm_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_alarm_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_alarm + /scaling_alarms/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_alarm_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_alarm: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_alarm + /scaling_alarms/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_alarm_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_alarm_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_alarm + /scaling_alarms/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_alarm_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/scaling_alarm_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_alarm + /scaling_alarms/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_alarm_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_alarm_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_alarm + /scaling_alarms/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_alarm_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_alarm_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_alarm + /scaling_group_guests: + get: + description: 列表 + operationId: scaling_group_guest_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + responses: + "200": + $ref: '#/responses/scaling_group_guest_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_group_guest + post: + description: 新建 + operationId: scaling_group_guest_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_group_guest: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_guest_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_group_guest + /scaling_group_guests/{id}: + delete: + description: 删除 + operationId: scaling_group_guest_CustomizeDelete + parameters: + - description: The Id or Name of scaling_group_guest + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_guest_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_group_guest + get: + description: 获取详情 + operationId: scaling_group_guest_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_group_guest + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_guest_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_group_guest + put: + description: 更新 + operationId: scaling_group_guest_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_group_guest + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_guest_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_group_guest + /scaling_group_guests/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_group_guest_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_group_guest_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_group_guest + /scaling_group_guests/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_group_guest_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_guest_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_group_guest + /scaling_group_guests/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_group_guest_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_group_guest_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_group_guest + /scaling_group_guests/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_group_guest_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/scaling_group_guest_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_group_guest + /scaling_group_networks: + get: + description: 列表 + operationId: scaling_group_network_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/scaling_group_network_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_group_network + post: + description: 新建 + operationId: scaling_group_network_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_group_network: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_network_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_group_network + /scaling_group_networks/{id}: + delete: + description: 删除 + operationId: scaling_group_network_CustomizeDelete + parameters: + - description: The Id or Name of scaling_group_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_network_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_group_network + get: + description: 获取详情 + operationId: scaling_group_network_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_group_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_network_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_group_network + put: + description: 更新 + operationId: scaling_group_network_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_group_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_network_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_group_network + /scaling_group_networks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_group_network_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_group_network_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_group_network + /scaling_group_networks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_group_network_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_group_network: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_network_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_group_network + /scaling_group_networks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_group_network_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_group_network_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_group_network + /scaling_group_networks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_group_network_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/scaling_group_network_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_group_network + /scaling_groups: + get: + description: 列表 + operationId: scaling_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: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: 负载均衡后端组ID或名称 + in: query + name: backend_group_id + type: string + x-go-name: BackendGroupId + - description: 以负载均衡后端组名称排序 + in: query + name: order_by_backend_group + type: string + x-go-name: OrderByBackendGroup + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 实例组（ID或Name） + in: query + name: group_id + type: string + x-go-name: GroupId + - description: 按组名排序 + in: query + name: order_by_group + type: string + x-go-name: OrderByGroup + - description: 主机镜像 + in: query + name: guest_template_id + type: string + x-go-name: GuestTemplateId + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 'description: hypervisor' + example: kvm + in: query + name: hypervisor + type: string + x-go-name: Hypervisor + - description: 'desription: 平台' + example: OneCloud + in: query + name: brand + type: string + x-go-name: Brand + responses: + "200": + $ref: '#/responses/scaling_group_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_group + post: + description: 新建 + operationId: scaling_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_group: + $ref: '#/definitions/ScalingGroupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_group + /scaling_groups/{id}: + delete: + description: 删除 + operationId: scaling_group_CustomizeDelete + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_group + get: + description: 获取详情 + operationId: scaling_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_group + put: + description: 更新 + operationId: scaling_group_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_group + /scaling_groups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: scaling_group_PerformCancelDelete + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - scaling_group + /scaling_groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: scaling_group_PerformChangeOwner + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - scaling_group + /scaling_groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: scaling_group_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - scaling_group + /scaling_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_group + post: + description: 执行操作ClassMetadata + operationId: scaling_group_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_group + /scaling_groups/{id}/disable: + post: + description: 执行操作Disable + operationId: scaling_group_PerformDisable + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformDisableOutput' + summary: 执行操作Disable + tags: + - scaling_group + /scaling_groups/{id}/enable: + post: + description: 执行操作Enable + operationId: scaling_group_PerformEnable + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformEnableOutput' + summary: 执行操作Enable + tags: + - scaling_group + /scaling_groups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: scaling_group_PerformFreeze + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - scaling_group + /scaling_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_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 scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_group + /scaling_groups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: scaling_group_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - scaling_group + /scaling_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_group + /scaling_groups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: scaling_group_PerformSetOrgMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_group + /scaling_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_group + /scaling_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: scaling_group_GetDetailsStatus + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - scaling_group + post: + description: 执行操作Status + operationId: scaling_group_PerformStatus + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - scaling_group + /scaling_groups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: scaling_group_PerformUnfreeze + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - scaling_group + /scaling_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_group + /scaling_groups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: scaling_group_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - scaling_group + /scaling_groups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: scaling_group_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - scaling_group + /scaling_groups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: scaling_group_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - scaling_group + /scaling_groups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: scaling_group_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - scaling_group + /scaling_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_group + /scaling_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_group + /scaling_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_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/scaling_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_group + /scaling_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: scaling_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - scaling_group + /scaling_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_group + /scaling_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_group + /scaling_policies: + get: + description: 列表 + operationId: scaling_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: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 'description: 伸缩组 Id or Name' + example: sg-1234 + in: query + name: scaling_group + type: string + x-go-name: ScalingGroup + - description: 'description: trigger type' + enum: + - timing + - cycel + - alarm + example: alarm + in: query + name: trigger_type + type: string + x-go-name: TriggerType + responses: + "200": + $ref: '#/responses/scaling_policy_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_policy + post: + description: 新建 + operationId: scaling_policy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_policy: + $ref: '#/definitions/ScalingPolicyCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_policy + /scaling_policies/{id}: + delete: + description: 删除 + operationId: scaling_policy_CustomizeDelete + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_policy + get: + description: 获取详情 + operationId: scaling_policy_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_policy + put: + description: 更新 + operationId: scaling_policy_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_policy + /scaling_policies/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: scaling_policy_PerformCancelDelete + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - scaling_policy + /scaling_policies/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: scaling_policy_PerformChangeOwner + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - scaling_policy + /scaling_policies/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: scaling_policy_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - scaling_policy + /scaling_policies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_policy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_policy + post: + description: 执行操作ClassMetadata + operationId: scaling_policy_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_policy + /scaling_policies/{id}/disable: + post: + description: 执行操作Disable + operationId: scaling_policy_PerformDisable + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformDisableOutput' + summary: 执行操作Disable + tags: + - scaling_policy + /scaling_policies/{id}/enable: + post: + description: 执行操作Enable + operationId: scaling_policy_PerformEnable + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformEnableOutput' + summary: 执行操作Enable + tags: + - scaling_policy + /scaling_policies/{id}/freeze: + post: + description: 执行操作Freeze + operationId: scaling_policy_PerformFreeze + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - scaling_policy + /scaling_policies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_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 scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_policy + /scaling_policies/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: scaling_policy_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - scaling_policy + /scaling_policies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_policy_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_policy + /scaling_policies/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: scaling_policy_PerformSetOrgMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_policy + /scaling_policies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_policy_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_policy + /scaling_policies/{id}/status: + get: + description: 获取指定信息Status + operationId: scaling_policy_GetDetailsStatus + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - scaling_policy + post: + description: 执行操作Status + operationId: scaling_policy_PerformStatus + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformStatusOutput' + summary: 更新资源状态 + tags: + - scaling_policy + /scaling_policies/{id}/trigger: + post: + description: 执行操作Trigger + operationId: scaling_policy_PerformTrigger + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_PerformTriggerOutput' + summary: 执行操作Trigger + tags: + - scaling_policy + /scaling_policies/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: scaling_policy_PerformUnfreeze + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - scaling_policy + /scaling_policies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_policy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_policy + /scaling_policies/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: scaling_policy_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - scaling_policy + /scaling_policies/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: scaling_policy_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - scaling_policy + /scaling_policies/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: scaling_policy_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - scaling_policy + /scaling_policies/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: scaling_policy_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - scaling_policy + /scaling_policies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_policy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_policy + /scaling_policies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_policy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_policy + /scaling_policies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_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/scaling_policy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_policy + /scaling_policies/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: scaling_policy_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - scaling_policy + /scaling_policies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_policy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_policy + /scaling_policies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_policy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_policy + /scaling_timers: + get: + description: 列表 + operationId: scaling_timer_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/scaling_timer_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_timer + post: + description: 新建 + operationId: scaling_timer_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_timer: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_timer + /scaling_timers/{id}: + delete: + description: 删除 + operationId: scaling_timer_CustomizeDelete + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_timer_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_timer + get: + description: 获取详情 + operationId: scaling_timer_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_timer_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_timer + put: + description: 更新 + operationId: scaling_timer_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_timer + /scaling_timers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_timer_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_timer_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_timer + post: + description: 执行操作ClassMetadata + operationId: scaling_timer_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_timer + /scaling_timers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_timer_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 scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_timer_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_timer + /scaling_timers/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: scaling_timer_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_timer_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - scaling_timer + /scaling_timers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_timer_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_timer + /scaling_timers/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: scaling_timer_PerformSetOrgMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_timer + /scaling_timers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_timer_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_timer + /scaling_timers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_timer_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_timer_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_timer + /scaling_timers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_timer_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_timer: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_timer + /scaling_timers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_timer_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_timer_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_timer + /scaling_timers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_timer_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/scaling_timer_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_timer + /scaling_timers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_timer_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_timer_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_timer + /scaling_timers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_timer_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_timer_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_timer + /schedpolicies: + get: + description: 列表 + operationId: schedpolicy_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: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - in: query + items: + type: string + name: strategy + type: array + x-go-name: Strategy + - in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/schedpolicy_ListItemFilterOutput' + summary: 动态调度策略列表 + tags: + - schedpolicy + post: + description: 新建 + operationId: schedpolicy_ValidateCreateData + responses: + "200": + $ref: '#/responses/schedpolicy_ValidateCreateDataOutput' + summary: 新建 + tags: + - schedpolicy + /schedpolicies/{id}: + delete: + description: 删除 + operationId: schedpolicy_CustomizeDelete + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_CustomizeDeleteOutput' + summary: 删除 + tags: + - schedpolicy + get: + description: 获取详情 + operationId: schedpolicy_FetchCustomizeColumns + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - schedpolicy + put: + description: 更新 + operationId: schedpolicy_ValidateUpdateData + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - schedpolicy + /schedpolicies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: schedpolicy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - schedpolicy + post: + description: 执行操作ClassMetadata + operationId: schedpolicy_PerformClassMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedpolicy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - schedpolicy + /schedpolicies/{id}/evaluate: + post: + description: 执行操作Evaluate + operationId: schedpolicy_PerformEvaluate + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_PerformEvaluateOutput' + summary: 执行操作Evaluate + tags: + - schedpolicy + /schedpolicies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: schedpolicy_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 schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - schedpolicy + /schedpolicies/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: schedpolicy_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - schedpolicy + /schedpolicies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: schedpolicy_PerformSetClassMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedpolicy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - schedpolicy + /schedpolicies/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: schedpolicy_PerformSetOrgMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedpolicy_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - schedpolicy + /schedpolicies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: schedpolicy_PerformSetUserMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedpolicy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - schedpolicy + /schedpolicies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: schedpolicy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/schedpolicy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - schedpolicy + /schedpolicies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: schedpolicy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + schedpolicy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedpolicy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - schedpolicy + /schedpolicies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: schedpolicy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/schedpolicy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - schedpolicy + /schedpolicies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: schedpolicy_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/schedpolicy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - schedpolicy + /schedpolicies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: schedpolicy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/schedpolicy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - schedpolicy + /schedpolicies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: schedpolicy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/schedpolicy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - schedpolicy + /schedtags: + get: + description: 列表 + operationId: schedtag_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: fitler by resource_type + in: query + items: + type: string + name: resource_type + type: array + x-go-name: ResourceType + - in: query + items: + type: string + name: default_strategy + type: array + x-go-name: DefaultStrategy + responses: + "200": + $ref: '#/responses/schedtag_ListItemFilterOutput' + summary: 调度标签列表 + tags: + - schedtag + post: + description: 新建 + operationId: schedtag_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + schedtag: + $ref: '#/definitions/SchedtagCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_ValidateCreateDataOutput' + summary: 新建 + tags: + - schedtag + /schedtags/{id}: + delete: + description: 删除 + operationId: schedtag_CustomizeDelete + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_CustomizeDeleteOutput' + summary: 删除 + tags: + - schedtag + get: + description: 获取详情 + operationId: schedtag_FetchCustomizeColumns + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - schedtag + put: + description: 更新 + operationId: schedtag_ValidateUpdateData + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_ValidateUpdateDataOutput' + summary: 更新 + tags: + - schedtag + /schedtags/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: schedtag_GetDetailsClassMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - schedtag + post: + description: 执行操作ClassMetadata + operationId: schedtag_PerformClassMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - schedtag + /schedtags/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: schedtag_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 schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - schedtag + /schedtags/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: schedtag_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - schedtag + /schedtags/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: schedtag_PerformSetClassMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - schedtag + /schedtags/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: schedtag_PerformSetOrgMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - schedtag + /schedtags/{id}/set-resource: + post: + description: 执行操作SetResource + operationId: schedtag_PerformSetResource + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagSetResourceInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformSetResourceOutput' + summary: 执行操作SetResource + tags: + - schedtag + /schedtags/{id}/set-scope: + post: + description: 执行操作SetScope + operationId: schedtag_PerformSetScope + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_PerformSetScopeOutput' + summary: 执行操作SetScope + tags: + - schedtag + /schedtags/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: schedtag_PerformSetUserMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - schedtag + /schedtags/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: schedtag_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/schedtag_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - schedtag + /schedtags/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: schedtag_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + schedtag: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - schedtag + /schedtags/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: schedtag_GetPropertySplitable + responses: + "200": + $ref: '#/responses/schedtag_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - schedtag + /schedtags/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: schedtag_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/schedtag_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - schedtag + /schedtags/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: schedtag_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/schedtag_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - schedtag + /schedtags/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: schedtag_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/schedtag_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - schedtag + /security_group_rules: + get: + description: 列表 + operationId: security_group_rule_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + - in: query + items: + type: string + name: projects + type: array + x-go-name: Projects + - description: 以direction字段过滤安全组规则 + in: query + name: direction + type: string + x-go-name: Direction + - description: 以action字段过滤安全组规则 + in: query + name: action + type: string + x-go-name: Action + - description: 以protocol字段过滤安全组规则 + in: query + name: protocol + type: string + x-go-name: Protocol + - description: 以ports字段过滤安全组规则 + in: query + name: ports + type: string + x-go-name: Ports + - description: 根据ip模糊匹配安全组规则 + in: query + name: ip + type: string + x-go-name: Ip + responses: + "200": + $ref: '#/responses/security_group_rule_ListItemFilterOutput' + summary: 安全组规则列表 + tags: + - security_group_rule + post: + description: 新建 + operationId: security_group_rule_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + security_group_rule: + $ref: '#/definitions/SSecgroupRuleCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_rule_ValidateCreateDataOutput' + summary: 新建 + tags: + - security_group_rule + /security_group_rules/{id}: + delete: + description: 删除 + operationId: security_group_rule_CustomizeDelete + parameters: + - description: The Id or Name of security_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_rule_CustomizeDeleteOutput' + summary: 删除 + tags: + - security_group_rule + get: + description: 获取详情 + operationId: security_group_rule_FetchCustomizeColumns + parameters: + - description: The Id or Name of security_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_rule_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - security_group_rule + put: + description: 更新 + operationId: security_group_rule_ValidateUpdateData + parameters: + - description: The Id or Name of security_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group_rule: + $ref: '#/definitions/SSecgroupRuleUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_rule_ValidateUpdateDataOutput' + summary: 更新 + tags: + - security_group_rule + /security_group_rules/{id}/status: + get: + description: 获取指定信息Status + operationId: security_group_rule_GetDetailsStatus + parameters: + - description: The Id or Name of security_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_rule_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - security_group_rule + /security_group_rules/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: security_group_rule_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/security_group_rule_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - security_group_rule + /security_group_rules/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: security_group_rule_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + security_group_rule: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_rule_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - security_group_rule + /security_group_rules/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: security_group_rule_GetPropertySplitable + responses: + "200": + $ref: '#/responses/security_group_rule_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - security_group_rule + /security_group_rules/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: security_group_rule_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/security_group_rule_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - security_group_rule + /security_groups: + get: + description: 列表 + operationId: security_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: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 按缓存关联主机数排序 + in: query + name: order_by_guest_cnt + pattern: asc|desc + type: string + x-go-name: OrderByGuestCnt + - description: 模糊过滤规则中含有指定ip的安全组 + example: 10.10.2.1 + in: query + name: ip + type: string + x-go-name: Ip + - description: 精确匹配规则中含有指定端口的安全组 + example: 100-200 + in: query + name: ports + type: string + x-go-name: Ports + - default: all + description: '指定过滤规则的方向(仅在指定ip或ports时生效) choices: all|in|out' + example: in + in: query + name: direction + type: string + x-go-name: Direction + - in: query + name: vpc_id + type: string + x-go-name: VpcId + - in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + responses: + "200": + $ref: '#/responses/security_group_ListItemFilterOutput' + summary: 安全组列表 + tags: + - security_group + post: + description: 新建 + operationId: security_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + security_group: + $ref: '#/definitions/SSecgroupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - security_group + /security_groups/{id}: + delete: + description: 删除 + operationId: security_group_CustomizeDelete + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - security_group + get: + description: 获取详情 + operationId: security_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - security_group + put: + description: 更新 + operationId: security_group_ValidateUpdateData + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - security_group + /security_groups/{id}/add-rule: + post: + description: 执行操作AddRule + operationId: security_group_PerformAddRule + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_PerformAddRuleOutput' + summary: 执行操作AddRule + tags: + - security_group + /security_groups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: security_group_PerformCancelDelete + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - security_group + /security_groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: security_group_PerformChangeOwner + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - security_group + /security_groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: security_group_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - security_group + /security_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: security_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - security_group + post: + description: 执行操作ClassMetadata + operationId: security_group_PerformClassMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - security_group + /security_groups/{id}/clone: + post: + description: 执行操作Clone + operationId: security_group_PerformClone + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/SecurityGroupCloneInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformCloneOutput' + summary: 执行操作Clone + tags: + - security_group + /security_groups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: security_group_PerformFreeze + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - security_group + /security_groups/{id}/import-rules: + post: + description: 执行操作ImportRules + operationId: security_group_PerformImportRules + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupImportRulesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformImportRulesOutput' + summary: 执行操作ImportRules + tags: + - security_group + /security_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: security_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 security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - security_group + /security_groups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: security_group_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - security_group + /security_groups/{id}/private: + post: + description: 执行操作Private + operationId: security_group_PerformPrivate + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformPrivateOutput' + summary: 执行操作Private + tags: + - security_group + /security_groups/{id}/public: + post: + description: 执行操作Public + operationId: security_group_PerformPublic + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformPublicOutput' + summary: 执行操作Public + tags: + - security_group + /security_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: security_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - security_group + /security_groups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: security_group_PerformSetOrgMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - security_group + /security_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: security_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - security_group + /security_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: security_group_GetDetailsStatus + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - security_group + post: + description: 执行操作Status + operationId: security_group_PerformStatus + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - security_group + /security_groups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: security_group_PerformSyncstatus + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/SecurityGroupSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - security_group + /security_groups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: security_group_PerformUnfreeze + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - security_group + /security_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: security_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/security_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - security_group + /security_groups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: security_group_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/security_group_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - security_group + /security_groups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: security_group_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/security_group_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - security_group + /security_groups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: security_group_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/security_group_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - security_group + /security_groups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: security_group_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/security_group_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - security_group + /security_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: security_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - security_group + /security_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: security_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/security_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - security_group + /security_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: security_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/security_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - security_group + /security_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: security_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/security_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - security_group + /security_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: security_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/security_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - security_group + /security_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: security_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/security_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - security_group + /server_skus: + get: + description: 列表 + operationId: server_sku_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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter sku by memory size in MB + in: query + items: + format: int64 + type: integer + name: memory_size_mb + type: array + x-go-name: MemorySizeMb + - description: filter sku by CPU core count + in: query + items: + format: int64 + type: integer + name: cpu_core_count + type: array + x-go-name: CpuCoreCount + - description: 后付费状态 + in: query + name: postpaid_status + type: string + x-go-name: PostpaidStatus + - description: 预付费状态 + in: query + name: prepaid_status + type: string + x-go-name: PrepaidStatus + - description: 按套餐名称去重 + in: query + name: distinct + type: boolean + x-go-name: Distinct + - description: |- + 根据cpu架构过滤 + enmu: arm, x86 + in: query + items: + type: string + name: cpu_arch + type: array + x-go-name: CpuArch + - description: 按关联虚拟机数量排序 + in: query + name: order_by_total_guest_count + type: string + x-go-name: OrderByTotalGuestCount + responses: + "200": + $ref: '#/responses/server_sku_ListItemFilterOutput' + summary: 主机套餐规格列表 + tags: + - server_sku + post: + description: 新建 + operationId: server_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + server_sku: + $ref: '#/definitions/ServerSkuCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - server_sku + /server_skus/{id}: + delete: + description: 删除 + operationId: server_sku_CustomizeDelete + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - server_sku + get: + description: 获取详情 + operationId: server_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - server_sku + put: + description: 更新 + operationId: server_sku_ValidateUpdateData + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - server_sku + /server_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: server_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - server_sku + post: + description: 执行操作ClassMetadata + operationId: server_sku_PerformClassMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - server_sku + /server_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: server_sku_PerformDisable + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - server_sku + /server_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: server_sku_PerformEnable + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - server_sku + /server_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: server_sku_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 server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - server_sku + /server_skus/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: server_sku_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - server_sku + /server_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: server_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - server_sku + /server_skus/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: server_sku_PerformSetOrgMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - server_sku + /server_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: server_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - server_sku + /server_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: server_sku_GetDetailsStatus + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - server_sku + post: + description: 执行操作Status + operationId: server_sku_PerformStatus + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - server_sku + /server_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: server_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - server_sku + /server_skus/instance-specs: + get: + description: 获取指定资源类的信息InstanceSpecs + operationId: server_sku_GetPropertyInstanceSpecs + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyInstanceSpecsOutput' + summary: 获取指定资源类的信息InstanceSpecs + tags: + - server_sku + /server_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: server_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - server_sku + /server_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: server_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/server_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - server_sku + /server_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: server_sku_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/server_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - server_sku + /server_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: server_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - server_sku + /server_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: server_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - server_sku + /server_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: server_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/server_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - server_sku + /server_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: server_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - server_sku + /server_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: server_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - server_sku + /servers: + get: + description: 列表 + operationId: server_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + items: + type: string + name: host_sn + type: array + x-go-name: HostSN + - description: 以宿主机对接二层网络过滤 + in: query + name: host_wire_id + type: string + x-go-name: HostWireId + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: 实例组（ID或Name） + in: query + name: group_id + type: string + x-go-name: GroupId + - description: 按组名排序 + in: query + name: order_by_group + type: string + x-go-name: OrderByGroup + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + - description: 'description: 伸缩组 Id or Name' + example: sg-1234 + in: query + name: scaling_group + type: string + x-go-name: ScalingGroup + - description: 只列出裸金属主机 + in: query + name: baremetal + type: boolean + x-go-name: Baremetal + - description: 只列出透传了 GPU 的主机 + in: query + name: gpu + type: boolean + x-go-name: Gpu + - description: 只列出透传了 USB 的主机 + in: query + name: usb + type: boolean + x-go-name: Usb + - description: 自定义 PCI 设备类型 + in: query + name: custom_dev_type + type: string + x-go-name: CustomDevType + - description: 通用虚拟机 + in: query + name: normal + type: boolean + x-go-name: Normal + - description: 只列出还有备份机的主机 + in: query + name: bakcup + type: boolean + x-go-name: Backup + - description: 列出指定类型的主机 + enum: + - normal + - gpu + - usb + - backup + in: query + items: + type: string + name: server_type + type: array + x-go-name: ServerType + - description: 列出管理安全组为指定安全组的主机 + in: query + name: admin_security + type: string + x-go-name: AdminSecgroup + - description: 列出Hypervisor为指定值的主机 + enum: + - kvm + - esxi + - baremetal + - aliyun + - azure + - aws + - huawei + - ucloud + - zstack + - openstack + - google + - ctyun + - cloudpods + - ecloud + - jdcloud + - remotefile` + in: query + items: + type: string + name: hypervisor + type: array + x-go-name: Hypervisor + - description: 列出绑定了弹性IP（EIP）的主机 + in: query + name: with_eip + type: boolean + x-go-name: WithEip + - description: 列出未绑定弹性IP（EIP）的主机 + in: query + name: without_eip + type: boolean + x-go-name: WithoutEip + - description: 列出可绑定弹性IP的主机 + in: query + name: eip_associable + type: boolean + x-go-name: EipAssociable + - description: 列出操作系统为指定值的主机 + enum: + - linux + - windows + - vmware + in: query + items: + type: string + name: os_type + type: array + x-go-name: OsType + - description: 操作系统发行版 + in: query + items: + type: string + name: os_dist + type: array + x-go-name: OsDist + - description: 对列表结果按照磁盘大小进行排序 + enum: + - asc + - desc + in: query + name: order_by_disk + type: string + x-go-name: OrderByDisk + - in: query + name: order_by_ip + type: string + x-go-name: OrderByIp + - description: 根据ip查找机器 + in: query + name: ip_addr + type: string + x-go-name: IpAddr + - description: 根据多个ip查找机器 + in: query + items: + type: string + name: ip_addrs + type: array + x-go-name: IpAddrs + - description: 列出可以挂载指定EIP的主机 + in: query + name: usable_server_for_eip + type: string + x-go-name: UsableServerForEip + - description: 列出可以挂载磁盘的主机 + in: query + name: attachable_servers_for_disk + type: string + x-go-name: AttachableServersForDisk + - description: |- + Deprecated + 列出可以挂载磁盘的主机 + in: query + name: disk + type: string + x-go-name: Disk + - description: 按主机资源类型进行排序 + enum: + - shared + - prepaid + - dedicated + in: query + name: resource_type + type: string + x-go-name: ResourceType + - description: 返回该宿主机上的所有虚拟机，包括备份机 + in: query + name: get_all_guests_on_host + type: string + x-go-name: GetAllGuestsOnHost + - in: query + items: + format: int64 + type: integer + name: vcpu_count + type: array + x-go-name: VcpuCount + - in: query + items: + format: int64 + type: integer + name: vmem_size + type: array + x-go-name: VmemSize + - in: query + items: + type: string + name: boot_order + type: array + x-go-name: BootOrder + - in: query + items: + type: string + name: vga + type: array + x-go-name: Vga + - in: query + items: + type: string + name: vdi + type: array + x-go-name: Vdi + - in: query + items: + type: string + name: machine + type: array + x-go-name: Machine + - in: query + items: + type: string + name: bios + type: array + x-go-name: Bios + - in: query + name: src_ip_check + type: boolean + x-go-name: SrcIpCheck + - in: query + name: src_mac_check + type: boolean + x-go-name: SrcMacCheck + - in: query + items: + type: string + name: instance_type + type: array + x-go-name: InstanceType + - description: 根据镜像发行版排序 + in: query + name: order_by_os_dist + type: string + x-go-name: OrderByOsDist + - description: 是否调度到宿主机上 + in: query + name: with_host + type: boolean + x-go-name: WithHost + responses: + "200": + $ref: '#/responses/server_ListItemFilterOutput' + summary: 云主机实例列表 + tags: + - server + post: + description: 新建 + operationId: server_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + server: + $ref: '#/definitions/ServerCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_ValidateCreateDataOutput' + summary: 创建虚拟机实例 + tags: + - server + /servers/{id}: + delete: + description: 删除 + operationId: server_CustomizeDelete + parameters: + - default: false + description: 是否越过回收站直接删除 + in: query + name: OverridePendingDelete + type: boolean + - default: false + description: 是否仅删除本地资源 + in: query + name: Purge + type: boolean + - default: false + description: 是否删除快照 + in: query + name: DeleteSnapshots + type: boolean + - default: false + description: 是否删除关联的EIP + in: query + name: DeleteEip + type: boolean + - default: false + description: 是否删除关联的数据盘 + in: query + name: DeleteDisks + type: boolean + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_CustomizeDeleteOutput' + summary: 删除虚拟机 + tags: + - server + get: + description: 获取详情 + operationId: server_FetchCustomizeColumns + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - server + put: + description: 更新 + operationId: server_ValidateUpdateData + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_ValidateUpdateDataOutput' + summary: 更新 + tags: + - server + /servers/{id}/add-secgroup: + post: + description: 执行操作AddSecgroup + operationId: server_PerformAddSecgroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestAddSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAddSecgroupOutput' + summary: 绑定多个安全组 + tags: + - server + /servers/{id}/add-sub-ips: + post: + description: 执行操作AddSubIps + operationId: server_PerformAddSubIps + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestAddSubIpsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAddSubIpsOutput' + summary: 执行操作AddSubIps + tags: + - server + /servers/{id}/associate-eip: + post: + description: 执行操作AssociateEip + operationId: server_PerformAssociateEip + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerAssociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAssociateEipOutput' + summary: 绑定EIP + tags: + - server + /servers/{id}/attach-isolated-device: + post: + description: 执行操作AttachIsolatedDevice + operationId: server_PerformAttachIsolatedDevice + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformAttachIsolatedDeviceOutput' + summary: 挂载透传设备 + tags: + - server + /servers/{id}/attachdisk: + post: + description: 执行操作Attachdisk + operationId: server_PerformAttachdisk + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerAttachDiskInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAttachdiskOutput' + summary: 绑定磁盘 + tags: + - server + /servers/{id}/attachnetwork: + post: + description: 执行操作Attachnetwork + operationId: server_PerformAttachnetwork + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/AttachNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAttachnetworkOutput' + summary: 挂载网卡 + tags: + - server + /servers/{id}/bind-groups: + post: + description: 执行操作BindGroups + operationId: server_PerformBindGroups + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformBindGroupsOutput' + summary: 执行操作BindGroups + tags: + - server + /servers/{id}/block-mirror-ready: + post: + description: 执行操作BlockMirrorReady + operationId: server_PerformBlockMirrorReady + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformBlockMirrorReadyOutput' + summary: 执行操作BlockMirrorReady + tags: + - server + /servers/{id}/block-stream-failed: + post: + description: 执行操作BlockStreamFailed + operationId: server_PerformBlockStreamFailed + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformBlockStreamFailedOutput' + summary: 执行操作BlockStreamFailed + tags: + - server + /servers/{id}/calculate-record-checksum: + post: + description: 执行操作CalculateRecordChecksum + operationId: server_PerformCalculateRecordChecksum + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCalculateRecordChecksumOutput' + summary: 执行操作CalculateRecordChecksum + tags: + - server + /servers/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: server_PerformCancelDelete + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCancelDeleteOutput' + summary: 从回收站恢复虚拟机 + tags: + - server + /servers/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: server_PerformCancelExpire + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCancelExpireOutput' + summary: 取消定时删除 + tags: + - server + /servers/{id}/cancel-live-migrate: + post: + description: 执行操作CancelLiveMigrate + operationId: server_PerformCancelLiveMigrate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCancelLiveMigrateOutput' + summary: 取消在线迁移 + tags: + - server + /servers/{id}/change-bandwidth: + post: + description: 执行操作ChangeBandwidth + operationId: server_PerformChangeBandwidth + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerChangeBandwidthInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeBandwidthOutput' + summary: 调整带宽 + tags: + - server + /servers/{id}/change-config: + post: + description: 执行操作ChangeConfig + operationId: server_PerformChangeConfig + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerChangeConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeConfigOutput' + summary: 调整配置 + tags: + - server + /servers/{id}/change-disk-storage: + post: + description: 执行操作ChangeDiskStorage + operationId: server_PerformChangeDiskStorage + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerChangeDiskStorageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeDiskStorageOutput' + summary: 执行操作ChangeDiskStorage + tags: + - server + /servers/{id}/change-ipaddr: + post: + description: |- + first detach the network, then attach a network with identity mac address but different IP configurations + TODO change IP address of a teaming NIC may fail!! + operationId: server_PerformChangeIpaddr + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerChangeIpaddrInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeIpaddrOutput' + summary: Change IPaddress of a guestnetwork + tags: + - server + /servers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: server_PerformChangeOwner + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeOwnerOutput' + summary: 更改项目 + tags: + - server + /servers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: server_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - server + /servers/{id}/change-storage: + post: + description: 执行操作ChangeStorage + operationId: server_PerformChangeStorage + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerChangeStorageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeStorageOutput' + summary: 更改存储 + tags: + - server + /servers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: server_GetDetailsClassMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - server + post: + description: 执行操作ClassMetadata + operationId: server_PerformClassMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - server + /servers/{id}/clone: + post: + description: 执行操作Clone + operationId: server_PerformClone + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCloneOutput' + summary: 克隆虚拟机 + tags: + - server + /servers/{id}/close-forward: + post: + description: 执行操作CloseForward + operationId: server_PerformCloseForward + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCloseForwardOutput' + summary: 执行操作CloseForward + tags: + - server + /servers/{id}/convert: + post: + description: 执行操作Convert + operationId: server_PerformConvert + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ConvertToKvmInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformConvertOutput' + summary: 执行操作Convert + tags: + - server + /servers/{id}/convert-to-kvm: + post: + description: 执行操作ConvertToKvm + operationId: server_PerformConvertToKvm + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ConvertToKvmInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformConvertToKvmOutput' + summary: 执行操作ConvertToKvm + tags: + - server + /servers/{id}/cpuset: + post: + description: 执行操作Cpuset + operationId: server_PerformCpuset + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerCPUSetInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformCpusetOutput' + summary: 执行操作Cpuset + tags: + - server + /servers/{id}/cpuset-cores: + get: + description: 获取指定信息CpusetCores + operationId: server_GetDetailsCpusetCores + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsCpusetCoresOutput' + summary: 获取指定信息CpusetCores + tags: + - server + /servers/{id}/cpuset-remove: + post: + description: 执行操作CpusetRemove + operationId: server_PerformCpusetRemove + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerCPUSetRemoveInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformCpusetRemoveOutput' + summary: 执行操作CpusetRemove + tags: + - server + /servers/{id}/create-backup: + post: + description: 执行操作CreateBackup + operationId: server_PerformCreateBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCreateBackupOutput' + summary: 创建备机 + tags: + - server + /servers/{id}/create-eip: + post: + description: 执行操作CreateEip + operationId: server_PerformCreateEip + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerCreateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformCreateEipOutput' + summary: 创建EIP + tags: + - server + /servers/{id}/create-params: + get: + description: 获取指定信息CreateParams + operationId: server_GetDetailsCreateParams + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsCreateParamsOutput' + summary: 获取指定信息CreateParams + tags: + - server + /servers/{id}/createdisk: + post: + description: 执行操作Createdisk + operationId: server_PerformCreatedisk + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCreatediskOutput' + summary: 创建虚拟机磁盘 + tags: + - server + /servers/{id}/del-extra-option: + post: + description: 执行操作DelExtraOption + operationId: server_PerformDelExtraOption + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDelExtraOptionInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDelExtraOptionOutput' + summary: 执行操作DelExtraOption + tags: + - server + /servers/{id}/delete-backup: + post: + description: 执行操作DeleteBackup + operationId: server_PerformDeleteBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformDeleteBackupOutput' + summary: 删除备机 + tags: + - server + /servers/{id}/deploy: + post: + description: 执行操作Deploy + operationId: server_PerformDeploy + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDeployInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDeployOutput' + summary: 重置密码或秘钥信息&探测虚拟机镜像 + tags: + - server + /servers/{id}/desc: + get: + description: 获取指定信息Desc + operationId: server_GetDetailsDesc + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsDescOutput' + summary: 获取指定信息Desc + tags: + - server + /servers/{id}/detach-isolated-device: + post: + description: 执行操作DetachIsolatedDevice + operationId: server_PerformDetachIsolatedDevice + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformDetachIsolatedDeviceOutput' + summary: 卸载透传设备 + tags: + - server + /servers/{id}/detach-scaling-group: + post: + description: 执行操作DetachScalingGroup + operationId: server_PerformDetachScalingGroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/SGPerformDetachScalingGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDetachScalingGroupOutput' + summary: 执行操作DetachScalingGroup + tags: + - server + /servers/{id}/detachdisk: + post: + description: 执行操作Detachdisk + operationId: server_PerformDetachdisk + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDetachDiskInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDetachdiskOutput' + summary: 卸载磁盘 + tags: + - server + /servers/{id}/detachnetwork: + post: + description: 执行操作Detachnetwork + operationId: server_PerformDetachnetwork + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDetachnetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDetachnetworkOutput' + summary: 卸载网卡 + tags: + - server + /servers/{id}/dissociate-eip: + post: + description: 执行操作DissociateEip + operationId: server_PerformDissociateEip + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDissociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDissociateEipOutput' + summary: 解绑EIP + tags: + - server + /servers/{id}/ejectiso: + post: + description: 执行操作Ejectiso + operationId: server_PerformEjectiso + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformEjectisoOutput' + summary: 卸载ISO镜像 + tags: + - server + /servers/{id}/ejectvfd: + post: + description: 执行操作Ejectvfd + operationId: server_PerformEjectvfd + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerEjectVfdInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformEjectvfdOutput' + summary: 卸载软盘 + tags: + - server + /servers/{id}/enable-memclean: + post: + description: 执行操作EnableMemclean + operationId: server_PerformEnableMemclean + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformEnableMemcleanOutput' + summary: 执行操作EnableMemclean + tags: + - server + /servers/{id}/freeze: + post: + description: 执行操作Freeze + operationId: server_PerformFreeze + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformFreezeOutput' + summary: 冻结虚拟机 + tags: + - server + /servers/{id}/hardware-info: + get: + description: 获取指定信息HardwareInfo + operationId: server_GetDetailsHardwareInfo + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsHardwareInfoOutput' + summary: 获取指定信息HardwareInfo + tags: + - server + /servers/{id}/have-agent: + post: + description: 执行操作HaveAgent + operationId: server_PerformHaveAgent + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestHaveAgentInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformHaveAgentOutput' + summary: 执行操作HaveAgent + tags: + - server + /servers/{id}/insertiso: + post: + description: 执行操作Insertiso + operationId: server_PerformInsertiso + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformInsertisoOutput' + summary: 挂载ISO镜像 + tags: + - server + /servers/{id}/insertvfd: + post: + description: 执行操作Insertvfd + operationId: server_PerformInsertvfd + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerInsertVfdInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformInsertvfdOutput' + summary: 挂载软盘 + tags: + - server + /servers/{id}/instance-backup: + post: + description: 执行操作InstanceBackup + operationId: server_PerformInstanceBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerCreateInstanceBackupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformInstanceBackupOutput' + summary: 执行操作InstanceBackup + tags: + - server + /servers/{id}/instance-snapshot: + post: + description: |- + 2. validate every disk manual snapshot count + 3. validate snapshot quota with disk count + operationId: server_PerformInstanceSnapshot + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerInstanceSnapshot' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformInstanceSnapshotOutput' + summary: 1. validate guest status, guest hypervisor + tags: + - server + /servers/{id}/instance-snapshot-reset: + post: + description: 执行操作InstanceSnapshotReset + operationId: server_PerformInstanceSnapshotReset + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerResetInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformInstanceSnapshotResetOutput' + summary: 执行操作InstanceSnapshotReset + tags: + - server + /servers/{id}/io-throttle: + post: + description: 执行操作IoThrottle + operationId: server_PerformIoThrottle + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSetDiskIoThrottleInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformIoThrottleOutput' + summary: 磁盘限速 + tags: + - server + /servers/{id}/iso: + get: + description: 获取指定信息Iso + operationId: server_GetDetailsIso + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsIsoOutput' + summary: 获取指定信息Iso + tags: + - server + /servers/{id}/jnlp: + get: + description: 获取指定信息Jnlp + operationId: server_GetDetailsJnlp + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsJnlpOutput' + summary: 获取指定信息Jnlp + tags: + - server + /servers/{id}/list-forward: + post: + description: 执行操作ListForward + operationId: server_PerformListForward + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformListForwardOutput' + summary: 执行操作ListForward + tags: + - server + /servers/{id}/live-migrate: + post: + description: 执行操作LiveMigrate + operationId: server_PerformLiveMigrate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestLiveMigrateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformLiveMigrateOutput' + summary: 在线迁移虚拟机 + tags: + - server + /servers/{id}/login-info: + post: + description: 执行操作LoginInfo + operationId: server_PerformLoginInfo + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerLoginInfoInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformLoginInfoOutput' + summary: 执行操作LoginInfo + tags: + - server + /servers/{id}/make-sshable: + post: + description: 执行操作MakeSshable + operationId: server_PerformMakeSshable + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestMakeSshableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMakeSshableOutput' + summary: 执行操作MakeSshable + tags: + - server + /servers/{id}/make-sshable-cmd: + get: + description: 获取指定信息MakeSshableCmd + operationId: server_GetDetailsMakeSshableCmd + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsMakeSshableCmdOutput' + summary: 获取指定信息MakeSshableCmd + tags: + - server + /servers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: server_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 server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - server + /servers/{id}/migrate: + post: + description: 执行操作Migrate + operationId: server_PerformMigrate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestMigrateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMigrateOutput' + summary: 冷迁移虚拟机 + tags: + - server + /servers/{id}/migrate-forecast: + post: + description: 执行操作MigrateForecast + operationId: server_PerformMigrateForecast + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerMigrateForecastInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMigrateForecastOutput' + summary: 迁移调度 + tags: + - server + /servers/{id}/migrate-network: + post: + description: 'Scenerio: the server used to be in a VPC, migrate it to a underlay network without network interruption' + operationId: server_PerformMigrateNetwork + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerMigrateNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMigrateNetworkOutput' + summary: Migrate a server from one network to another network, without change IP address + tags: + - server + /servers/{id}/modify-src-check: + post: + description: 执行操作ModifySrcCheck + operationId: server_PerformModifySrcCheck + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformModifySrcCheckOutput' + summary: 修改源地址检查 + tags: + - server + /servers/{id}/monitor: + post: + description: 执行操作Monitor + operationId: server_PerformMonitor + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerMonitorInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMonitorOutput' + summary: 远程执行QMP命令 + tags: + - server + /servers/{id}/open-forward: + post: + description: 执行操作OpenForward + operationId: server_PerformOpenForward + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformOpenForwardOutput' + summary: 执行操作OpenForward + tags: + - server + /servers/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: server_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - server + /servers/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: server_PerformPostpaidExpire + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformPostpaidExpireOutput' + summary: 设置定时删除 + tags: + - server + /servers/{id}/prepaid-recycle: + post: + description: 执行操作PrepaidRecycle + operationId: server_PerformPrepaidRecycle + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformPrepaidRecycleOutput' + summary: 执行操作PrepaidRecycle + tags: + - server + /servers/{id}/probe-isolated-devices: + post: + description: 执行操作ProbeIsolatedDevices + operationId: server_PerformProbeIsolatedDevices + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformProbeIsolatedDevicesOutput' + summary: 探测透传设备 + tags: + - server + /servers/{id}/publicip-to-eip: + post: + description: |- + 要求虚拟机有公网IP,并且虚拟机状态为running 或 ready + 目前仅支持阿里云和腾讯云 + operationId: server_PerformPublicipToEip + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestPublicipToEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformPublicipToEipOutput' + summary: 公网Ip转Eip + tags: + - server + /servers/{id}/purge: + post: + description: 执行操作Purge + operationId: server_PerformPurge + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformPurgeOutput' + summary: 清除虚拟机记录(仅数据库操作) + tags: + - server + /servers/{id}/qemu-info: + get: + description: 获取指定信息QemuInfo + operationId: server_GetDetailsQemuInfo + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsQemuInfoOutput' + summary: 获取指定信息QemuInfo + tags: + - server + /servers/{id}/qga-command: + post: + description: 执行操作QgaCommand + operationId: server_PerformQgaCommand + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerQgaCommandInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformQgaCommandOutput' + summary: 执行操作QgaCommand + tags: + - server + /servers/{id}/qga-get-network: + post: + description: 执行操作QgaGetNetwork + operationId: server_PerformQgaGetNetwork + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerQgaGetNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformQgaGetNetworkOutput' + summary: 执行操作QgaGetNetwork + tags: + - server + /servers/{id}/qga-guest-info-task: + post: + description: 执行操作QgaGuestInfoTask + operationId: server_PerformQgaGuestInfoTask + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerQgaGuestInfoTaskInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformQgaGuestInfoTaskOutput' + summary: 执行操作QgaGuestInfoTask + tags: + - server + /servers/{id}/qga-ping: + post: + description: 执行操作QgaPing + operationId: server_PerformQgaPing + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerQgaTimeoutInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformQgaPingOutput' + summary: 执行操作QgaPing + tags: + - server + /servers/{id}/qga-set-password: + post: + description: 执行操作QgaSetPassword + operationId: server_PerformQgaSetPassword + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerQgaSetPasswordInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformQgaSetPasswordOutput' + summary: 执行操作QgaSetPassword + tags: + - server + /servers/{id}/rebuild-root: + post: + description: 执行操作RebuildRoot + operationId: server_PerformRebuildRoot + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerRebuildRootInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformRebuildRootOutput' + summary: 重装系统(更换系统镜像) + tags: + - server + /servers/{id}/remote-nics: + get: + description: 获取指定信息RemoteNics + operationId: server_GetDetailsRemoteNics + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsRemoteNicsOutput' + summary: 获取指定信息RemoteNics + tags: + - server + /servers/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: server_PerformRemoteUpdate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - server + /servers/{id}/renew: + post: + description: 执行操作Renew + operationId: server_PerformRenew + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformRenewOutput' + summary: 续费 + tags: + - server + /servers/{id}/reset: + post: + description: 执行操作Reset + operationId: server_PerformReset + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformResetOutput' + summary: 重置虚拟机状态 + tags: + - server + /servers/{id}/reset-nic-traffic-limit: + post: + description: 执行操作ResetNicTrafficLimit + operationId: server_PerformResetNicTrafficLimit + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerNicTrafficLimit' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformResetNicTrafficLimitOutput' + summary: 重置网卡限速 + tags: + - server + /servers/{id}/resize-disk: + post: + description: 执行操作ResizeDisk + operationId: server_PerformResizeDisk + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerResizeDiskInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformResizeDiskOutput' + summary: 磁盘扩容 + tags: + - server + /servers/{id}/restart: + post: + description: 执行操作Restart + operationId: server_PerformRestart + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformRestartOutput' + summary: 重启 + tags: + - server + /servers/{id}/resume: + post: + description: 执行操作Resume + operationId: server_PerformResume + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerResumeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformResumeOutput' + summary: 恢复虚拟机挂起状态 + tags: + - server + /servers/{id}/revoke-admin-secgroup: + post: + description: 执行操作RevokeAdminSecgroup + operationId: server_PerformRevokeAdminSecgroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestRevokeSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformRevokeAdminSecgroupOutput' + summary: 解绑管理员安全组 + tags: + - server + /servers/{id}/revoke-secgroup: + post: + description: 执行操作RevokeSecgroup + operationId: server_PerformRevokeSecgroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestRevokeSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformRevokeSecgroupOutput' + summary: 解绑安全组 + tags: + - server + /servers/{id}/save-guest-image: + post: + description: 执行操作SaveGuestImage + operationId: server_PerformSaveGuestImage + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSaveGuestImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSaveGuestImageOutput' + summary: 保存主机模板 + tags: + - server + /servers/{id}/save-image: + post: + description: 执行操作SaveImage + operationId: server_PerformSaveImage + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSaveImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSaveImageOutput' + summary: 保存镜像 + tags: + - server + /servers/{id}/save-template: + post: + description: 执行操作SaveTemplate + operationId: server_PerformSaveTemplate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestSaveToTemplateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSaveTemplateOutput' + summary: 执行操作SaveTemplate + tags: + - server + /servers/{id}/sendkeys: + post: + description: 执行操作Sendkeys + operationId: server_PerformSendkeys + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSendkeysOutput' + summary: 发送远程命令 + tags: + - server + /servers/{id}/set-auto-renew: + post: + description: |- + 要求虚拟机状态为running 或 ready + 要求虚拟机计费类型为包年包月(预付费) + operationId: server_PerformSetAutoRenew + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestAutoRenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetAutoRenewOutput' + summary: 设置自动续费 + tags: + - server + /servers/{id}/set-boot-index: + post: + description: 执行操作SetBootIndex + operationId: server_PerformSetBootIndex + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSetBootIndexInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetBootIndexOutput' + summary: 设置启动顺序 + tags: + - server + /servers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: server_PerformSetClassMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - server + /servers/{id}/set-extra-option: + post: + description: 执行操作SetExtraOption + operationId: server_PerformSetExtraOption + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSetExtraOptionInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetExtraOptionOutput' + summary: 执行操作SetExtraOption + tags: + - server + /servers/{id}/set-isolated-device: + post: + description: 执行操作SetIsolatedDevice + operationId: server_PerformSetIsolatedDevice + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSetIsolatedDeviceOutput' + summary: 设置透传设备 + tags: + - server + /servers/{id}/set-nic-traffic-limit: + post: + description: 执行操作SetNicTrafficLimit + operationId: server_PerformSetNicTrafficLimit + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerNicTrafficLimit' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetNicTrafficLimitOutput' + summary: 网卡限速 + tags: + - server + /servers/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: server_PerformSetOrgMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - server + /servers/{id}/set-os-info: + post: + description: 执行操作SetOsInfo + operationId: server_PerformSetOsInfo + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSetOSInfoInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetOsInfoOutput' + summary: 设置操作系统信息 + tags: + - server + /servers/{id}/set-password: + post: + description: 执行操作SetPassword + operationId: server_PerformSetPassword + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSetPasswordInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetPasswordOutput' + summary: 重置密码 + tags: + - server + /servers/{id}/set-qemu-params: + post: + description: 执行操作SetQemuParams + operationId: server_PerformSetQemuParams + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSetQemuParamsOutput' + summary: 设置Qemu参数 + tags: + - server + /servers/{id}/set-secgroup: + post: + description: 执行操作SetSecgroup + operationId: server_PerformSetSecgroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestSetSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetSecgroupOutput' + summary: 全量覆盖安全组 + tags: + - server + /servers/{id}/set-sshport: + post: + description: 执行操作SetSshport + operationId: server_PerformSetSshport + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestSetSshportInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetSshportOutput' + summary: 执行操作SetSshport + tags: + - server + /servers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: server_PerformSetUserMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - server + /servers/{id}/slave-block-stream-ready: + post: + description: 执行操作SlaveBlockStreamReady + operationId: server_PerformSlaveBlockStreamReady + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSlaveBlockStreamReadyOutput' + summary: 执行操作SlaveBlockStreamReady + tags: + - server + /servers/{id}/snapshot-and-clone: + post: + description: 执行操作SnapshotAndClone + operationId: server_PerformSnapshotAndClone + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSnapshotAndCloneInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSnapshotAndCloneOutput' + summary: 执行操作SnapshotAndClone + tags: + - server + /servers/{id}/sshable: + get: + description: 获取指定信息Sshable + operationId: server_GetDetailsSshable + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsSshableOutput' + summary: 获取指定信息Sshable + tags: + - server + /servers/{id}/sshport: + get: + description: 获取指定信息Sshport + operationId: server_GetDetailsSshport + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsSshportOutput' + summary: 获取指定信息Sshport + tags: + - server + /servers/{id}/start: + post: + description: 执行操作Start + operationId: server_PerformStart + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestPerformStartInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformStartOutput' + summary: 开机 + tags: + - server + /servers/{id}/start-backup: + post: + description: 执行操作StartBackup + operationId: server_PerformStartBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformStartBackupOutput' + summary: 备机开机 + tags: + - server + /servers/{id}/start-rescue: + post: + description: 执行操作StartRescue + operationId: server_PerformStartRescue + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformStartRescueOutput' + summary: 执行操作StartRescue + tags: + - server + /servers/{id}/status: + get: + description: 获取指定信息Status + operationId: server_GetDetailsStatus + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - server + post: + description: 执行操作Status + operationId: server_PerformStatus + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformStatusOutput' + summary: 同步状态 + tags: + - server + /servers/{id}/stop: + post: + description: 执行操作Stop + operationId: server_PerformStop + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerStopInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformStopOutput' + summary: 关机 + tags: + - server + /servers/{id}/stop-rescue: + post: + description: 执行操作StopRescue + operationId: server_PerformStopRescue + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformStopRescueOutput' + summary: 执行操作StopRescue + tags: + - server + /servers/{id}/stream-disks-complete: + post: + description: 执行操作StreamDisksComplete + operationId: server_PerformStreamDisksComplete + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformStreamDisksCompleteOutput' + summary: 执行操作StreamDisksComplete + tags: + - server + /servers/{id}/suspend: + post: + description: 执行操作Suspend + operationId: server_PerformSuspend + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSuspendOutput' + summary: 挂起虚拟机 + tags: + - server + /servers/{id}/switch-to-backup: + post: + description: 执行操作SwitchToBackup + operationId: server_PerformSwitchToBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSwitchToBackupOutput' + summary: 主备机切换 + tags: + - server + /servers/{id}/sync: + post: + description: 执行操作Sync + operationId: server_PerformSync + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSyncOutput' + summary: 同步配置 + tags: + - server + /servers/{id}/sync-fix-nics: + post: + description: 执行操作SyncFixNics + operationId: server_PerformSyncFixNics + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestSyncFixNicsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSyncFixNicsOutput' + summary: 执行操作SyncFixNics + tags: + - server + /servers/{id}/sync-os-info: + post: + description: 执行操作SyncOsInfo + operationId: server_PerformSyncOsInfo + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSyncOsInfoOutput' + summary: 同步操作系统信息 + tags: + - server + /servers/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: server_PerformSyncstatus + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSyncstatusOutput' + summary: 同步虚拟机状态 + tags: + - server + /servers/{id}/tasks: + get: + description: 获取指定信息Tasks + operationId: server_GetDetailsTasks + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsTasksOutput' + summary: 获取指定信息Tasks + tags: + - server + /servers/{id}/unbind-groups: + post: + description: 执行操作UnbindGroups + operationId: server_PerformUnbindGroups + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformUnbindGroupsOutput' + summary: 执行操作UnbindGroups + tags: + - server + /servers/{id}/undo-prepaid-recycle: + post: + description: 执行操作UndoPrepaidRecycle + operationId: server_PerformUndoPrepaidRecycle + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformUndoPrepaidRecycleOutput' + summary: 执行操作UndoPrepaidRecycle + tags: + - server + /servers/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: server_PerformUnfreeze + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - server + /servers/{id}/user-data: + post: + description: 执行操作UserData + operationId: server_PerformUserData + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerUserDataInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformUserDataOutput' + summary: 更新自定义脚本数据 + tags: + - server + /servers/{id}/virt-install: + get: + description: 获取指定信息VirtInstall + operationId: server_GetDetailsVirtInstall + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsVirtInstallOutput' + summary: 获取指定信息VirtInstall + tags: + - server + /servers/{id}/vnc: + get: + description: 获取指定信息Vnc + operationId: server_GetDetailsVnc + parameters: + - default: false + description: 是否使用原生vnc控制台，此选项仅对openstack有效 + in: query + name: origin + type: boolean + x-go-name: Origin + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsVncOutput' + summary: 获取VNC信息 + tags: + - server + /servers/batch-migrate: + post: + description: 执行操作BatchMigrate + operationId: server_PerformBatchMigrate + responses: + "200": + $ref: '#/responses/server_PerformBatchMigrateOutput' + summary: 批量迁移 + tags: + - server + /servers/batch-set-user-metadata: + post: + description: 执行操作BatchSetUserMetadata + operationId: server_PerformBatchSetUserMetadata + responses: + "200": + $ref: '#/responses/server_PerformBatchSetUserMetadataOutput' + summary: 执行操作BatchSetUserMetadata + tags: + - server + /servers/batch-user-metadata: + post: + description: 执行操作BatchUserMetadata + operationId: server_PerformBatchUserMetadata + responses: + "200": + $ref: '#/responses/server_PerformBatchUserMetadataOutput' + summary: 执行操作BatchUserMetadata + tags: + - server + /servers/dirty-server-start: + post: + description: 执行操作DirtyServerStart + operationId: server_PerformDirtyServerStart + responses: + "200": + $ref: '#/responses/server_PerformDirtyServerStartOutput' + summary: 执行操作DirtyServerStart + tags: + - server + /servers/dirty-server-verify: + post: + description: 执行操作DirtyServerVerify + operationId: server_PerformDirtyServerVerify + responses: + "200": + $ref: '#/responses/server_PerformDirtyServerVerifyOutput' + summary: 执行操作DirtyServerVerify + tags: + - server + /servers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: server_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/server_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - server + /servers/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: server_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/server_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - server + /servers/import: + post: + description: 执行操作Import + operationId: server_PerformImport + responses: + "200": + $ref: '#/responses/server_PerformImportOutput' + summary: 导入虚拟机 + tags: + - server + /servers/import-from-libvirt: + post: + description: 执行操作ImportFromLibvirt + operationId: server_PerformImportFromLibvirt + responses: + "200": + $ref: '#/responses/server_PerformImportFromLibvirtOutput' + summary: 从Libvirt导入虚拟机 + tags: + - server + /servers/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: server_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/server_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - server + /servers/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: server_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/server_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - server + /servers/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: server_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/server_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - server + /servers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: server_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - server + /servers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: server_GetPropertySplitable + responses: + "200": + $ref: '#/responses/server_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - server + /servers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: server_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/server_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - server + /servers/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: server_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/server_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - server + /servers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: server_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/server_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - server + /servers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: server_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/server_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - server + /service_catalogs: + get: + description: 列表 + operationId: service_catalog_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: guest_template_id + type: string + x-go-name: GuestTemplateId + responses: + "200": + $ref: '#/responses/service_catalog_ListItemFilterOutput' + summary: 服务目录列表 + tags: + - service_catalog + post: + description: 新建 + operationId: service_catalog_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + service_catalog: + $ref: '#/definitions/ServiceCatalogCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_ValidateCreateDataOutput' + summary: 新建 + tags: + - service_catalog + /service_catalogs/{id}: + delete: + description: 删除 + operationId: service_catalog_CustomizeDelete + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_CustomizeDeleteOutput' + summary: 删除 + tags: + - service_catalog + get: + description: 获取详情 + operationId: service_catalog_FetchCustomizeColumns + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - service_catalog + put: + description: 更新 + operationId: service_catalog_ValidateUpdateData + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_ValidateUpdateDataOutput' + summary: 更新 + tags: + - service_catalog + /service_catalogs/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: service_catalog_PerformCancelDelete + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - service_catalog + /service_catalogs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: service_catalog_PerformChangeOwner + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - service_catalog + /service_catalogs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: service_catalog_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - service_catalog + /service_catalogs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: service_catalog_GetDetailsClassMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - service_catalog + post: + description: 执行操作ClassMetadata + operationId: service_catalog_PerformClassMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - service_catalog + /service_catalogs/{id}/deploy: + post: + description: 执行操作Deploy + operationId: service_catalog_PerformDeploy + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDeploy' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformDeployOutput' + summary: 执行操作Deploy + tags: + - service_catalog + /service_catalogs/{id}/freeze: + post: + description: 执行操作Freeze + operationId: service_catalog_PerformFreeze + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - service_catalog + /service_catalogs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: service_catalog_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_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - service_catalog + /service_catalogs/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: service_catalog_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - service_catalog + /service_catalogs/{id}/private: + post: + description: 执行操作Private + operationId: service_catalog_PerformPrivate + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformPrivateOutput' + summary: 执行操作Private + tags: + - service_catalog + /service_catalogs/{id}/public: + post: + description: 执行操作Public + operationId: service_catalog_PerformPublic + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformPublicOutput' + summary: 执行操作Public + tags: + - service_catalog + /service_catalogs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: service_catalog_PerformSetClassMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - service_catalog + /service_catalogs/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: service_catalog_PerformSetOrgMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - service_catalog + /service_catalogs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: service_catalog_PerformSetUserMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - service_catalog + /service_catalogs/{id}/status: + get: + description: 获取指定信息Status + operationId: service_catalog_GetDetailsStatus + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - service_catalog + post: + description: 执行操作Status + operationId: service_catalog_PerformStatus + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformStatusOutput' + summary: 更新资源状态 + tags: + - service_catalog + /service_catalogs/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: service_catalog_PerformUnfreeze + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - service_catalog + /service_catalogs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: service_catalog_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - service_catalog + /service_catalogs/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: service_catalog_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - service_catalog + /service_catalogs/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: service_catalog_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - service_catalog + /service_catalogs/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: service_catalog_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - service_catalog + /service_catalogs/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: service_catalog_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - service_catalog + /service_catalogs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: service_catalog_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - service_catalog + /service_catalogs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: service_catalog_GetPropertySplitable + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - service_catalog + /service_catalogs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: service_catalog_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_catalog_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - service_catalog + /service_catalogs/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: service_catalog_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - service_catalog + /service_catalogs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: service_catalog_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - service_catalog + /service_catalogs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: service_catalog_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - service_catalog + /snapshot_policies: + get: + description: 列表 + operationId: snapshot_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: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 按绑定的磁盘数量排序 + in: query + name: order_by_bind_disk_count + pattern: asc|desc + type: string + x-go-name: OrderByBindDiskCount + responses: + "200": + $ref: '#/responses/snapshot_policy_ListItemFilterOutput' + summary: 快照策略列表 + tags: + - snapshot_policy + post: + description: 新建 + operationId: snapshot_policy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + snapshot_policy: + $ref: '#/definitions/SSnapshotPolicyCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_ValidateCreateDataOutput' + summary: 新建 + tags: + - snapshot_policy + /snapshot_policies/{id}: + delete: + description: 删除 + operationId: snapshot_policy_CustomizeDelete + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_CustomizeDeleteOutput' + summary: 删除 + tags: + - snapshot_policy + get: + description: 获取详情 + operationId: snapshot_policy_FetchCustomizeColumns + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - snapshot_policy + put: + description: 更新 + operationId: snapshot_policy_ValidateUpdateData + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SSnapshotPolicyUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - snapshot_policy + /snapshot_policies/{id}/bind-disks: + post: + description: 执行操作BindDisks + operationId: snapshot_policy_PerformBindDisks + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDisksInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformBindDisksOutput' + summary: 执行操作BindDisks + tags: + - snapshot_policy + /snapshot_policies/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: snapshot_policy_PerformCancelDelete + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - snapshot_policy + /snapshot_policies/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: snapshot_policy_PerformChangeOwner + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - snapshot_policy + /snapshot_policies/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: snapshot_policy_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - snapshot_policy + /snapshot_policies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: snapshot_policy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - snapshot_policy + post: + description: 执行操作ClassMetadata + operationId: snapshot_policy_PerformClassMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - snapshot_policy + /snapshot_policies/{id}/freeze: + post: + description: 执行操作Freeze + operationId: snapshot_policy_PerformFreeze + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - snapshot_policy + /snapshot_policies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: snapshot_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 snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - snapshot_policy + /snapshot_policies/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: snapshot_policy_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - snapshot_policy + /snapshot_policies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: snapshot_policy_PerformSetClassMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - snapshot_policy + /snapshot_policies/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: snapshot_policy_PerformSetOrgMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - snapshot_policy + /snapshot_policies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: snapshot_policy_PerformSetUserMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - snapshot_policy + /snapshot_policies/{id}/status: + get: + description: 获取指定信息Status + operationId: snapshot_policy_GetDetailsStatus + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - snapshot_policy + post: + description: 执行操作Status + operationId: snapshot_policy_PerformStatus + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformStatusOutput' + summary: 更新资源状态 + tags: + - snapshot_policy + /snapshot_policies/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: snapshot_policy_PerformSyncstatus + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - snapshot_policy + /snapshot_policies/{id}/unbind-disks: + post: + description: 执行操作UnbindDisks + operationId: snapshot_policy_PerformUnbindDisks + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDisksInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformUnbindDisksOutput' + summary: 执行操作UnbindDisks + tags: + - snapshot_policy + /snapshot_policies/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: snapshot_policy_PerformUnfreeze + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - snapshot_policy + /snapshot_policies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: snapshot_policy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - snapshot_policy + /snapshot_policies/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: snapshot_policy_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - snapshot_policy + /snapshot_policies/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: snapshot_policy_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - snapshot_policy + /snapshot_policies/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: snapshot_policy_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - snapshot_policy + /snapshot_policies/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: snapshot_policy_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - snapshot_policy + /snapshot_policies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: snapshot_policy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - snapshot_policy + /snapshot_policies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: snapshot_policy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - snapshot_policy + /snapshot_policies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: snapshot_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/snapshot_policy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - snapshot_policy + /snapshot_policies/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: snapshot_policy_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - snapshot_policy + /snapshot_policies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: snapshot_policy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - snapshot_policy + /snapshot_policies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: snapshot_policy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - snapshot_policy + /snapshot_policy_disks: + get: + description: 列表 + operationId: snapshot_policy_disk_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/snapshot_policy_disk_ListItemFilterOutput' + summary: 列表 + tags: + - snapshot_policy_disk + post: + description: 新建 + operationId: snapshot_policy_disk_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + snapshot_policy_disk: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_ValidateCreateDataOutput' + summary: 新建 + tags: + - snapshot_policy_disk + /snapshot_policy_disks/{id}: + delete: + description: 删除 + operationId: snapshot_policy_disk_CustomizeDelete + parameters: + - description: The Id or Name of snapshot_policy_disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_CustomizeDeleteOutput' + summary: 删除 + tags: + - snapshot_policy_disk + get: + description: 获取详情 + operationId: snapshot_policy_disk_FetchCustomizeColumns + parameters: + - description: The Id or Name of snapshot_policy_disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - snapshot_policy_disk + put: + description: 更新 + operationId: snapshot_policy_disk_ValidateUpdateData + parameters: + - description: The Id or Name of snapshot_policy_disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_ValidateUpdateDataOutput' + summary: 更新 + tags: + - snapshot_policy_disk + /snapshot_policy_disks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: snapshot_policy_disk_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - snapshot_policy_disk + /snapshot_policy_disks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: snapshot_policy_disk_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - snapshot_policy_disk + /snapshot_policy_disks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: snapshot_policy_disk_GetPropertySplitable + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - snapshot_policy_disk + /snapshot_policy_disks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: snapshot_policy_disk_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/snapshot_policy_disk_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - snapshot_policy_disk + /snapshots: + get: + description: 列表 + operationId: snapshot_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 虚拟磁盘（ID或Name） + in: query + name: disk_id + type: string + x-go-name: DiskId + - description: 以磁盘名称排序 + in: query + name: order_by_disk + pattern: asc|desc + type: string + x-go-name: OrderByDisk + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: 以存储名称排序 + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: filter snapshot that is fake deleted + in: query + name: fake_deleted + type: boolean + x-go-name: FakeDeleted + - description: filter by disk type + in: query + name: disk_type + type: string + x-go-name: DiskType + - description: filter instance snapshot + in: query + name: is_instance_snapshot + type: boolean + x-go-name: IsInstanceSnapshot + - in: query + name: out_of_chain + type: boolean + x-go-name: OutOfChain + - in: query + items: + type: string + name: os_type + type: array + x-go-name: OsType + - description: list server snapshots + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 按虚拟机名称排序 + in: query + name: order_by_guest + pattern: asc|desc + type: string + x-go-name: OrderByGuest + - description: 按磁盘名称排序 + in: query + name: order_by_disk_name + pattern: asc|desc + type: string + x-go-name: OrderByDiskName + responses: + "200": + $ref: '#/responses/snapshot_ListItemFilterOutput' + summary: 快照列表 + tags: + - snapshot + post: + description: 新建 + operationId: snapshot_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + snapshot: + $ref: '#/definitions/SnapshotCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_ValidateCreateDataOutput' + summary: 新建 + tags: + - snapshot + /snapshots/{id}: + delete: + description: 删除 + operationId: snapshot_CustomizeDelete + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_CustomizeDeleteOutput' + summary: 删除 + tags: + - snapshot + get: + description: 获取详情 + operationId: snapshot_FetchCustomizeColumns + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - snapshot + put: + description: 更新 + operationId: snapshot_ValidateUpdateData + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_ValidateUpdateDataOutput' + summary: 更新 + tags: + - snapshot + /snapshots/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: snapshot_PerformCancelDelete + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - snapshot + /snapshots/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: snapshot_PerformChangeOwner + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - snapshot + /snapshots/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: snapshot_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - snapshot + /snapshots/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: snapshot_GetDetailsClassMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - snapshot + post: + description: 执行操作ClassMetadata + operationId: snapshot_PerformClassMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - snapshot + /snapshots/{id}/deleted: + post: + description: 执行操作Deleted + operationId: snapshot_PerformDeleted + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_PerformDeletedOutput' + summary: 执行操作Deleted + tags: + - snapshot + /snapshots/{id}/freeze: + post: + description: 执行操作Freeze + operationId: snapshot_PerformFreeze + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - snapshot + /snapshots/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: snapshot_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 snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - snapshot + /snapshots/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: snapshot_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - snapshot + /snapshots/{id}/purge: + post: + description: 执行操作Purge + operationId: snapshot_PerformPurge + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - snapshot + /snapshots/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: snapshot_PerformSetClassMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - snapshot + /snapshots/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: snapshot_PerformSetOrgMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - snapshot + /snapshots/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: snapshot_PerformSetUserMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - snapshot + /snapshots/{id}/status: + get: + description: 获取指定信息Status + operationId: snapshot_GetDetailsStatus + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - snapshot + post: + description: 执行操作Status + operationId: snapshot_PerformStatus + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformStatusOutput' + summary: 更新资源状态 + tags: + - snapshot + /snapshots/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: snapshot_PerformSyncstatus + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformSyncstatusOutput' + summary: 同步快照状态 + tags: + - snapshot + /snapshots/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: snapshot_PerformUnfreeze + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - snapshot + /snapshots/delete-disk-snapshots: + post: + description: 执行操作DeleteDiskSnapshots + operationId: snapshot_PerformDeleteDiskSnapshots + responses: + "200": + $ref: '#/responses/snapshot_PerformDeleteDiskSnapshotsOutput' + summary: 执行操作DeleteDiskSnapshots + tags: + - snapshot + /snapshots/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: snapshot_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - snapshot + /snapshots/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: snapshot_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - snapshot + /snapshots/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: snapshot_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - snapshot + /snapshots/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: snapshot_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - snapshot + /snapshots/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: snapshot_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - snapshot + /snapshots/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: snapshot_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - snapshot + /snapshots/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: snapshot_GetPropertySplitable + responses: + "200": + $ref: '#/responses/snapshot_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - snapshot + /snapshots/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: snapshot_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/snapshot_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - snapshot + /snapshots/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: snapshot_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - snapshot + /snapshots/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: snapshot_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - snapshot + /snapshots/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: snapshot_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - snapshot + /ssl_certificates: + get: + description: 列表 + operationId: ssl_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 + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/ssl_certificate_ListItemFilterOutput' + summary: SSLCertificate实例列表 + tags: + - ssl_certificate + post: + description: 新建 + operationId: ssl_certificate_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + ssl_certificate: + $ref: '#/definitions/SSLCertificateCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_ValidateCreateDataOutput' + summary: 新建 + tags: + - ssl_certificate + /ssl_certificates/{id}: + delete: + description: 删除 + operationId: ssl_certificate_CustomizeDelete + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ssl_certificate_CustomizeDeleteOutput' + summary: 删除 + tags: + - ssl_certificate + get: + description: 获取详情 + operationId: ssl_certificate_FetchCustomizeColumns + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ssl_certificate_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - ssl_certificate + put: + description: 更新 + operationId: ssl_certificate_ValidateUpdateData + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ssl_certificate: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_ValidateUpdateDataOutput' + summary: 更新 + tags: + - ssl_certificate + /ssl_certificates/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: ssl_certificate_PerformCancelDelete + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - ssl_certificate + /ssl_certificates/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: ssl_certificate_PerformChangeOwner + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ssl_certificate: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - ssl_certificate + /ssl_certificates/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: ssl_certificate_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ssl_certificate_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - ssl_certificate + /ssl_certificates/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: ssl_certificate_GetDetailsClassMetadata + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ssl_certificate_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - ssl_certificate + post: + description: 执行操作ClassMetadata + operationId: ssl_certificate_PerformClassMetadata + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ssl_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - ssl_certificate + /ssl_certificates/{id}/freeze: + post: + description: 执行操作Freeze + operationId: ssl_certificate_PerformFreeze + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ssl_certificate: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - ssl_certificate + /ssl_certificates/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: ssl_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 ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ssl_certificate_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - ssl_certificate + /ssl_certificates/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: ssl_certificate_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ssl_certificate_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - ssl_certificate + /ssl_certificates/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: ssl_certificate_PerformSetClassMetadata + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ssl_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - ssl_certificate + /ssl_certificates/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: ssl_certificate_PerformSetOrgMetadata + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ssl_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - ssl_certificate + /ssl_certificates/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: ssl_certificate_PerformSetUserMetadata + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ssl_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - ssl_certificate + /ssl_certificates/{id}/status: + get: + description: 获取指定信息Status + operationId: ssl_certificate_GetDetailsStatus + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ssl_certificate_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - ssl_certificate + post: + description: 执行操作Status + operationId: ssl_certificate_PerformStatus + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ssl_certificate: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformStatusOutput' + summary: 更新资源状态 + tags: + - ssl_certificate + /ssl_certificates/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: ssl_certificate_PerformUnfreeze + parameters: + - description: The Id or Name of ssl_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ssl_certificate: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - ssl_certificate + /ssl_certificates/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: ssl_certificate_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/ssl_certificate_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - ssl_certificate + /ssl_certificates/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: ssl_certificate_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/ssl_certificate_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - ssl_certificate + /ssl_certificates/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: ssl_certificate_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/ssl_certificate_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - ssl_certificate + /ssl_certificates/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: ssl_certificate_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/ssl_certificate_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - ssl_certificate + /ssl_certificates/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: ssl_certificate_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/ssl_certificate_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - ssl_certificate + /ssl_certificates/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: ssl_certificate_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + ssl_certificate: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ssl_certificate_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - ssl_certificate + /ssl_certificates/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: ssl_certificate_GetPropertySplitable + responses: + "200": + $ref: '#/responses/ssl_certificate_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - ssl_certificate + /ssl_certificates/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: ssl_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/ssl_certificate_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - ssl_certificate + /ssl_certificates/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: ssl_certificate_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/ssl_certificate_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - ssl_certificate + /ssl_certificates/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: ssl_certificate_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/ssl_certificate_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - ssl_certificate + /ssl_certificates/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: ssl_certificate_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/ssl_certificate_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - ssl_certificate + /storagecachedimages: + get: + description: 列表 + operationId: storagecachedimage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 存储缓存（ID或Name） + in: query + name: storagecache_id + type: string + x-go-name: StoragecacheId + - description: 以存储缓存名称排序 + in: query + name: order_by_storagecache + pattern: asc|desc + type: string + x-go-name: OrderByStoragecache + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以镜像缓存过滤 + in: query + name: cachedimage_id + type: string + x-go-name: CachedimageId + - description: 镜像状态 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/storagecachedimage_ListItemFilterOutput' + summary: 列表 + tags: + - storagecachedimage + post: + description: 新建 + operationId: storagecachedimage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + storagecachedimage: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecachedimage_ValidateCreateDataOutput' + summary: 新建 + tags: + - storagecachedimage + /storagecachedimages/{id}: + delete: + description: 删除 + operationId: storagecachedimage_CustomizeDelete + parameters: + - description: The Id or Name of storagecachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecachedimage_CustomizeDeleteOutput' + summary: 删除 + tags: + - storagecachedimage + get: + description: 获取详情 + operationId: storagecachedimage_FetchCustomizeColumns + parameters: + - description: The Id or Name of storagecachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecachedimage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - storagecachedimage + put: + description: 更新 + operationId: storagecachedimage_ValidateUpdateData + parameters: + - description: The Id or Name of storagecachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecachedimage: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecachedimage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - storagecachedimage + /storagecachedimages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: storagecachedimage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/storagecachedimage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - storagecachedimage + /storagecachedimages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: storagecachedimage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + storagecachedimage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecachedimage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - storagecachedimage + /storagecachedimages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: storagecachedimage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/storagecachedimage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - storagecachedimage + /storagecachedimages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: storagecachedimage_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/storagecachedimage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - storagecachedimage + /storagecaches: + get: + description: 列表 + operationId: storagecache_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 路径过滤 + in: query + items: + type: string + name: path + type: array + x-go-name: Path + responses: + "200": + $ref: '#/responses/storagecache_ListItemFilterOutput' + summary: 镜像缓存存储列表 + tags: + - storagecache + post: + description: 新建 + operationId: storagecache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + storagecache: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_ValidateCreateDataOutput' + summary: 新建 + tags: + - storagecache + /storagecaches/{id}: + delete: + description: 删除 + operationId: storagecache_CustomizeDelete + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_CustomizeDeleteOutput' + summary: 删除 + tags: + - storagecache + get: + description: 获取详情 + operationId: storagecache_FetchCustomizeColumns + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - storagecache + put: + description: 更新 + operationId: storagecache_ValidateUpdateData + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - storagecache + /storagecaches/{id}/cache-image: + post: + description: 执行操作CacheImage + operationId: storagecache_PerformCacheImage + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + $ref: '#/definitions/CacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformCacheImageOutput' + summary: 执行操作CacheImage + tags: + - storagecache + /storagecaches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: storagecache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - storagecache + post: + description: 执行操作ClassMetadata + operationId: storagecache_PerformClassMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - storagecache + /storagecaches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: storagecache_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 storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - storagecache + /storagecaches/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: storagecache_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - storagecache + /storagecaches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: storagecache_PerformSetClassMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - storagecache + /storagecaches/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: storagecache_PerformSetOrgMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - storagecache + /storagecaches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: storagecache_PerformSetUserMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - storagecache + /storagecaches/{id}/uncache-image: + post: + description: 执行操作UncacheImage + operationId: storagecache_PerformUncacheImage + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_PerformUncacheImageOutput' + summary: 执行操作UncacheImage + tags: + - storagecache + /storagecaches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: storagecache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/storagecache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - storagecache + /storagecaches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: storagecache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + storagecache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - storagecache + /storagecaches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: storagecache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/storagecache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - storagecache + /storagecaches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: storagecache_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/storagecache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - storagecache + /storagecaches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: storagecache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/storagecache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - storagecache + /storagecaches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: storagecache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/storagecache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - storagecache + /storages: + get: + description: 列表 + operationId: storage_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: filter by host schedtag + in: query + name: host_schedtag_id + type: string + x-go-name: HostSchedtagId + - description: filter by cachedimage + in: query + name: image_id + type: string + x-go-name: ImageId + - description: filter storages which attached the specified host + in: query + name: host_id + type: string + x-go-name: HostId + - description: filter storages which server can change disks to + in: query + name: server_id + type: string + x-go-name: ServerId + - description: filter storages of baremetal host + in: query + name: is_baremetal + type: boolean + x-go-name: IsBaremetal + responses: + "200": + $ref: '#/responses/storage_ListItemFilterOutput' + summary: 块存储列表 + tags: + - storage + post: + description: 新建 + operationId: storage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + storage: + $ref: '#/definitions/StorageCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_ValidateCreateDataOutput' + summary: 新建 + tags: + - storage + /storages/{id}: + delete: + description: 删除 + operationId: storage_CustomizeDelete + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_CustomizeDeleteOutput' + summary: 删除 + tags: + - storage + get: + description: 获取详情 + operationId: storage_FetchCustomizeColumns + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - storage + put: + description: 更新 + operationId: storage_ValidateUpdateData + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/StorageUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - storage + /storages/{id}/cache-image: + post: + description: 执行操作CacheImage + operationId: storage_PerformCacheImage + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/CacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformCacheImageOutput' + summary: 执行操作CacheImage + tags: + - storage + /storages/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: storage_PerformChangeOwner + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - storage + /storages/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: storage_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - storage + /storages/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: storage_GetDetailsClassMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - storage + post: + description: 执行操作ClassMetadata + operationId: storage_PerformClassMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - storage + /storages/{id}/disable: + post: + description: 执行操作Disable + operationId: storage_PerformDisable + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformDisableOutput' + summary: 执行操作Disable + tags: + - storage + /storages/{id}/enable: + post: + description: 执行操作Enable + operationId: storage_PerformEnable + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformEnableOutput' + summary: 执行操作Enable + tags: + - storage + /storages/{id}/force-detach-host: + post: + description: 执行操作ForceDetachHost + operationId: storage_PerformForceDetachHost + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/StorageForceDetachHostInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformForceDetachHostOutput' + summary: 执行操作ForceDetachHost + tags: + - storage + /storages/{id}/hardware-info: + get: + description: 获取指定信息HardwareInfo + operationId: storage_GetDetailsHardwareInfo + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsHardwareInfoOutput' + summary: 获取指定信息HardwareInfo + tags: + - storage + /storages/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: storage_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 storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - storage + /storages/{id}/offline: + post: + description: 执行操作Offline + operationId: storage_PerformOffline + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformOfflineOutput' + summary: 执行操作Offline + tags: + - storage + /storages/{id}/online: + post: + description: 执行操作Online + operationId: storage_PerformOnline + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformOnlineOutput' + summary: 执行操作Online + tags: + - storage + /storages/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: storage_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - storage + /storages/{id}/private: + post: + description: 执行操作Private + operationId: storage_PerformPrivate + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformPrivateOutput' + summary: 执行操作Private + tags: + - storage + /storages/{id}/public: + post: + description: 执行操作Public + operationId: storage_PerformPublic + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformPublicOutput' + summary: 执行操作Public + tags: + - storage + /storages/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: storage_PerformSetClassMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - storage + /storages/{id}/set-hardware-info: + post: + description: 执行操作SetHardwareInfo + operationId: storage_PerformSetHardwareInfo + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/StorageHardwareInfo' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformSetHardwareInfoOutput' + summary: 执行操作SetHardwareInfo + tags: + - storage + /storages/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: storage_PerformSetOrgMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - storage + /storages/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: storage_PerformSetSchedtag + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - storage + /storages/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: storage_PerformSetUserMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - storage + /storages/{id}/status: + get: + description: 获取指定信息Status + operationId: storage_GetDetailsStatus + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - storage + post: + description: 执行操作Status + operationId: storage_PerformStatus + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformStatusOutput' + summary: 更新资源状态 + tags: + - storage + /storages/{id}/uncache-image: + post: + description: 执行操作UncacheImage + operationId: storage_PerformUncacheImage + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformUncacheImageOutput' + summary: 执行操作UncacheImage + tags: + - storage + /storages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: storage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/storage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - storage + /storages/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: storage_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/storage_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - storage + /storages/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: storage_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/storage_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - storage + /storages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: storage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - storage + /storages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: storage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/storage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - storage + /storages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: storage_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/storage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - storage + /storages/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: storage_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/storage_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - storage + /storages/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: storage_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/storage_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - storage + /storages/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: storage_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/storage_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - storage + /tablestores: + get: + description: 列表 + operationId: tablestore_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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/tablestore_ListItemFilterOutput' + summary: Tablestore列表 + tags: + - tablestore + post: + description: 新建 + operationId: tablestore_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + tablestore: + $ref: '#/definitions/TablestoreCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_ValidateCreateDataOutput' + summary: 新建 + tags: + - tablestore + /tablestores/{id}: + delete: + description: 删除 + operationId: tablestore_CustomizeDelete + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_CustomizeDeleteOutput' + summary: 删除 + tags: + - tablestore + get: + description: 获取详情 + operationId: tablestore_FetchCustomizeColumns + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - tablestore + put: + description: 更新 + operationId: tablestore_ValidateUpdateData + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_ValidateUpdateDataOutput' + summary: 更新 + tags: + - tablestore + /tablestores/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: tablestore_PerformCancelDelete + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - tablestore + /tablestores/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: tablestore_PerformChangeOwner + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - tablestore + /tablestores/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: tablestore_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - tablestore + /tablestores/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: tablestore_GetDetailsClassMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - tablestore + post: + description: 执行操作ClassMetadata + operationId: tablestore_PerformClassMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - tablestore + /tablestores/{id}/freeze: + post: + description: 执行操作Freeze + operationId: tablestore_PerformFreeze + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - tablestore + /tablestores/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: tablestore_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 tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - tablestore + /tablestores/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: tablestore_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - tablestore + /tablestores/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: tablestore_PerformSetClassMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - tablestore + /tablestores/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: tablestore_PerformSetOrgMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - tablestore + /tablestores/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: tablestore_PerformSetUserMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - tablestore + /tablestores/{id}/status: + get: + description: 获取指定信息Status + operationId: tablestore_GetDetailsStatus + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - tablestore + post: + description: 执行操作Status + operationId: tablestore_PerformStatus + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformStatusOutput' + summary: 更新资源状态 + tags: + - tablestore + /tablestores/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: tablestore_PerformUnfreeze + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - tablestore + /tablestores/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: tablestore_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - tablestore + /tablestores/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: tablestore_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - tablestore + /tablestores/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: tablestore_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - tablestore + /tablestores/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: tablestore_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - tablestore + /tablestores/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: tablestore_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - tablestore + /tablestores/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: tablestore_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - tablestore + /tablestores/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: tablestore_GetPropertySplitable + responses: + "200": + $ref: '#/responses/tablestore_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - tablestore + /tablestores/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: tablestore_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/tablestore_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - tablestore + /tablestores/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: tablestore_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - tablestore + /tablestores/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: tablestore_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - tablestore + /tablestores/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: tablestore_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - tablestore + /vpc_peering_connections: + get: + description: 列表 + operationId: vpc_peering_connection_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: PeerVpcId + type: string + responses: + "200": + $ref: '#/responses/vpc_peering_connection_ListItemFilterOutput' + summary: 列表 + tags: + - vpc_peering_connection + post: + description: 新建 + operationId: vpc_peering_connection_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_ValidateCreateDataOutput' + summary: 创建 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}: + delete: + description: 删除 + operationId: vpc_peering_connection_CustomizeDelete + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_CustomizeDeleteOutput' + summary: 删除 + tags: + - vpc_peering_connection + get: + description: 获取详情 + operationId: vpc_peering_connection_FetchCustomizeColumns + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - vpc_peering_connection + put: + description: 更新 + operationId: vpc_peering_connection_ValidateUpdateData + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_ValidateUpdateDataOutput' + summary: 更新 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: vpc_peering_connection_PerformChangeOwner + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: vpc_peering_connection_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: vpc_peering_connection_GetDetailsClassMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - vpc_peering_connection + post: + description: 执行操作ClassMetadata + operationId: vpc_peering_connection_PerformClassMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/disable: + post: + description: 执行操作Disable + operationId: vpc_peering_connection_PerformDisable + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformDisableOutput' + summary: 禁用资源 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/enable: + post: + description: 执行操作Enable + operationId: vpc_peering_connection_PerformEnable + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformEnableOutput' + summary: 启用资源 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: vpc_peering_connection_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 vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: vpc_peering_connection_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/private: + post: + description: 执行操作Private + operationId: vpc_peering_connection_PerformPrivate + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformPrivateOutput' + summary: 执行操作Private + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/public: + post: + description: 执行操作Public + operationId: vpc_peering_connection_PerformPublic + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformPublicOutput' + summary: 执行操作Public + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: vpc_peering_connection_PerformSetClassMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: vpc_peering_connection_PerformSetOrgMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: vpc_peering_connection_PerformSetUserMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/status: + get: + description: 获取指定信息Status + operationId: vpc_peering_connection_GetDetailsStatus + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - vpc_peering_connection + post: + description: 执行操作Status + operationId: vpc_peering_connection_PerformStatus + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformStatusOutput' + summary: 更新资源状态 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: vpc_peering_connection_PerformSyncstatus + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformSyncstatusOutput' + summary: 同步状态 + tags: + - vpc_peering_connection + /vpc_peering_connections/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: vpc_peering_connection_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - vpc_peering_connection + /vpc_peering_connections/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: vpc_peering_connection_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - vpc_peering_connection + /vpc_peering_connections/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: vpc_peering_connection_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - vpc_peering_connection + /vpc_peering_connections/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: vpc_peering_connection_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - vpc_peering_connection + /vpc_peering_connections/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: vpc_peering_connection_GetPropertySplitable + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - vpc_peering_connection + /vpc_peering_connections/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: vpc_peering_connection_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/vpc_peering_connection_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - vpc_peering_connection + /vpc_peering_connections/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: vpc_peering_connection_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - vpc_peering_connection + /vpc_peering_connections/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: vpc_peering_connection_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - vpc_peering_connection + /vpc_peering_connections/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: vpc_peering_connection_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - vpc_peering_connection + /vpcs: + get: + description: 列表 + operationId: vpc_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: GlobalVpc ID or Name + in: query + name: globalvpc_id + type: string + x-go-name: GlobalvpcId + - description: 以GlobalVpc的名称排序 + in: query + name: order_by_globalvpc + pattern: asc|desc + type: string + x-go-name: OrderByGlobalvpc + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: dns_zone_id + type: string + x-go-name: DnsZoneId + - in: query + name: inter_vpc_network_id + type: string + x-go-name: InterVpcNetworkId + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by Vpc usability of the resource + in: query + name: usable_vpc + type: boolean + x-go-name: UsableVpc + - description: 过滤可以加入指定vpc互联的vpc + in: query + name: usable_for_inter_vpc_network_id + type: string + x-go-name: UsableForInterVpcNetworkId + - description: 过滤vpc底下有指定zone的ip子网 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: filter by globalvpc + in: query + name: globalvpc + type: string + x-go-name: Globalvpc + - description: 是否是默认VPC + example: true + in: query + name: is_default + type: boolean + x-go-name: IsDefault + - description: CIDR地址段 + example: 192.168.222.0/24 + in: query + items: + type: string + name: cidr_block + type: array + x-go-name: CidrBlock + - description: IPv6地址段 + in: query + items: + type: string + name: cidr_block6 + type: array + x-go-name: CidrBlock6 + - description: 'enmu: eip, none' + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按子网数量排序 + in: query + name: order_by_network_count + pattern: asc|desc + type: string + x-go-name: OrderByNetworkCount + - description: 按二层网络数量排序 + in: query + name: OrderByWireCount + pattern: asc|desc + type: string + responses: + "200": + $ref: '#/responses/vpc_ListItemFilterOutput' + summary: 列出VPC + tags: + - vpc + post: + description: 新建 + operationId: vpc_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + vpc: + $ref: '#/definitions/VpcCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_ValidateCreateDataOutput' + summary: 新建 + tags: + - vpc + /vpcs/{id}: + delete: + description: 删除 + operationId: vpc_CustomizeDelete + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_CustomizeDeleteOutput' + summary: 删除 + tags: + - vpc + get: + description: 获取详情 + operationId: vpc_FetchCustomizeColumns + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - vpc + put: + description: 更新 + operationId: vpc_ValidateUpdateData + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/VpcUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_ValidateUpdateDataOutput' + summary: 更新 + tags: + - vpc + /vpcs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: vpc_PerformChangeOwner + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - vpc + /vpcs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: vpc_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - vpc + /vpcs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: vpc_GetDetailsClassMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - vpc + post: + description: 执行操作ClassMetadata + operationId: vpc_PerformClassMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - vpc + /vpcs/{id}/disable: + post: + description: 执行操作Disable + operationId: vpc_PerformDisable + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformDisableOutput' + summary: 禁用资源 + tags: + - vpc + /vpcs/{id}/enable: + post: + description: 执行操作Enable + operationId: vpc_PerformEnable + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformEnableOutput' + summary: 启用资源 + tags: + - vpc + /vpcs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: vpc_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 vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - vpc + /vpcs/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: vpc_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - vpc + /vpcs/{id}/private: + post: + description: 执行操作Private + operationId: vpc_PerformPrivate + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformPrivateOutput' + summary: 执行操作Private + tags: + - vpc + /vpcs/{id}/public: + post: + description: 执行操作Public + operationId: vpc_PerformPublic + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformPublicOutput' + summary: 执行操作Public + tags: + - vpc + /vpcs/{id}/purge: + post: + description: 执行操作Purge + operationId: vpc_PerformPurge + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - vpc + /vpcs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: vpc_PerformSetClassMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - vpc + /vpcs/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: vpc_PerformSetOrgMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - vpc + /vpcs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: vpc_PerformSetUserMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - vpc + /vpcs/{id}/status: + get: + description: 获取指定信息Status + operationId: vpc_GetDetailsStatus + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - vpc + post: + description: 执行操作Status + operationId: vpc_PerformStatus + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformStatusOutput' + summary: 更新资源状态 + tags: + - vpc + /vpcs/{id}/sync: + post: + description: 执行操作Sync + operationId: vpc_PerformSync + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/VpcSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformSyncOutput' + summary: 执行操作Sync + tags: + - vpc + /vpcs/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: vpc_PerformSyncstatus + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/VpcSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformSyncstatusOutput' + summary: 同步VPC状态 + tags: + - vpc + /vpcs/{id}/topology: + get: + description: 获取指定信息Topology + operationId: vpc_GetDetailsTopology + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsTopologyOutput' + summary: 获取指定信息Topology + tags: + - vpc + /vpcs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: vpc_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/vpc_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - vpc + /vpcs/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: vpc_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/vpc_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - vpc + /vpcs/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: vpc_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/vpc_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - vpc + /vpcs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: vpc_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - vpc + /vpcs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: vpc_GetPropertySplitable + responses: + "200": + $ref: '#/responses/vpc_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - vpc + /vpcs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: vpc_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/vpc_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - vpc + /vpcs/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: vpc_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/vpc_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - vpc + /vpcs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: vpc_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/vpc_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - vpc + /vpcs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: vpc_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/vpc_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - vpc + /waf_instances: + get: + description: 列表 + operationId: waf_instance_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/waf_instance_ListItemFilterOutput' + summary: 列出WAF实例 + tags: + - waf_instance + post: + description: 新建 + operationId: waf_instance_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_instance: + $ref: '#/definitions/WafInstanceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_instance + /waf_instances/{id}: + delete: + description: 删除 + operationId: waf_instance_CustomizeDelete + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_instance + get: + description: 获取详情 + operationId: waf_instance_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_instance + put: + description: 更新 + operationId: waf_instance_ValidateUpdateData + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_instance + /waf_instances/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: waf_instance_PerformChangeOwner + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - waf_instance + /waf_instances/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: waf_instance_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - waf_instance + /waf_instances/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_instance_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_instance + post: + description: 执行操作ClassMetadata + operationId: waf_instance_PerformClassMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_instance + /waf_instances/{id}/cloud-resources: + get: + description: 获取指定信息CloudResources + operationId: waf_instance_GetDetailsCloudResources + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsCloudResourcesOutput' + summary: 获取WAF绑定的资源列表 + tags: + - waf_instance + /waf_instances/{id}/disable: + post: + description: 执行操作Disable + operationId: waf_instance_PerformDisable + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformDisableOutput' + summary: 禁用资源 + tags: + - waf_instance + /waf_instances/{id}/enable: + post: + description: 执行操作Enable + operationId: waf_instance_PerformEnable + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformEnableOutput' + summary: 启用资源 + tags: + - waf_instance + /waf_instances/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_instance_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 waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_instance + /waf_instances/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: waf_instance_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - waf_instance + /waf_instances/{id}/private: + post: + description: 执行操作Private + operationId: waf_instance_PerformPrivate + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformPrivateOutput' + summary: 执行操作Private + tags: + - waf_instance + /waf_instances/{id}/public: + post: + description: 执行操作Public + operationId: waf_instance_PerformPublic + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformPublicOutput' + summary: 执行操作Public + tags: + - waf_instance + /waf_instances/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: waf_instance_PerformRemoteUpdate + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - waf_instance + /waf_instances/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_instance_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_instance + /waf_instances/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: waf_instance_PerformSetOrgMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_instance + /waf_instances/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_instance_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_instance + /waf_instances/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_instance_GetDetailsStatus + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_instance + post: + description: 执行操作Status + operationId: waf_instance_PerformStatus + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_instance + /waf_instances/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: waf_instance_PerformSyncstatus + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/WafSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformSyncstatusOutput' + summary: 同步WAF状态 + tags: + - waf_instance + /waf_instances/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_instance_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_instance + /waf_instances/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: waf_instance_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - waf_instance + /waf_instances/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: waf_instance_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - waf_instance + /waf_instances/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_instance_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_instance + /waf_instances/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_instance_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_instance + /waf_instances/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_instance_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/waf_instance_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_instance + /waf_instances/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_instance_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_instance + /waf_instances/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_instance_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_instance + /waf_instances/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_instance_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_instance + /waf_ip_set_caches: + get: + description: 列表 + operationId: waf_ip_set_cache_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_ListItemFilterOutput' + summary: 列出WAF IPSet缓存 + tags: + - waf_ip_set_cache + post: + description: 新建 + operationId: waf_ip_set_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_ip_set_cache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}: + delete: + description: 删除 + operationId: waf_ip_set_cache_CustomizeDelete + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_ip_set_cache + get: + description: 获取详情 + operationId: waf_ip_set_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_ip_set_cache + put: + description: 更新 + operationId: waf_ip_set_cache_ValidateUpdateData + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_ip_set_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_ip_set_cache + post: + description: 执行操作ClassMetadata + operationId: waf_ip_set_cache_PerformClassMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_ip_set_cache_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 waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: waf_ip_set_cache_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_ip_set_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: waf_ip_set_cache_PerformSetOrgMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_ip_set_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_ip_set_cache_GetDetailsStatus + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_ip_set_cache + post: + description: 执行操作Status + operationId: waf_ip_set_cache_PerformStatus + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_ip_set_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_ip_set_cache + /waf_ip_set_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_ip_set_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_ip_set_cache + /waf_ip_set_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_ip_set_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_ip_set_cache + /waf_ip_set_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_ip_set_cache_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/waf_ip_set_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_ip_set_cache + /waf_ip_set_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_ip_set_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_ip_set_cache + /waf_ip_set_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_ip_set_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_ip_set_cache + /waf_ip_set_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_ip_set_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_ip_set_cache + /waf_ip_sets: + get: + description: 列表 + operationId: waf_ip_set_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/waf_ip_set_ListItemFilterOutput' + summary: 列出WAF IPSets + tags: + - waf_ip_set + post: + description: 新建 + operationId: waf_ip_set_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_ip_set: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_ip_set + /waf_ip_sets/{id}: + delete: + description: 删除 + operationId: waf_ip_set_CustomizeDelete + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_ip_set + get: + description: 获取详情 + operationId: waf_ip_set_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_ip_set + put: + description: 更新 + operationId: waf_ip_set_ValidateUpdateData + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_ip_set + /waf_ip_sets/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: waf_ip_set_PerformChangeOwner + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - waf_ip_set + /waf_ip_sets/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: waf_ip_set_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - waf_ip_set + /waf_ip_sets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_ip_set_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_ip_set + post: + description: 执行操作ClassMetadata + operationId: waf_ip_set_PerformClassMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_ip_set + /waf_ip_sets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_ip_set_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 waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_ip_set + /waf_ip_sets/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: waf_ip_set_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - waf_ip_set + /waf_ip_sets/{id}/private: + post: + description: 执行操作Private + operationId: waf_ip_set_PerformPrivate + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformPrivateOutput' + summary: 执行操作Private + tags: + - waf_ip_set + /waf_ip_sets/{id}/public: + post: + description: 执行操作Public + operationId: waf_ip_set_PerformPublic + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformPublicOutput' + summary: 执行操作Public + tags: + - waf_ip_set + /waf_ip_sets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_ip_set_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_ip_set + /waf_ip_sets/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: waf_ip_set_PerformSetOrgMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_ip_set + /waf_ip_sets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_ip_set_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_ip_set + /waf_ip_sets/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_ip_set_GetDetailsStatus + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_ip_set + post: + description: 执行操作Status + operationId: waf_ip_set_PerformStatus + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_ip_set + /waf_ip_sets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_ip_set_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_ip_set + /waf_ip_sets/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: waf_ip_set_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - waf_ip_set + /waf_ip_sets/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: waf_ip_set_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - waf_ip_set + /waf_ip_sets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_ip_set_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_ip_set + /waf_ip_sets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_ip_set_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_ip_set + /waf_ip_sets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_ip_set_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/waf_ip_set_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_ip_set + /waf_ip_sets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_ip_set_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_ip_set + /waf_ip_sets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_ip_set_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_ip_set + /waf_ip_sets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_ip_set_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_ip_set + /waf_regex_set_caches: + get: + description: 列表 + operationId: waf_regex_set_cache_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_ListItemFilterOutput' + summary: 列出WAF RegexSet缓存 + tags: + - waf_regex_set_cache + post: + description: 新建 + operationId: waf_regex_set_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_regex_set_cache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}: + delete: + description: 删除 + operationId: waf_regex_set_cache_CustomizeDelete + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_regex_set_cache + get: + description: 获取详情 + operationId: waf_regex_set_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_regex_set_cache + put: + description: 更新 + operationId: waf_regex_set_cache_ValidateUpdateData + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_regex_set_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_regex_set_cache + post: + description: 执行操作ClassMetadata + operationId: waf_regex_set_cache_PerformClassMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_regex_set_cache_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 waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: waf_regex_set_cache_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_regex_set_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: waf_regex_set_cache_PerformSetOrgMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_regex_set_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_regex_set_cache_GetDetailsStatus + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_regex_set_cache + post: + description: 执行操作Status + operationId: waf_regex_set_cache_PerformStatus + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_regex_set_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_regex_set_cache + /waf_regex_set_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_regex_set_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_regex_set_cache + /waf_regex_set_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_regex_set_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_regex_set_cache + /waf_regex_set_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_regex_set_cache_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/waf_regex_set_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_regex_set_cache + /waf_regex_set_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_regex_set_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_regex_set_cache + /waf_regex_set_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_regex_set_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_regex_set_cache + /waf_regex_set_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_regex_set_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_regex_set_cache + /waf_regex_sets: + get: + description: 列表 + operationId: waf_regex_set_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/waf_regex_set_ListItemFilterOutput' + summary: 列出WAF RegexSets + tags: + - waf_regex_set + post: + description: 新建 + operationId: waf_regex_set_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_regex_set: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_regex_set + /waf_regex_sets/{id}: + delete: + description: 删除 + operationId: waf_regex_set_CustomizeDelete + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_regex_set + get: + description: 获取详情 + operationId: waf_regex_set_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_regex_set + put: + description: 更新 + operationId: waf_regex_set_ValidateUpdateData + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_regex_set + /waf_regex_sets/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: waf_regex_set_PerformChangeOwner + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - waf_regex_set + /waf_regex_sets/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: waf_regex_set_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - waf_regex_set + /waf_regex_sets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_regex_set_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_regex_set + post: + description: 执行操作ClassMetadata + operationId: waf_regex_set_PerformClassMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_regex_set + /waf_regex_sets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_regex_set_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 waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_regex_set + /waf_regex_sets/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: waf_regex_set_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - waf_regex_set + /waf_regex_sets/{id}/private: + post: + description: 执行操作Private + operationId: waf_regex_set_PerformPrivate + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformPrivateOutput' + summary: 执行操作Private + tags: + - waf_regex_set + /waf_regex_sets/{id}/public: + post: + description: 执行操作Public + operationId: waf_regex_set_PerformPublic + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformPublicOutput' + summary: 执行操作Public + tags: + - waf_regex_set + /waf_regex_sets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_regex_set_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_regex_set + /waf_regex_sets/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: waf_regex_set_PerformSetOrgMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_regex_set + /waf_regex_sets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_regex_set_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_regex_set + /waf_regex_sets/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_regex_set_GetDetailsStatus + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_regex_set + post: + description: 执行操作Status + operationId: waf_regex_set_PerformStatus + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_regex_set + /waf_regex_sets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_regex_set_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_regex_set + /waf_regex_sets/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: waf_regex_set_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - waf_regex_set + /waf_regex_sets/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: waf_regex_set_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - waf_regex_set + /waf_regex_sets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_regex_set_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_regex_set + /waf_regex_sets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_regex_set_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_regex_set + /waf_regex_sets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_regex_set_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/waf_regex_set_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_regex_set + /waf_regex_sets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_regex_set_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_regex_set + /waf_regex_sets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_regex_set_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_regex_set + /waf_regex_sets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_regex_set_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_regex_set + /waf_rule_group_caches: + get: + description: 列表 + operationId: waf_rule_group_cache_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_ListItemFilterOutput' + summary: 列出WAF RuleGroup缓存 + tags: + - waf_rule_group_cache + post: + description: 新建 + operationId: waf_rule_group_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_rule_group_cache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}: + delete: + description: 删除 + operationId: waf_rule_group_cache_CustomizeDelete + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_rule_group_cache + get: + description: 获取详情 + operationId: waf_rule_group_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_rule_group_cache + put: + description: 更新 + operationId: waf_rule_group_cache_ValidateUpdateData + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_rule_group_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_rule_group_cache + post: + description: 执行操作ClassMetadata + operationId: waf_rule_group_cache_PerformClassMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_rule_group_cache_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 waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: waf_rule_group_cache_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_rule_group_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: waf_rule_group_cache_PerformSetOrgMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_rule_group_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_rule_group_cache_GetDetailsStatus + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_rule_group_cache + post: + description: 执行操作Status + operationId: waf_rule_group_cache_PerformStatus + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_rule_group_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_rule_group_cache + /waf_rule_group_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_rule_group_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_rule_group_cache + /waf_rule_group_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_rule_group_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_rule_group_cache + /waf_rule_group_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_rule_group_cache_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/waf_rule_group_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_rule_group_cache + /waf_rule_group_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_rule_group_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_rule_group_cache + /waf_rule_group_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_rule_group_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_rule_group_cache + /waf_rule_group_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_rule_group_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_rule_group_cache + /waf_rule_groups: + get: + description: 列表 + operationId: waf_rule_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 + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 是否是系统RuleGroup + in: query + name: is_system + type: boolean + x-go-name: IsSystem + - description: 云平台 + in: query + name: provider + type: string + x-go-name: Provider + - description: 云环境 + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + responses: + "200": + $ref: '#/responses/waf_rule_group_ListItemFilterOutput' + summary: 列出WAF RuleGroups + tags: + - waf_rule_group + post: + description: 新建 + operationId: waf_rule_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_rule_group: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_rule_group + /waf_rule_groups/{id}: + delete: + description: 删除 + operationId: waf_rule_group_CustomizeDelete + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_rule_group + get: + description: 获取详情 + operationId: waf_rule_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_rule_group + put: + description: 更新 + operationId: waf_rule_group_ValidateUpdateData + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_rule_group + /waf_rule_groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: waf_rule_group_PerformChangeOwner + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - waf_rule_group + /waf_rule_groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: waf_rule_group_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - waf_rule_group + /waf_rule_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_rule_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_rule_group + post: + description: 执行操作ClassMetadata + operationId: waf_rule_group_PerformClassMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_rule_group + /waf_rule_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_rule_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 waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_rule_group + /waf_rule_groups/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: waf_rule_group_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - waf_rule_group + /waf_rule_groups/{id}/private: + post: + description: 执行操作Private + operationId: waf_rule_group_PerformPrivate + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformPrivateOutput' + summary: 执行操作Private + tags: + - waf_rule_group + /waf_rule_groups/{id}/public: + post: + description: 执行操作Public + operationId: waf_rule_group_PerformPublic + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformPublicOutput' + summary: 执行操作Public + tags: + - waf_rule_group + /waf_rule_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_rule_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_rule_group + /waf_rule_groups/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: waf_rule_group_PerformSetOrgMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_rule_group + /waf_rule_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_rule_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_rule_group + /waf_rule_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_rule_group_GetDetailsStatus + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_rule_group + post: + description: 执行操作Status + operationId: waf_rule_group_PerformStatus + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_rule_group + /waf_rule_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_rule_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_rule_group + /waf_rule_groups/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: waf_rule_group_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - waf_rule_group + /waf_rule_groups/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: waf_rule_group_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - waf_rule_group + /waf_rule_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_rule_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_rule_group + /waf_rule_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_rule_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_rule_group + /waf_rule_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_rule_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/waf_rule_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_rule_group + /waf_rule_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_rule_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_rule_group + /waf_rule_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_rule_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_rule_group + /waf_rule_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_rule_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_rule_group + /waf_rule_statements: + get: + description: 列表 + operationId: waf_rule_statement_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/waf_rule_statement_ListItemFilterOutput' + summary: 列表 + tags: + - waf_rule_statement + post: + description: 新建 + operationId: waf_rule_statement_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_rule_statement: + $ref: '#/definitions/ResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_statement_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_rule_statement + /waf_rule_statements/{id}: + delete: + description: 删除 + operationId: waf_rule_statement_CustomizeDelete + parameters: + - description: The Id or Name of waf_rule_statement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_statement_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_rule_statement + get: + description: 获取详情 + operationId: waf_rule_statement_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_rule_statement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_statement_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_rule_statement + put: + description: 更新 + operationId: waf_rule_statement_ValidateUpdateData + parameters: + - description: The Id or Name of waf_rule_statement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_statement_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_rule_statement + /waf_rule_statements/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_rule_statement_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_rule_statement_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_rule_statement + /waf_rule_statements/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_rule_statement_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_statement_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_rule_statement + /waf_rule_statements/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_rule_statement_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_rule_statement_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_rule_statement + /waf_rule_statements/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_rule_statement_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/waf_rule_statement_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_rule_statement + /waf_rules: + get: + description: 列表 + operationId: waf_rule_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: WAF实例Id + in: query + name: waf_instance_id + type: string + x-go-name: WafInstanceId + - description: WAF规则组Id + in: query + name: waf_rule_group_id + type: string + x-go-name: WafRuleGroupId + responses: + "200": + $ref: '#/responses/waf_rule_ListItemFilterOutput' + summary: 列出WAF规则 + tags: + - waf_rule + post: + description: 新建 + operationId: waf_rule_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_rule: + $ref: '#/definitions/WafRuleCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_rule + /waf_rules/{id}: + delete: + description: 删除 + operationId: waf_rule_CustomizeDelete + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_rule + get: + description: 获取详情 + operationId: waf_rule_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_rule + put: + description: 更新 + operationId: waf_rule_ValidateUpdateData + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_rule + /waf_rules/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_rule_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_rule + post: + description: 执行操作ClassMetadata + operationId: waf_rule_PerformClassMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_rule + /waf_rules/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_rule_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 waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_rule + /waf_rules/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: waf_rule_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - waf_rule + /waf_rules/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_rule_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_rule + /waf_rules/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: waf_rule_PerformSetOrgMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_rule + /waf_rules/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_rule_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_rule + /waf_rules/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_rule_GetDetailsStatus + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_rule + post: + description: 执行操作Status + operationId: waf_rule_PerformStatus + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_rule + /waf_rules/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: waf_rule_PerformSyncstatus + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + $ref: '#/definitions/WafSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformSyncstatusOutput' + summary: 同步WAF规则状态 + tags: + - waf_rule + /waf_rules/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_rule_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_rule + /waf_rules/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_rule_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_rule: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_rule + /waf_rules/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_rule_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_rule + /waf_rules/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_rule_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/waf_rule_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_rule + /waf_rules/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_rule_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_rule + /waf_rules/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_rule_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_rule + /waf_rules/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_rule_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_rule + /wires: + get: + description: 列表 + operationId: wire_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: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + items: + type: string + name: vpc_id + type: array + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - format: int64 + in: query + name: bandwidth + type: integer + x-go-name: Bandwidth + - in: query + name: host_type + type: string + x-go-name: HostType + - description: 按子网数量排序 + in: query + name: order_by_network_count + pattern: asc|desc + type: string + x-go-name: OrderByNetworkCount + responses: + "200": + $ref: '#/responses/wire_ListItemFilterOutput' + summary: 二层网络列表 + tags: + - wire + post: + description: 新建 + operationId: wire_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + wire: + $ref: '#/definitions/WireCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_ValidateCreateDataOutput' + summary: 新建 + tags: + - wire + /wires/{id}: + delete: + description: 删除 + operationId: wire_CustomizeDelete + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_CustomizeDeleteOutput' + summary: 删除 + tags: + - wire + get: + description: 获取详情 + operationId: wire_FetchCustomizeColumns + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - wire + put: + description: 更新 + operationId: wire_ValidateUpdateData + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/WireUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_ValidateUpdateDataOutput' + summary: 更新 + tags: + - wire + /wires/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: wire_PerformChangeOwner + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - wire + /wires/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: wire_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - wire + /wires/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: wire_GetDetailsClassMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - wire + post: + description: 执行操作ClassMetadata + operationId: wire_PerformClassMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - wire + /wires/{id}/merge-from: + post: + description: 执行操作MergeFrom + operationId: wire_PerformMergeFrom + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/WireMergeFromInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformMergeFromOutput' + summary: 执行操作MergeFrom + tags: + - wire + /wires/{id}/merge-network: + post: + description: 执行操作MergeNetwork + operationId: wire_PerformMergeNetwork + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/WireMergeNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformMergeNetworkOutput' + summary: 执行操作MergeNetwork + tags: + - wire + /wires/{id}/merge-to: + post: + description: 执行操作MergeTo + operationId: wire_PerformMergeTo + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/WireMergeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformMergeToOutput' + summary: 执行操作MergeTo + tags: + - wire + /wires/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: wire_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 wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - wire + /wires/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: wire_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - wire + /wires/{id}/private: + post: + description: 执行操作Private + operationId: wire_PerformPrivate + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformPrivateOutput' + summary: 执行操作Private + tags: + - wire + /wires/{id}/public: + post: + description: 执行操作Public + operationId: wire_PerformPublic + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformPublicOutput' + summary: 执行操作Public + tags: + - wire + /wires/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: wire_PerformSetClassMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformSetClassMetadataOutput' + summary: 执行操作SetClassMetadata + tags: + - wire + /wires/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: wire_PerformSetOrgMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - wire + /wires/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: wire_PerformSetUserMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - wire + /wires/{id}/status: + get: + description: 获取指定信息Status + operationId: wire_GetDetailsStatus + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - wire + post: + description: 执行操作Status + operationId: wire_PerformStatus + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformStatusOutput' + summary: 更新资源状态 + tags: + - wire + /wires/{id}/topology: + get: + description: 获取指定信息Topology + operationId: wire_GetDetailsTopology + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsTopologyOutput' + summary: 获取指定信息Topology + tags: + - wire + /wires/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: wire_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/wire_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - wire + /wires/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: wire_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/wire_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - wire + /wires/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: wire_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/wire_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - wire + /wires/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: wire_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - wire + /wires/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: wire_GetPropertySplitable + responses: + "200": + $ref: '#/responses/wire_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - wire + /wires/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: wire_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/wire_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - wire + /wires/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: wire_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/wire_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - wire + /wires/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: wire_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/wire_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - wire + /wires/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: wire_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/wire_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - wire + /zone_quotas/{scope}: + get: + description: 获取所有项目或者域的可用区配额 + operationId: models_ListZoneQuotas + 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListZoneQuotasOutput' + summary: 获取所有项目或者域的可用区配额 + tags: + - zone_quota + /zone_quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的可用区配额 + operationId: models_GetZoneQuota + 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: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + responses: + "200": + $ref: '#/responses/models_GetZoneQuotaOutput' + summary: 获取指定项目或者域的可用区配额 + tags: + - zone_quota + post: + description: 设置指定项目或者域的可用区配额 + operationId: models_SetZoneQuotas + parameters: + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - in: body + name: body + schema: + properties: + zone_quotas: + $ref: '#/definitions/SetZoneQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetZoneQuotasOutput' + summary: 设置指定项目或者域的可用区配额 + tags: + - zone_quota + /zones: + get: + description: 列表 + operationId: zone_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: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - 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: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + items: + type: string + name: cloudregion_id + type: array + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by Vpc usability of the resource + in: query + name: usable_vpc + type: boolean + x-go-name: UsableVpc + - description: 过滤提供特定服务的可用区 + in: query + name: service + type: string + x-go-name: Service + - in: query + items: + type: string + name: location + type: array + x-go-name: Location + - in: query + items: + type: string + name: contacts + type: array + x-go-name: Contacts + - in: query + name: OrderByWires + type: string + - in: query + name: OrderByHosts + type: string + - in: query + name: OrderByHostsEnabled + type: string + - in: query + name: OrderByBaremetals + type: string + - in: query + name: OrderByBaremetalsEnabled + type: string + responses: + "200": + $ref: '#/responses/zone_ListItemFilterOutput' + summary: 可用区列表 + tags: + - zone + post: + description: 新建 + operationId: zone_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + zone: + $ref: '#/definitions/ZoneCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_ValidateCreateDataOutput' + summary: 新建 + tags: + - zone + /zones/{id}: + delete: + description: 删除 + operationId: zone_CustomizeDelete + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_CustomizeDeleteOutput' + summary: 删除 + tags: + - zone + get: + description: 获取详情 + operationId: zone_FetchCustomizeColumns + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - zone + put: + description: 更新 + operationId: zone_ValidateUpdateData + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_ValidateUpdateDataOutput' + summary: 更新 + tags: + - zone + /zones/{id}/capability: + get: + description: 获取指定信息Capability + operationId: zone_GetDetailsCapability + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsCapabilityOutput' + summary: 获取指定信息Capability + tags: + - zone + /zones/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: zone_GetDetailsClassMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - zone + post: + description: 执行操作ClassMetadata + operationId: zone_PerformClassMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - zone + /zones/{id}/disk-capability: + get: + description: 获取指定信息DiskCapability + operationId: zone_GetDetailsDiskCapability + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsDiskCapabilityOutput' + summary: 获取指定信息DiskCapability + tags: + - zone + /zones/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: zone_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 zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - zone + /zones/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: zone_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - zone + /zones/{id}/purge: + post: + description: 执行操作Purge + operationId: zone_PerformPurge + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + $ref: '#/definitions/ZonePurgeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - zone + /zones/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: zone_PerformSetClassMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - zone + /zones/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: zone_PerformSetOrgMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - zone + /zones/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: zone_PerformSetSchedtag + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - zone + /zones/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: zone_PerformSetUserMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - zone + /zones/{id}/status: + get: + description: 获取指定信息Status + operationId: zone_GetDetailsStatus + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - zone + post: + description: 执行操作Status + operationId: zone_PerformStatus + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformStatusOutput' + summary: 更新资源状态 + tags: + - zone + /zones/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: zone_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/zone_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - zone + /zones/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: zone_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + zone: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - zone + /zones/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: zone_GetPropertySplitable + responses: + "200": + $ref: '#/responses/zone_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - zone + /zones/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: zone_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/zone_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - zone + /zones/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: zone_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/zone_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - zone + /zones/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: zone_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/zone_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - zone + /zones/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: zone_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/zone_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - zone produces: -- application/json + - application/json responses: - access_group_CustomizeDeleteOutput: - schema: - properties: - access_group: - $ref: '#/definitions/AccessGroupDetails' - type: object - access_group_FetchCustomizeColumnsOutput: - schema: - properties: - access_group: - $ref: '#/definitions/AccessGroupDetails' - type: object - access_group_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - access_group: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - access_group_GetDetailsClassMetadataOutput: - schema: - properties: - access_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - access_group_GetDetailsMetadataOutput: - schema: - properties: - access_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - access_group_GetDetailsStatusOutput: - schema: - properties: - access_group: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - access_group_GetPropertyDistinctFieldOutput: {} - access_group_GetPropertyDomainTagValuePairsOutput: {} - access_group_GetPropertyDomainTagValueTreeOutput: {} - access_group_GetPropertySplitableExportOutput: {} - access_group_GetPropertySplitableOutput: {} - access_group_GetPropertyStatisticsOutput: - schema: - properties: - access_group: - $ref: '#/definitions/StatusStatistic' - type: object - access_group_GetPropertyTagValuePairsOutput: {} - access_group_GetPropertyTagValueTreeOutput: {} - access_group_ListItemFilterOutput: - schema: - properties: - access_groups: - items: - $ref: '#/definitions/AccessGroupDetails' - 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 - access_group_PerformChangeOwnerOutput: {} - access_group_PerformClassMetadataOutput: {} - access_group_PerformPrivateOutput: {} - access_group_PerformPublicOutput: {} - access_group_PerformPurgeSplitableOutput: {} - access_group_PerformSetClassMetadataOutput: {} - access_group_PerformSetUserMetadataOutput: {} - access_group_PerformStatusOutput: {} - access_group_PerformSyncstatusOutput: {} - access_group_ValidateCreateDataOutput: - schema: - properties: - access_group: - $ref: '#/definitions/AccessGroupDetails' - type: object - access_group_ValidateUpdateDataOutput: - schema: - properties: - access_group: - $ref: '#/definitions/AccessGroupDetails' - type: object - access_group_cache_CustomizeDeleteOutput: - schema: - properties: - access_group_cache: - $ref: '#/definitions/AccessGroupCacheDetails' - type: object - access_group_cache_FetchCustomizeColumnsOutput: - schema: - properties: - access_group_cache: - $ref: '#/definitions/AccessGroupCacheDetails' - type: object - access_group_cache_GetDetailsClassMetadataOutput: - schema: - properties: - access_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - access_group_cache_GetDetailsMetadataOutput: - schema: - properties: - access_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - access_group_cache_GetDetailsStatusOutput: - schema: - properties: - access_group_cache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - access_group_cache_GetPropertyDistinctFieldOutput: {} - access_group_cache_GetPropertySplitableExportOutput: {} - access_group_cache_GetPropertySplitableOutput: {} - access_group_cache_GetPropertyStatisticsOutput: - schema: - properties: - access_group_cache: - $ref: '#/definitions/StatusStatistic' - type: object - access_group_cache_GetPropertyTagValuePairsOutput: {} - access_group_cache_GetPropertyTagValueTreeOutput: {} - access_group_cache_ListItemFilterOutput: - schema: - properties: - access_group_caches: - items: - $ref: '#/definitions/AccessGroupCacheDetails' - 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 - access_group_cache_PerformClassMetadataOutput: {} - access_group_cache_PerformPurgeSplitableOutput: {} - access_group_cache_PerformSetClassMetadataOutput: {} - access_group_cache_PerformSetUserMetadataOutput: {} - access_group_cache_PerformStatusOutput: {} - access_group_cache_PerformSyncstatusOutput: {} - access_group_cache_ValidateCreateDataOutput: - schema: - properties: - access_group_cache: - $ref: '#/definitions/AccessGroupCacheDetails' - type: object - access_group_cache_ValidateUpdateDataOutput: - schema: - properties: - access_group_cache: - $ref: '#/definitions/AccessGroupCacheDetails' - type: object - access_group_rule_CustomizeDeleteOutput: - schema: - properties: - access_group_rule: - $ref: '#/definitions/AccessGroupRuleDetails' - type: object - access_group_rule_FetchCustomizeColumnsOutput: - schema: - properties: - access_group_rule: - $ref: '#/definitions/AccessGroupRuleDetails' - type: object - access_group_rule_GetPropertyDistinctFieldOutput: {} - access_group_rule_GetPropertySplitableExportOutput: {} - access_group_rule_GetPropertySplitableOutput: {} - access_group_rule_ListItemFilterOutput: - schema: - properties: - access_group_rules: - items: - $ref: '#/definitions/AccessGroupRuleDetails' - 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 - access_group_rule_PerformPurgeSplitableOutput: {} - access_group_rule_ValidateCreateDataOutput: - schema: - properties: - access_group_rule: - $ref: '#/definitions/AccessGroupRuleDetails' - type: object - access_group_rule_ValidateUpdateDataOutput: - schema: - properties: - access_group_rule: - $ref: '#/definitions/AccessGroupRuleDetails' - type: object - app_CustomizeDeleteOutput: - schema: - properties: - app: - $ref: '#/definitions/AppDetails' - type: object - app_FetchCustomizeColumnsOutput: - schema: - properties: - app: - $ref: '#/definitions/AppDetails' - type: object - app_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - app: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - app_GetDetailsClassMetadataOutput: - schema: - properties: - app: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - app_GetDetailsMetadataOutput: - schema: - properties: - app: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - app_GetDetailsStatusOutput: - schema: - properties: - app: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - app_GetPropertyDistinctFieldOutput: {} - app_GetPropertyDomainStatisticsOutput: - schema: - properties: - app: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - app_GetPropertyProjectStatisticsOutput: - schema: - properties: - app: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - app_GetPropertyProjectTagValuePairsOutput: {} - app_GetPropertyProjectTagValueTreeOutput: {} - app_GetPropertySplitableExportOutput: {} - app_GetPropertySplitableOutput: {} - app_GetPropertyStatisticsOutput: - schema: - properties: - app: - $ref: '#/definitions/StatusStatistic' - type: object - app_GetPropertyTagValuePairsOutput: {} - app_GetPropertyTagValueTreeOutput: {} - app_ListItemFilterOutput: - schema: - properties: - apps: - items: - $ref: '#/definitions/AppDetails' - 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 - app_PerformCancelDeleteOutput: {} - app_PerformChangeOwnerOutput: {} - app_PerformClassMetadataOutput: {} - app_PerformFreezeOutput: {} - app_PerformPurgeSplitableOutput: {} - app_PerformRemoteUpdateOutput: {} - app_PerformSetClassMetadataOutput: {} - app_PerformSetUserMetadataOutput: {} - app_PerformStatusOutput: {} - app_PerformSyncstatusOutput: {} - app_PerformUnfreezeOutput: {} - app_ValidateCreateDataOutput: - schema: - properties: - app: - $ref: '#/definitions/AppDetails' - type: object - app_ValidateUpdateDataOutput: - schema: - properties: - app: - $ref: '#/definitions/AppDetails' - type: object - app_environment_CustomizeDeleteOutput: - schema: - properties: - app_environment: - $ref: '#/definitions/AppEnvironmentDetails' - type: object - app_environment_FetchCustomizeColumnsOutput: - schema: - properties: - app_environment: - $ref: '#/definitions/AppEnvironmentDetails' - type: object - app_environment_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - app_environment: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - app_environment_GetDetailsClassMetadataOutput: - schema: - properties: - app_environment: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - app_environment_GetDetailsMetadataOutput: - schema: - properties: - app_environment: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - app_environment_GetDetailsStatusOutput: - schema: - properties: - app_environment: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - app_environment_GetPropertyDistinctFieldOutput: {} - app_environment_GetPropertyDomainStatisticsOutput: - schema: - properties: - app_environment: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - app_environment_GetPropertyProjectStatisticsOutput: - schema: - properties: - app_environment: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - app_environment_GetPropertyProjectTagValuePairsOutput: {} - app_environment_GetPropertyProjectTagValueTreeOutput: {} - app_environment_GetPropertySplitableExportOutput: {} - app_environment_GetPropertySplitableOutput: {} - app_environment_GetPropertyStatisticsOutput: - schema: - properties: - app_environment: - $ref: '#/definitions/StatusStatistic' - type: object - app_environment_GetPropertyTagValuePairsOutput: {} - app_environment_GetPropertyTagValueTreeOutput: {} - app_environment_ListItemFilterOutput: - schema: - properties: - app_environments: - items: - $ref: '#/definitions/AppEnvironmentDetails' - 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 - app_environment_PerformCancelDeleteOutput: {} - app_environment_PerformChangeOwnerOutput: {} - app_environment_PerformClassMetadataOutput: {} - app_environment_PerformFreezeOutput: {} - app_environment_PerformPurgeSplitableOutput: {} - app_environment_PerformSetClassMetadataOutput: {} - app_environment_PerformSetUserMetadataOutput: {} - app_environment_PerformStatusOutput: {} - app_environment_PerformUnfreezeOutput: {} - app_environment_ValidateCreateDataOutput: - schema: - properties: - app_environment: - $ref: '#/definitions/AppEnvironmentDetails' - type: object - app_environment_ValidateUpdateDataOutput: - schema: - properties: - app_environment: - $ref: '#/definitions/AppEnvironmentDetails' - type: object - backup_storage_CustomizeDeleteOutput: - schema: - properties: - backup_storage: - $ref: '#/definitions/BackupStorageDetails' - type: object - backup_storage_FetchCustomizeColumnsOutput: - schema: - properties: - backup_storage: - $ref: '#/definitions/BackupStorageDetails' - type: object - backup_storage_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - backup_storage: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - backup_storage_GetDetailsClassMetadataOutput: - schema: - properties: - backup_storage: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - backup_storage_GetDetailsMetadataOutput: - schema: - properties: - backup_storage: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - backup_storage_GetDetailsStatusOutput: - schema: - properties: - backup_storage: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - backup_storage_GetPropertyDistinctFieldOutput: {} - backup_storage_GetPropertyDomainTagValuePairsOutput: {} - backup_storage_GetPropertyDomainTagValueTreeOutput: {} - backup_storage_GetPropertySplitableExportOutput: {} - backup_storage_GetPropertySplitableOutput: {} - backup_storage_GetPropertyStatisticsOutput: - schema: - properties: - backup_storage: - $ref: '#/definitions/StatusStatistic' - type: object - backup_storage_GetPropertyTagValuePairsOutput: {} - backup_storage_GetPropertyTagValueTreeOutput: {} - backup_storage_ListItemFilterOutput: - schema: - properties: - backup_storages: - items: - $ref: '#/definitions/BackupStorageDetails' - 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 - backup_storage_PerformChangeOwnerOutput: {} - backup_storage_PerformClassMetadataOutput: {} - backup_storage_PerformDisableOutput: {} - backup_storage_PerformEnableOutput: {} - backup_storage_PerformPrivateOutput: {} - backup_storage_PerformPublicOutput: {} - backup_storage_PerformPurgeSplitableOutput: {} - backup_storage_PerformSetClassMetadataOutput: {} - backup_storage_PerformSetUserMetadataOutput: {} - backup_storage_PerformStatusOutput: {} - backup_storage_PerformSyncstatusOutput: {} - backup_storage_ValidateCreateDataOutput: - schema: - properties: - backup_storage: - $ref: '#/definitions/BackupStorageDetails' - type: object - backup_storage_ValidateUpdateDataOutput: - schema: - properties: - backup_storage: - $ref: '#/definitions/BackupStorageDetails' - type: object - baremetalagent_CustomizeDeleteOutput: - schema: - properties: - baremetalagent: - $ref: '#/definitions/BaremetalagentDetails' - type: object - baremetalagent_FetchCustomizeColumnsOutput: - schema: - properties: - baremetalagent: - $ref: '#/definitions/BaremetalagentDetails' - type: object - baremetalagent_GetDetailsClassMetadataOutput: - schema: - properties: - baremetalagent: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - baremetalagent_GetDetailsMetadataOutput: - schema: - properties: - baremetalagent: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - baremetalagent_GetPropertyDistinctFieldOutput: {} - baremetalagent_GetPropertySplitableExportOutput: {} - baremetalagent_GetPropertySplitableOutput: {} - baremetalagent_GetPropertyTagValuePairsOutput: {} - baremetalagent_GetPropertyTagValueTreeOutput: {} - baremetalagent_ListItemFilterOutput: - schema: - properties: - baremetalagents: - items: - $ref: '#/definitions/BaremetalagentDetails' - 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 - baremetalagent_PerformClassMetadataOutput: {} - baremetalagent_PerformDisableImageCacheOutput: {} - baremetalagent_PerformDisableOutput: {} - baremetalagent_PerformEnableImageCacheOutput: {} - baremetalagent_PerformEnableOutput: {} - baremetalagent_PerformOfflineOutput: {} - baremetalagent_PerformOnlineOutput: {} - baremetalagent_PerformPurgeSplitableOutput: {} - baremetalagent_PerformSetClassMetadataOutput: {} - baremetalagent_PerformSetUserMetadataOutput: {} - baremetalagent_ValidateCreateDataOutput: - schema: - properties: - baremetalagent: - $ref: '#/definitions/BaremetalagentDetails' - type: object - baremetalagent_ValidateUpdateDataOutput: - schema: - properties: - baremetalagent: - $ref: '#/definitions/BaremetalagentDetails' - type: object - billing_resource_check_CustomizeDeleteOutput: - schema: - properties: - billing_resource_check: - $ref: '#/definitions/ResourceBaseDetails' - type: object - billing_resource_check_FetchCustomizeColumnsOutput: - schema: - properties: - billing_resource_check: - $ref: '#/definitions/ResourceBaseDetails' - type: object - billing_resource_check_GetPropertyDistinctFieldOutput: {} - billing_resource_check_GetPropertySplitableExportOutput: {} - billing_resource_check_GetPropertySplitableOutput: {} - billing_resource_check_ListItemFilterOutput: - schema: - properties: - billing_resource_checks: - items: - $ref: '#/definitions/ResourceBaseDetails' - 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 - billing_resource_check_PerformPurgeSplitableOutput: {} - billing_resource_check_ValidateCreateDataOutput: - schema: - properties: - billing_resource_check: - $ref: '#/definitions/ResourceBaseDetails' - type: object - billing_resource_check_ValidateUpdateDataOutput: - schema: - properties: - billing_resource_check: - $ref: '#/definitions/ResourceBaseDetails' - type: object - bucket_CustomizeDeleteOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketDetails' - type: object - bucket_FetchCustomizeColumnsOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketDetails' - type: object - bucket_GetDetailsAccessInfoOutput: {} - bucket_GetDetailsAclOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketGetAclOutput' - type: object - bucket_GetDetailsCdnDomainOutput: - schema: - properties: - bucket: - $ref: '#/definitions/CdnDomains' - type: object - bucket_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - bucket: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - bucket_GetDetailsClassMetadataOutput: - schema: - properties: - bucket: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - bucket_GetDetailsCorsOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketCORSRules' - type: object - bucket_GetDetailsMetadataOutput: - schema: - properties: - bucket: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - bucket_GetDetailsObjectsOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketGetObjectsOutput' - type: object - bucket_GetDetailsPolicyOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketPolicy' - type: object - bucket_GetDetailsRefererOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketRefererConf' - type: object - bucket_GetDetailsStatusOutput: - schema: - properties: - bucket: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - bucket_GetDetailsWebsiteOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketWebsiteConf' - type: object - bucket_GetPropertyDistinctFieldOutput: {} - bucket_GetPropertyDomainStatisticsOutput: - schema: - properties: - bucket: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - bucket_GetPropertyProjectStatisticsOutput: - schema: - properties: - bucket: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - bucket_GetPropertyProjectTagValuePairsOutput: {} - bucket_GetPropertyProjectTagValueTreeOutput: {} - bucket_GetPropertySplitableExportOutput: {} - bucket_GetPropertySplitableOutput: {} - bucket_GetPropertyStatisticsOutput: - schema: - properties: - bucket: - $ref: '#/definitions/StatusStatistic' - type: object - bucket_GetPropertyTagValuePairsOutput: {} - bucket_GetPropertyTagValueTreeOutput: {} - bucket_ListItemFilterOutput: - schema: - properties: - buckets: - items: - $ref: '#/definitions/BucketDetails' - 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 - bucket_PerformAclOutput: {} - bucket_PerformCancelDeleteOutput: {} - bucket_PerformChangeOwnerOutput: {} - bucket_PerformClassMetadataOutput: {} - bucket_PerformDeleteCorsOutput: {} - bucket_PerformDeleteOutput: {} - bucket_PerformDeletePolicyOutput: {} - bucket_PerformDeleteWebsiteOutput: {} - bucket_PerformFreezeOutput: {} - bucket_PerformLimitOutput: {} - bucket_PerformMakedirOutput: {} - bucket_PerformMetadataOutput: {} - bucket_PerformPrivateOutput: {} - bucket_PerformPublicOutput: {} - bucket_PerformPurgeSplitableOutput: {} - bucket_PerformSetClassMetadataOutput: {} - bucket_PerformSetCorsOutput: {} - bucket_PerformSetPolicyOutput: {} - bucket_PerformSetRefererOutput: {} - bucket_PerformSetUserMetadataOutput: {} - bucket_PerformSetWebsiteOutput: {} - bucket_PerformStatusOutput: {} - bucket_PerformSyncOutput: {} - bucket_PerformSyncstatusOutput: {} - bucket_PerformTempUrlOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketPerformTempUrlOutput' - type: object - bucket_PerformUnfreezeOutput: {} - bucket_PerformUploadOutput: {} - bucket_ValidateCreateDataOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketDetails' - type: object - bucket_ValidateUpdateDataOutput: - schema: - properties: - bucket: - $ref: '#/definitions/BucketDetails' - type: object - cachedimage_CustomizeDeleteOutput: - schema: - properties: - cachedimage: - $ref: '#/definitions/CachedimageDetails' - type: object - cachedimage_FetchCustomizeColumnsOutput: - schema: - properties: - cachedimage: - $ref: '#/definitions/CachedimageDetails' - type: object - cachedimage_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - cachedimage: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - cachedimage_GetDetailsClassMetadataOutput: - schema: - properties: - cachedimage: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cachedimage_GetDetailsMetadataOutput: - schema: - properties: - cachedimage: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cachedimage_GetDetailsStatusOutput: - schema: - properties: - cachedimage: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cachedimage_GetPropertyDistinctFieldOutput: {} - cachedimage_GetPropertyDomainStatisticsOutput: - schema: - properties: - cachedimage: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - cachedimage_GetPropertyProjectStatisticsOutput: - schema: - properties: - cachedimage: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - cachedimage_GetPropertyProjectTagValuePairsOutput: {} - cachedimage_GetPropertyProjectTagValueTreeOutput: {} - cachedimage_GetPropertySplitableExportOutput: {} - cachedimage_GetPropertySplitableOutput: {} - cachedimage_GetPropertyStatisticsOutput: - schema: - properties: - cachedimage: - $ref: '#/definitions/StatusStatistic' - type: object - cachedimage_GetPropertyTagValuePairsOutput: {} - cachedimage_GetPropertyTagValueTreeOutput: {} - cachedimage_ListItemFilterOutput: - schema: - properties: - cachedimages: - items: - $ref: '#/definitions/CachedimageDetails' - 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 - cachedimage_PerformCacheImageOutput: {} - cachedimage_PerformCancelDeleteOutput: {} - cachedimage_PerformChangeOwnerOutput: {} - cachedimage_PerformClassMetadataOutput: {} - cachedimage_PerformFreezeOutput: {} - cachedimage_PerformPrivateOutput: {} - cachedimage_PerformPublicOutput: {} - cachedimage_PerformPurgeSplitableOutput: {} - cachedimage_PerformRefreshOutput: {} - cachedimage_PerformSetClassMetadataOutput: {} - cachedimage_PerformSetUserMetadataOutput: {} - cachedimage_PerformStatusOutput: {} - cachedimage_PerformUncacheImageOutput: {} - cachedimage_PerformUnfreezeOutput: {} - cachedimage_ValidateCreateDataOutput: - schema: - properties: - cachedimage: - $ref: '#/definitions/CachedimageDetails' - type: object - cachedimage_ValidateUpdateDataOutput: - schema: - properties: - cachedimage: - $ref: '#/definitions/CachedimageDetails' - type: object - cdn_domain_CustomizeDeleteOutput: - schema: - properties: - cdn_domain: - $ref: '#/definitions/CDNDomainDetails' - type: object - cdn_domain_FetchCustomizeColumnsOutput: - schema: - properties: - cdn_domain: - $ref: '#/definitions/CDNDomainDetails' - type: object - cdn_domain_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - cdn_domain: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - cdn_domain_GetDetailsClassMetadataOutput: - schema: - properties: - cdn_domain: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cdn_domain_GetDetailsMetadataOutput: - schema: - properties: - cdn_domain: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cdn_domain_GetDetailsStatusOutput: - schema: - properties: - cdn_domain: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cdn_domain_GetPropertyDistinctFieldOutput: {} - cdn_domain_GetPropertyDomainStatisticsOutput: - schema: - properties: - cdn_domain: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - cdn_domain_GetPropertyProjectStatisticsOutput: - schema: - properties: - cdn_domain: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - cdn_domain_GetPropertyProjectTagValuePairsOutput: {} - cdn_domain_GetPropertyProjectTagValueTreeOutput: {} - cdn_domain_GetPropertySplitableExportOutput: {} - cdn_domain_GetPropertySplitableOutput: {} - cdn_domain_GetPropertyStatisticsOutput: - schema: - properties: - cdn_domain: - $ref: '#/definitions/StatusStatistic' - type: object - cdn_domain_GetPropertyTagValuePairsOutput: {} - cdn_domain_GetPropertyTagValueTreeOutput: {} - cdn_domain_ListItemFilterOutput: - schema: - properties: - cdn_domains: - items: - $ref: '#/definitions/CDNDomainDetails' - 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 - cdn_domain_PerformCancelDeleteOutput: {} - cdn_domain_PerformChangeOwnerOutput: {} - cdn_domain_PerformClassMetadataOutput: {} - cdn_domain_PerformDisableOutput: {} - cdn_domain_PerformEnableOutput: {} - cdn_domain_PerformFreezeOutput: {} - cdn_domain_PerformPurgeSplitableOutput: {} - cdn_domain_PerformRemoteUpdateOutput: {} - cdn_domain_PerformSetClassMetadataOutput: {} - cdn_domain_PerformSetUserMetadataOutput: {} - cdn_domain_PerformStatusOutput: {} - cdn_domain_PerformSyncstatusOutput: {} - cdn_domain_PerformUnfreezeOutput: {} - cdn_domain_ValidateCreateDataOutput: - schema: - properties: - cdn_domain: - $ref: '#/definitions/CDNDomainDetails' - type: object - cdn_domain_ValidateUpdateDataOutput: - schema: - properties: - cdn_domain: - $ref: '#/definitions/CDNDomainDetails' - type: object - cloudaccount_CustomizeDeleteOutput: - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountDetail' - type: object - cloudaccount_FetchCustomizeColumnsOutput: - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountDetail' - type: object - cloudaccount_GetDetailsBalanceOutput: {} - cloudaccount_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - cloudaccount: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - cloudaccount_GetDetailsClassMetadataOutput: - schema: - properties: - cloudaccount: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudaccount_GetDetailsEnrollmentAccountsOutput: - schema: - properties: - cloudaccount: - items: - $ref: '#/definitions/SEnrollmentAccount' - type: array - x-go-name: Output - type: object - cloudaccount_GetDetailsMetadataOutput: - schema: - properties: - cloudaccount: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudaccount_GetDetailsSamlOutput: - schema: - properties: - cloudaccount: - $ref: '#/definitions/GetCloudaccountSamlOutput' - type: object - cloudaccount_GetDetailsStatusOutput: - schema: - properties: - cloudaccount: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cloudaccount_GetPropertyDistinctFieldOutput: {} - cloudaccount_GetPropertyDomainTagValuePairsOutput: {} - cloudaccount_GetPropertyDomainTagValueTreeOutput: {} - cloudaccount_GetPropertySplitableExportOutput: {} - cloudaccount_GetPropertySplitableOutput: {} - cloudaccount_GetPropertyStatisticsOutput: - schema: - properties: - cloudaccount: - $ref: '#/definitions/StatusStatistic' - type: object - cloudaccount_GetPropertyTagValuePairsOutput: {} - cloudaccount_GetPropertyTagValueTreeOutput: {} - cloudaccount_ListItemFilterOutput: - schema: - properties: - cloudaccounts: - items: - $ref: '#/definitions/CloudaccountDetail' - 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 - cloudaccount_PerformChangeProjectOutput: {} - cloudaccount_PerformClassMetadataOutput: {} - cloudaccount_PerformCreateSubscriptionOutput: {} - cloudaccount_PerformDisableOutput: {} - cloudaccount_PerformEnableOutput: {} - cloudaccount_PerformPrepareNetsOutput: - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountPerformPrepareNetsOutput' - type: object - cloudaccount_PerformPrivateOutput: {} - cloudaccount_PerformProjectMappingOutput: {} - cloudaccount_PerformPublicOutput: {} - cloudaccount_PerformPurgeSplitableOutput: {} - cloudaccount_PerformSetClassMetadataOutput: {} - cloudaccount_PerformSetUserMetadataOutput: {} - cloudaccount_PerformShareModeOutput: {} - cloudaccount_PerformStatusOutput: {} - cloudaccount_PerformSyncOutput: {} - cloudaccount_PerformSyncSkusOutput: {} - cloudaccount_PerformTestConnectivityOutput: {} - cloudaccount_PerformUpdateCredentialOutput: {} - cloudaccount_ValidateCreateDataOutput: - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountDetail' - type: object - cloudaccount_ValidateUpdateDataOutput: - schema: - properties: - cloudaccount: - $ref: '#/definitions/CloudaccountDetail' - type: object - cloudimage_CustomizeDeleteOutput: - schema: - properties: - cloudimage: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - cloudimage_FetchCustomizeColumnsOutput: - schema: - properties: - cloudimage: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - cloudimage_GetDetailsClassMetadataOutput: - schema: - properties: - cloudimage: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudimage_GetDetailsMetadataOutput: - schema: - properties: - cloudimage: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudimage_GetPropertyDistinctFieldOutput: {} - cloudimage_GetPropertySplitableExportOutput: {} - cloudimage_GetPropertySplitableOutput: {} - cloudimage_GetPropertyTagValuePairsOutput: {} - cloudimage_GetPropertyTagValueTreeOutput: {} - cloudimage_ListItemFilterOutput: - schema: - properties: - cloudimages: - items: - $ref: '#/definitions/StandaloneResourceDetails' - 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 - cloudimage_PerformClassMetadataOutput: {} - cloudimage_PerformPurgeSplitableOutput: {} - cloudimage_PerformSetClassMetadataOutput: {} - cloudimage_PerformSetUserMetadataOutput: {} - cloudimage_ValidateCreateDataOutput: - schema: - properties: - cloudimage: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - cloudimage_ValidateUpdateDataOutput: - schema: - properties: - cloudimage: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - cloudprovider_CustomizeDeleteOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/CloudproviderDetails' - type: object - cloudprovider_FetchCustomizeColumnsOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/CloudproviderDetails' - type: object - cloudprovider_GetDetailsCannedAclsOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/CloudproviderGetCannedAclOutput' - type: object - cloudprovider_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - cloudprovider_GetDetailsClassMetadataOutput: - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudprovider_GetDetailsClircOutput: {} - cloudprovider_GetDetailsMetadataOutput: - schema: - properties: - cloudprovider: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudprovider_GetDetailsStatusOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cloudprovider_GetDetailsStorageClassesOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/CloudproviderGetStorageClassOutput' - type: object - cloudprovider_GetPropertyDistinctFieldOutput: {} - cloudprovider_GetPropertySplitableExportOutput: {} - cloudprovider_GetPropertySplitableOutput: {} - cloudprovider_GetPropertyStatisticsOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/StatusStatistic' - type: object - cloudprovider_GetPropertyTagValuePairsOutput: {} - cloudprovider_GetPropertyTagValueTreeOutput: {} - cloudprovider_ListItemFilterOutput: - schema: - properties: - cloudproviders: - items: - $ref: '#/definitions/CloudproviderDetails' - 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 - cloudprovider_PerformChangeProjectOutput: {} - cloudprovider_PerformClassMetadataOutput: {} - cloudprovider_PerformDisableOutput: {} - cloudprovider_PerformEnableOutput: {} - cloudprovider_PerformProjectMappingOutput: {} - cloudprovider_PerformPurgeSplitableOutput: {} - cloudprovider_PerformSetClassMetadataOutput: {} - cloudprovider_PerformSetSchedtagOutput: {} - cloudprovider_PerformSetSyncingOutput: {} - cloudprovider_PerformSetUserMetadataOutput: {} - cloudprovider_PerformStatusOutput: {} - cloudprovider_PerformSyncOutput: {} - cloudprovider_ValidateUpdateDataOutput: - schema: - properties: - cloudprovider: - $ref: '#/definitions/CloudproviderDetails' - type: object - cloudproviderregion_CustomizeDeleteOutput: - schema: - properties: - cloudproviderregion: - $ref: '#/definitions/CloudproviderregionDetails' - type: object - cloudproviderregion_FetchCustomizeColumnsOutput: - schema: - properties: - cloudproviderregion: - $ref: '#/definitions/CloudproviderregionDetails' - type: object - cloudproviderregion_GetPropertyDistinctFieldOutput: {} - cloudproviderregion_GetPropertySplitableExportOutput: {} - cloudproviderregion_GetPropertySplitableOutput: {} - cloudproviderregion_ListItemFilterOutput: - schema: - properties: - cloudproviderregions: - items: - $ref: '#/definitions/CloudproviderregionDetails' - 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 - cloudproviderregion_PerformPurgeSplitableOutput: {} - cloudproviderregion_ValidateCreateDataOutput: - schema: - properties: - cloudproviderregion: - $ref: '#/definitions/CloudproviderregionDetails' - type: object - cloudproviderregion_ValidateUpdateDataOutput: - schema: - properties: - cloudproviderregion: - $ref: '#/definitions/CloudproviderregionDetails' - type: object - cloudregion_CustomizeDeleteOutput: - schema: - properties: - cloudregion: - $ref: '#/definitions/CloudregionDetails' - type: object - cloudregion_FetchCustomizeColumnsOutput: - schema: - properties: - cloudregion: - $ref: '#/definitions/CloudregionDetails' - type: object - cloudregion_GetDetailsCapabilityOutput: {} - cloudregion_GetDetailsClassMetadataOutput: - schema: - properties: - cloudregion: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudregion_GetDetailsDiskCapabilityOutput: {} - cloudregion_GetDetailsMetadataOutput: - schema: - properties: - cloudregion: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - cloudregion_GetDetailsStatusOutput: - schema: - properties: - cloudregion: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - cloudregion_GetPropertyDistinctFieldOutput: {} - cloudregion_GetPropertySplitableExportOutput: {} - cloudregion_GetPropertySplitableOutput: {} - cloudregion_GetPropertyStatisticsOutput: - schema: - properties: - cloudregion: - $ref: '#/definitions/StatusStatistic' - type: object - cloudregion_GetPropertySyncTasksOutput: {} - cloudregion_GetPropertyTagValuePairsOutput: {} - cloudregion_GetPropertyTagValueTreeOutput: {} - cloudregion_ListItemFilterOutput: - schema: - properties: - cloudregions: - items: - $ref: '#/definitions/CloudregionDetails' - 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 - cloudregion_PerformClassMetadataOutput: {} - cloudregion_PerformDefaultVpcOutput: {} - cloudregion_PerformDisableOutput: {} - cloudregion_PerformEnableOutput: {} - cloudregion_PerformPurgeSplitableOutput: {} - cloudregion_PerformSetClassMetadataOutput: {} - cloudregion_PerformSetSchedtagOutput: {} - cloudregion_PerformSetUserMetadataOutput: {} - cloudregion_PerformStatusOutput: {} - cloudregion_PerformSyncImagesOutput: {} - cloudregion_PerformSyncSkusOutput: {} - cloudregion_ValidateCreateDataOutput: - schema: - properties: - cloudregion: - $ref: '#/definitions/CloudregionDetails' - type: object - cloudregion_ValidateUpdateDataOutput: - schema: - properties: - cloudregion: - $ref: '#/definitions/CloudregionDetails' - type: object - db_instance_CustomizeDeleteOutput: - schema: - properties: - db_instance: - $ref: '#/definitions/DBInstanceDetails' - type: object - db_instance_FetchCustomizeColumnsOutput: - schema: - properties: - db_instance: - $ref: '#/definitions/DBInstanceDetails' - type: object - db_instance_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - db_instance: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - db_instance_GetDetailsClassMetadataOutput: - schema: - properties: - db_instance: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_GetDetailsMetadataOutput: - schema: - properties: - db_instance: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_GetDetailsStatusOutput: - schema: - properties: - db_instance: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - db_instance_GetPropertyDistinctFieldOutput: {} - db_instance_GetPropertyDomainStatisticsOutput: - schema: - properties: - db_instance: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - db_instance_GetPropertyProjectStatisticsOutput: - schema: - properties: - db_instance: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - db_instance_GetPropertyProjectTagValuePairsOutput: {} - db_instance_GetPropertyProjectTagValueTreeOutput: {} - db_instance_GetPropertySplitableExportOutput: {} - db_instance_GetPropertySplitableOutput: {} - db_instance_GetPropertyStatisticsOutput: - schema: - properties: - db_instance: - $ref: '#/definitions/StatusStatistic' - type: object - db_instance_GetPropertyTagValuePairsOutput: {} - db_instance_GetPropertyTagValueTreeOutput: {} - db_instance_ListItemFilterOutput: - schema: - properties: - db_instances: - items: - $ref: '#/definitions/DBInstanceDetails' - 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 - db_instance_PerformCancelDeleteOutput: {} - db_instance_PerformCancelExpireOutput: {} - db_instance_PerformChangeConfigOutput: {} - db_instance_PerformChangeOwnerOutput: {} - db_instance_PerformClassMetadataOutput: {} - db_instance_PerformFreezeOutput: {} - db_instance_PerformPostpaidExpireOutput: {} - db_instance_PerformPublicConnectionOutput: {} - db_instance_PerformPurgeOutput: {} - db_instance_PerformPurgeSplitableOutput: {} - db_instance_PerformRebootOutput: {} - db_instance_PerformRecoveryOutput: {} - db_instance_PerformRemoteUpdateOutput: {} - db_instance_PerformRenewOutput: {} - db_instance_PerformSetAutoRenewOutput: {} - db_instance_PerformSetClassMetadataOutput: {} - db_instance_PerformSetSecgroupOutput: {} - db_instance_PerformSetUserMetadataOutput: {} - db_instance_PerformStatusOutput: {} - db_instance_PerformSyncOutput: {} - db_instance_PerformSyncStatusOutput: {} - db_instance_PerformSyncstatusOutput: {} - db_instance_PerformUnfreezeOutput: {} - db_instance_ValidateCreateDataOutput: - schema: - properties: - db_instance: - $ref: '#/definitions/DBInstanceDetails' - type: object - db_instance_ValidateUpdateDataOutput: - schema: - properties: - db_instance: - $ref: '#/definitions/DBInstanceDetails' - type: object - db_instance_account_CustomizeDeleteOutput: - schema: - properties: - db_instance_account: - $ref: '#/definitions/DBInstanceAccountDetails' - type: object - db_instance_account_FetchCustomizeColumnsOutput: - schema: - properties: - db_instance_account: - $ref: '#/definitions/DBInstanceAccountDetails' - type: object - db_instance_account_GetDetailsClassMetadataOutput: - schema: - properties: - db_instance_account: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_account_GetDetailsMetadataOutput: - schema: - properties: - db_instance_account: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_account_GetDetailsStatusOutput: - schema: - properties: - db_instance_account: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - db_instance_account_GetPropertyDistinctFieldOutput: {} - db_instance_account_GetPropertySplitableExportOutput: {} - db_instance_account_GetPropertySplitableOutput: {} - db_instance_account_GetPropertyStatisticsOutput: - schema: - properties: - db_instance_account: - $ref: '#/definitions/StatusStatistic' - type: object - db_instance_account_GetPropertyTagValuePairsOutput: {} - db_instance_account_GetPropertyTagValueTreeOutput: {} - db_instance_account_ListItemFilterOutput: - schema: - properties: - db_instance_accounts: - items: - $ref: '#/definitions/DBInstanceAccountDetails' - 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 - db_instance_account_PerformClassMetadataOutput: {} - db_instance_account_PerformGrantPrivilegeOutput: {} - db_instance_account_PerformPurgeSplitableOutput: {} - db_instance_account_PerformResetPasswordOutput: {} - db_instance_account_PerformRevokePrivilegeOutput: {} - db_instance_account_PerformSetClassMetadataOutput: {} - db_instance_account_PerformSetPrivilegesOutput: {} - db_instance_account_PerformSetUserMetadataOutput: {} - db_instance_account_PerformStatusOutput: {} - db_instance_account_ValidateCreateDataOutput: - schema: - properties: - db_instance_account: - $ref: '#/definitions/DBInstanceAccountDetails' - type: object - db_instance_account_ValidateUpdateDataOutput: - schema: - properties: - db_instance_account: - $ref: '#/definitions/DBInstanceAccountDetails' - type: object - db_instance_backup_CustomizeDeleteOutput: - schema: - properties: - db_instance_backup: - $ref: '#/definitions/DBInstanceBackupDetails' - type: object - db_instance_backup_FetchCustomizeColumnsOutput: - schema: - properties: - db_instance_backup: - $ref: '#/definitions/DBInstanceBackupDetails' - type: object - db_instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - db_instance_backup: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - db_instance_backup_GetDetailsClassMetadataOutput: - schema: - properties: - db_instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_backup_GetDetailsMetadataOutput: - schema: - properties: - db_instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_backup_GetDetailsStatusOutput: - schema: - properties: - db_instance_backup: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - db_instance_backup_GetPropertyDistinctFieldOutput: {} - db_instance_backup_GetPropertyDomainStatisticsOutput: - schema: - properties: - db_instance_backup: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - db_instance_backup_GetPropertyProjectStatisticsOutput: - schema: - properties: - db_instance_backup: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - db_instance_backup_GetPropertyProjectTagValuePairsOutput: {} - db_instance_backup_GetPropertyProjectTagValueTreeOutput: {} - db_instance_backup_GetPropertySplitableExportOutput: {} - db_instance_backup_GetPropertySplitableOutput: {} - db_instance_backup_GetPropertyStatisticsOutput: - schema: - properties: - db_instance_backup: - $ref: '#/definitions/StatusStatistic' - type: object - db_instance_backup_GetPropertyTagValuePairsOutput: {} - db_instance_backup_GetPropertyTagValueTreeOutput: {} - db_instance_backup_ListItemFilterOutput: - schema: - properties: - db_instance_backups: - items: - $ref: '#/definitions/DBInstanceBackupDetails' - 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 - db_instance_backup_PerformCancelDeleteOutput: {} - db_instance_backup_PerformChangeOwnerOutput: {} - db_instance_backup_PerformClassMetadataOutput: {} - db_instance_backup_PerformFreezeOutput: {} - db_instance_backup_PerformPurgeSplitableOutput: {} - db_instance_backup_PerformSetClassMetadataOutput: {} - db_instance_backup_PerformSetUserMetadataOutput: {} - db_instance_backup_PerformStatusOutput: {} - db_instance_backup_PerformSyncstatusOutput: {} - db_instance_backup_PerformUnfreezeOutput: {} - db_instance_backup_ValidateCreateDataOutput: - schema: - properties: - db_instance_backup: - $ref: '#/definitions/DBInstanceBackupDetails' - type: object - db_instance_backup_ValidateUpdateDataOutput: - schema: - properties: - db_instance_backup: - $ref: '#/definitions/DBInstanceBackupDetails' - type: object - db_instance_database_CustomizeDeleteOutput: - schema: - properties: - db_instance_database: - $ref: '#/definitions/DBInstancedatabaseDetails' - type: object - db_instance_database_FetchCustomizeColumnsOutput: - schema: - properties: - db_instance_database: - $ref: '#/definitions/DBInstancedatabaseDetails' - type: object - db_instance_database_GetDetailsClassMetadataOutput: - schema: - properties: - db_instance_database: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_database_GetDetailsMetadataOutput: - schema: - properties: - db_instance_database: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_database_GetDetailsStatusOutput: - schema: - properties: - db_instance_database: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - db_instance_database_GetPropertyDistinctFieldOutput: {} - db_instance_database_GetPropertySplitableExportOutput: {} - db_instance_database_GetPropertySplitableOutput: {} - db_instance_database_GetPropertyStatisticsOutput: - schema: - properties: - db_instance_database: - $ref: '#/definitions/StatusStatistic' - type: object - db_instance_database_GetPropertyTagValuePairsOutput: {} - db_instance_database_GetPropertyTagValueTreeOutput: {} - db_instance_database_ListItemFilterOutput: - schema: - properties: - db_instance_databases: - items: - $ref: '#/definitions/DBInstancedatabaseDetails' - 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 - db_instance_database_PerformClassMetadataOutput: {} - db_instance_database_PerformPurgeSplitableOutput: {} - db_instance_database_PerformSetClassMetadataOutput: {} - db_instance_database_PerformSetUserMetadataOutput: {} - db_instance_database_PerformStatusOutput: {} - db_instance_database_ValidateCreateDataOutput: - schema: - properties: - db_instance_database: - $ref: '#/definitions/DBInstancedatabaseDetails' - type: object - db_instance_database_ValidateUpdateDataOutput: - schema: - properties: - db_instance_database: - $ref: '#/definitions/DBInstancedatabaseDetails' - type: object - db_instance_network_CustomizeDeleteOutput: - schema: - properties: - db_instance_network: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - type: object - db_instance_network_FetchCustomizeColumnsOutput: - schema: - properties: - db_instance_network: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - type: object - db_instance_network_GetPropertyDistinctFieldOutput: {} - db_instance_network_GetPropertySplitableExportOutput: {} - db_instance_network_GetPropertySplitableOutput: {} - db_instance_network_ListItemFilterOutput: - schema: - properties: - db_instance_networks: - items: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - 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 - db_instance_network_PerformPurgeSplitableOutput: {} - db_instance_network_ValidateCreateDataOutput: - schema: - properties: - db_instance_network: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - type: object - db_instance_network_ValidateUpdateDataOutput: - schema: - properties: - db_instance_network: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - type: object - db_instance_parameter_CustomizeDeleteOutput: - schema: - properties: - db_instance_parameter: - $ref: '#/definitions/DBInstanceparameterDetails' - type: object - db_instance_parameter_FetchCustomizeColumnsOutput: - schema: - properties: - db_instance_parameter: - $ref: '#/definitions/DBInstanceparameterDetails' - type: object - db_instance_parameter_GetDetailsClassMetadataOutput: - schema: - properties: - db_instance_parameter: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_parameter_GetDetailsMetadataOutput: - schema: - properties: - db_instance_parameter: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_parameter_GetPropertyDistinctFieldOutput: {} - db_instance_parameter_GetPropertySplitableExportOutput: {} - db_instance_parameter_GetPropertySplitableOutput: {} - db_instance_parameter_GetPropertyTagValuePairsOutput: {} - db_instance_parameter_GetPropertyTagValueTreeOutput: {} - db_instance_parameter_ListItemFilterOutput: - schema: - properties: - db_instance_parameters: - items: - $ref: '#/definitions/DBInstanceparameterDetails' - 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 - db_instance_parameter_PerformClassMetadataOutput: {} - db_instance_parameter_PerformPurgeSplitableOutput: {} - db_instance_parameter_PerformSetClassMetadataOutput: {} - db_instance_parameter_PerformSetUserMetadataOutput: {} - db_instance_parameter_ValidateCreateDataOutput: - schema: - properties: - db_instance_parameter: - $ref: '#/definitions/DBInstanceparameterDetails' - type: object - db_instance_parameter_ValidateUpdateDataOutput: - schema: - properties: - db_instance_parameter: - $ref: '#/definitions/DBInstanceparameterDetails' - type: object - db_instance_privilege_CustomizeDeleteOutput: - schema: - properties: - db_instance_privilege: - $ref: '#/definitions/ResourceBaseDetails' - type: object - db_instance_privilege_FetchCustomizeColumnsOutput: - schema: - properties: - db_instance_privilege: - $ref: '#/definitions/ResourceBaseDetails' - type: object - db_instance_privilege_GetPropertyDistinctFieldOutput: {} - db_instance_privilege_GetPropertySplitableExportOutput: {} - db_instance_privilege_GetPropertySplitableOutput: {} - db_instance_privilege_ListItemFilterOutput: - schema: - properties: - db_instance_privileges: - items: - $ref: '#/definitions/ResourceBaseDetails' - 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 - db_instance_privilege_PerformPurgeSplitableOutput: {} - db_instance_privilege_ValidateCreateDataOutput: - schema: - properties: - db_instance_privilege: - $ref: '#/definitions/ResourceBaseDetails' - type: object - db_instance_privilege_ValidateUpdateDataOutput: - schema: - properties: - db_instance_privilege: - $ref: '#/definitions/ResourceBaseDetails' - type: object - db_instance_secgroup_CustomizeDeleteOutput: - schema: - properties: - db_instance_secgroup: - $ref: '#/definitions/DBInstanceSecgroupDetails' - type: object - db_instance_secgroup_FetchCustomizeColumnsOutput: - schema: - properties: - db_instance_secgroup: - $ref: '#/definitions/DBInstanceSecgroupDetails' - type: object - db_instance_secgroup_GetPropertyDistinctFieldOutput: {} - db_instance_secgroup_GetPropertySplitableExportOutput: {} - db_instance_secgroup_GetPropertySplitableOutput: {} - db_instance_secgroup_ListItemFilterOutput: - schema: - properties: - db_instance_secgroups: - items: - $ref: '#/definitions/DBInstanceSecgroupDetails' - 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 - db_instance_secgroup_PerformPurgeSplitableOutput: {} - db_instance_secgroup_ValidateCreateDataOutput: - schema: - properties: - db_instance_secgroup: - $ref: '#/definitions/DBInstanceSecgroupDetails' - type: object - db_instance_secgroup_ValidateUpdateDataOutput: - schema: - properties: - db_instance_secgroup: - $ref: '#/definitions/DBInstanceSecgroupDetails' - type: object - db_instance_sku_CustomizeDeleteOutput: - schema: - properties: - db_instance_sku: - $ref: '#/definitions/DBInstanceSkuDetails' - type: object - db_instance_sku_FetchCustomizeColumnsOutput: - schema: - properties: - db_instance_sku: - $ref: '#/definitions/DBInstanceSkuDetails' - type: object - db_instance_sku_GetDetailsClassMetadataOutput: - schema: - properties: - db_instance_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_sku_GetDetailsMetadataOutput: - schema: - properties: - db_instance_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - db_instance_sku_GetDetailsStatusOutput: - schema: - properties: - db_instance_sku: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - db_instance_sku_GetPropertyDistinctFieldOutput: {} - db_instance_sku_GetPropertyInstanceSpecsOutput: {} - db_instance_sku_GetPropertySplitableExportOutput: {} - db_instance_sku_GetPropertySplitableOutput: {} - db_instance_sku_GetPropertyStatisticsOutput: - schema: - properties: - db_instance_sku: - $ref: '#/definitions/StatusStatistic' - type: object - db_instance_sku_GetPropertySyncTasksOutput: {} - db_instance_sku_GetPropertyTagValuePairsOutput: {} - db_instance_sku_GetPropertyTagValueTreeOutput: {} - db_instance_sku_ListItemFilterOutput: - schema: - properties: - db_instance_skus: - items: - $ref: '#/definitions/DBInstanceSkuDetails' - 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 - db_instance_sku_PerformClassMetadataOutput: {} - db_instance_sku_PerformDisableOutput: {} - db_instance_sku_PerformEnableOutput: {} - db_instance_sku_PerformPurgeSplitableOutput: {} - db_instance_sku_PerformSetClassMetadataOutput: {} - db_instance_sku_PerformSetUserMetadataOutput: {} - db_instance_sku_PerformStatusOutput: {} - db_instance_sku_PerformSyncSkusOutput: {} - db_instance_sku_ValidateCreateDataOutput: - schema: - properties: - db_instance_sku: - $ref: '#/definitions/DBInstanceSkuDetails' - type: object - db_instance_sku_ValidateUpdateDataOutput: - schema: - properties: - db_instance_sku: - $ref: '#/definitions/DBInstanceSkuDetails' - type: object - disk_CustomizeDeleteOutput: - schema: - properties: - disk: - $ref: '#/definitions/DiskDetails' - type: object - disk_FetchCustomizeColumnsOutput: - schema: - properties: - disk: - $ref: '#/definitions/DiskDetails' - type: object - disk_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - disk: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - disk_GetDetailsClassMetadataOutput: - schema: - properties: - disk: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - disk_GetDetailsConvertSnapshotOutput: {} - disk_GetDetailsMetadataOutput: - schema: - properties: - disk: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - disk_GetDetailsStatusOutput: - schema: - properties: - disk: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - disk_GetPropertyDistinctFieldOutput: {} - disk_GetPropertyDomainStatisticsOutput: - schema: - properties: - disk: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - disk_GetPropertyProjectStatisticsOutput: - schema: - properties: - disk: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - disk_GetPropertyProjectTagValuePairsOutput: {} - disk_GetPropertyProjectTagValueTreeOutput: {} - disk_GetPropertySplitableExportOutput: {} - disk_GetPropertySplitableOutput: {} - disk_GetPropertyStatisticsOutput: - schema: - properties: - disk: - $ref: '#/definitions/StatusStatistic' - type: object - disk_GetPropertyTagValuePairsOutput: {} - disk_GetPropertyTagValueTreeOutput: {} - disk_ListItemFilterOutput: - schema: - properties: - disks: - items: - $ref: '#/definitions/DiskDetails' - 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 - disk_PerformBindSnapshotpolicyOutput: {} - disk_PerformCancelDeleteOutput: {} - disk_PerformChangeOwnerOutput: {} - disk_PerformClassMetadataOutput: {} - disk_PerformDiskResetOutput: {} - disk_PerformFreezeOutput: {} - disk_PerformPurgeOutput: {} - disk_PerformPurgeSplitableOutput: {} - disk_PerformResizeOutput: {} - disk_PerformSaveOutput: {} - disk_PerformSetClassMetadataOutput: {} - disk_PerformSetUserMetadataOutput: {} - disk_PerformStatusOutput: {} - disk_PerformSyncstatusOutput: {} - disk_PerformUnbindSnapshotpolicyOutput: {} - disk_PerformUnfreezeOutput: {} - disk_ValidateCreateDataOutput: - schema: - properties: - disk: - $ref: '#/definitions/DiskDetails' - type: object - disk_ValidateUpdateDataOutput: - schema: - properties: - disk: - $ref: '#/definitions/DiskDetails' - type: object - disk_backup_CustomizeDeleteOutput: - schema: - properties: - disk_backup: - $ref: '#/definitions/DiskBackupDetails' - type: object - disk_backup_FetchCustomizeColumnsOutput: - schema: - properties: - disk_backup: - $ref: '#/definitions/DiskBackupDetails' - type: object - disk_backup_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - disk_backup: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - disk_backup_GetDetailsClassMetadataOutput: - schema: - properties: - disk_backup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - disk_backup_GetDetailsMetadataOutput: - schema: - properties: - disk_backup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - disk_backup_GetDetailsStatusOutput: - schema: - properties: - disk_backup: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - disk_backup_GetPropertyDistinctFieldOutput: {} - disk_backup_GetPropertyDomainStatisticsOutput: - schema: - properties: - disk_backup: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - disk_backup_GetPropertyProjectStatisticsOutput: - schema: - properties: - disk_backup: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - disk_backup_GetPropertyProjectTagValuePairsOutput: {} - disk_backup_GetPropertyProjectTagValueTreeOutput: {} - disk_backup_GetPropertySplitableExportOutput: {} - disk_backup_GetPropertySplitableOutput: {} - disk_backup_GetPropertyStatisticsOutput: - schema: - properties: - disk_backup: - $ref: '#/definitions/StatusStatistic' - type: object - disk_backup_GetPropertyTagValuePairsOutput: {} - disk_backup_GetPropertyTagValueTreeOutput: {} - disk_backup_ListItemFilterOutput: - schema: - properties: - disk_backups: - items: - $ref: '#/definitions/DiskBackupDetails' - 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 - disk_backup_PerformCancelDeleteOutput: {} - disk_backup_PerformChangeOwnerOutput: {} - disk_backup_PerformClassMetadataOutput: {} - disk_backup_PerformFreezeOutput: {} - disk_backup_PerformPurgeSplitableOutput: {} - disk_backup_PerformRecoveryOutput: {} - disk_backup_PerformSetClassMetadataOutput: {} - disk_backup_PerformSetUserMetadataOutput: {} - disk_backup_PerformStatusOutput: {} - disk_backup_PerformSyncstatusOutput: {} - disk_backup_PerformUnfreezeOutput: {} - disk_backup_ValidateCreateDataOutput: - schema: - properties: - disk_backup: - $ref: '#/definitions/DiskBackupDetails' - type: object - disk_backup_ValidateUpdateDataOutput: - schema: - properties: - disk_backup: - $ref: '#/definitions/DiskBackupDetails' - type: object - dns_record_CustomizeDeleteOutput: - schema: - properties: - dns_record: - $ref: '#/definitions/DnsRecordDetails' - type: object - dns_record_FetchCustomizeColumnsOutput: - schema: - properties: - dns_record: - $ref: '#/definitions/DnsRecordDetails' - type: object - dns_record_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - dns_record: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - dns_record_GetDetailsClassMetadataOutput: - schema: - properties: - dns_record: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_record_GetDetailsMetadataOutput: - schema: - properties: - dns_record: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_record_GetDetailsStatusOutput: - schema: - properties: - dns_record: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - dns_record_GetPropertyDistinctFieldOutput: {} - dns_record_GetPropertyDomainStatisticsOutput: - schema: - properties: - dns_record: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - dns_record_GetPropertyProjectStatisticsOutput: - schema: - properties: - dns_record: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - dns_record_GetPropertyProjectTagValuePairsOutput: {} - dns_record_GetPropertyProjectTagValueTreeOutput: {} - dns_record_GetPropertySplitableExportOutput: {} - dns_record_GetPropertySplitableOutput: {} - dns_record_GetPropertyStatisticsOutput: - schema: - properties: - dns_record: - $ref: '#/definitions/StatusStatistic' - type: object - dns_record_GetPropertyTagValuePairsOutput: {} - dns_record_GetPropertyTagValueTreeOutput: {} - dns_record_ListItemFilterOutput: - schema: - properties: - dns_records: - items: - $ref: '#/definitions/DnsRecordDetails' - 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 - dns_record_PerformAddRecordsOutput: {} - dns_record_PerformCancelDeleteOutput: {} - dns_record_PerformChangeOwnerOutput: {} - dns_record_PerformClassMetadataOutput: {} - dns_record_PerformDisableOutput: {} - dns_record_PerformEnableOutput: {} - dns_record_PerformFreezeOutput: {} - dns_record_PerformPrivateOutput: {} - dns_record_PerformPublicOutput: {} - dns_record_PerformPurgeSplitableOutput: {} - dns_record_PerformRemoveRecordsOutput: {} - dns_record_PerformSetClassMetadataOutput: {} - dns_record_PerformSetUserMetadataOutput: {} - dns_record_PerformStatusOutput: {} - dns_record_PerformUnfreezeOutput: {} - dns_record_ValidateCreateDataOutput: - schema: - properties: - dns_record: - $ref: '#/definitions/DnsRecordDetails' - type: object - dns_record_ValidateUpdateDataOutput: - schema: - properties: - dns_record: - $ref: '#/definitions/DnsRecordDetails' - type: object - dns_record_set_traffic_policy_CustomizeDeleteOutput: - schema: - properties: - dns_record_set_traffic_policy: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - dns_record_set_traffic_policy_FetchCustomizeColumnsOutput: - schema: - properties: - dns_record_set_traffic_policy: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - dns_record_set_traffic_policy_GetPropertyDistinctFieldOutput: {} - dns_record_set_traffic_policy_GetPropertySplitableExportOutput: {} - dns_record_set_traffic_policy_GetPropertySplitableOutput: {} - dns_record_set_traffic_policy_ListItemFilterOutput: - schema: - properties: - dns_record_set_traffic_policies: - items: - $ref: '#/definitions/JointResourceBaseDetails' - 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 - dns_record_set_traffic_policy_PerformPurgeSplitableOutput: {} - dns_record_set_traffic_policy_ValidateCreateDataOutput: - schema: - properties: - dns_record_set_traffic_policy: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - dns_record_set_traffic_policy_ValidateUpdateDataOutput: - schema: - properties: - dns_record_set_traffic_policy: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - dns_recordset_CustomizeDeleteOutput: - schema: - properties: - dns_recordset: - $ref: '#/definitions/DnsRecordSetDetails' - type: object - dns_recordset_FetchCustomizeColumnsOutput: - schema: - properties: - dns_recordset: - $ref: '#/definitions/DnsRecordSetDetails' - type: object - dns_recordset_GetDetailsClassMetadataOutput: - schema: - properties: - dns_recordset: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_recordset_GetDetailsMetadataOutput: - schema: - properties: - dns_recordset: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_recordset_GetDetailsStatusOutput: - schema: - properties: - dns_recordset: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - dns_recordset_GetPropertyDistinctFieldOutput: {} - dns_recordset_GetPropertySplitableExportOutput: {} - dns_recordset_GetPropertySplitableOutput: {} - dns_recordset_GetPropertyStatisticsOutput: - schema: - properties: - dns_recordset: - $ref: '#/definitions/StatusStatistic' - type: object - dns_recordset_GetPropertyTagValuePairsOutput: {} - dns_recordset_GetPropertyTagValueTreeOutput: {} - dns_recordset_ListItemFilterOutput: - schema: - properties: - dns_recordsets: - items: - $ref: '#/definitions/DnsRecordSetDetails' - 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 - dns_recordset_PerformClassMetadataOutput: {} - dns_recordset_PerformDisableOutput: {} - dns_recordset_PerformEnableOutput: {} - dns_recordset_PerformPurgeSplitableOutput: {} - dns_recordset_PerformSetClassMetadataOutput: {} - dns_recordset_PerformSetTrafficPoliciesOutput: {} - dns_recordset_PerformSetUserMetadataOutput: {} - dns_recordset_PerformStatusOutput: {} - dns_recordset_ValidateCreateDataOutput: - schema: - properties: - dns_recordset: - $ref: '#/definitions/DnsRecordSetDetails' - type: object - dns_recordset_ValidateUpdateDataOutput: - schema: - properties: - dns_recordset: - $ref: '#/definitions/DnsRecordSetDetails' - type: object - dns_traffic_policy_CustomizeDeleteOutput: - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/DnsTrafficPolicyDetails' - type: object - dns_traffic_policy_FetchCustomizeColumnsOutput: - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/DnsTrafficPolicyDetails' - type: object - dns_traffic_policy_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - dns_traffic_policy_GetDetailsClassMetadataOutput: - schema: - properties: - dns_traffic_policy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_traffic_policy_GetDetailsMetadataOutput: - schema: - properties: - dns_traffic_policy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_traffic_policy_GetDetailsStatusOutput: - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - dns_traffic_policy_GetPropertyDistinctFieldOutput: {} - dns_traffic_policy_GetPropertyDomainTagValuePairsOutput: {} - dns_traffic_policy_GetPropertyDomainTagValueTreeOutput: {} - dns_traffic_policy_GetPropertySplitableExportOutput: {} - dns_traffic_policy_GetPropertySplitableOutput: {} - dns_traffic_policy_GetPropertyStatisticsOutput: - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/StatusStatistic' - type: object - dns_traffic_policy_GetPropertyTagValuePairsOutput: {} - dns_traffic_policy_GetPropertyTagValueTreeOutput: {} - dns_traffic_policy_ListItemFilterOutput: - schema: - properties: - dns_traffic_policies: - items: - $ref: '#/definitions/DnsTrafficPolicyDetails' - 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 - dns_traffic_policy_PerformChangeOwnerOutput: {} - dns_traffic_policy_PerformClassMetadataOutput: {} - dns_traffic_policy_PerformDisableOutput: {} - dns_traffic_policy_PerformEnableOutput: {} - dns_traffic_policy_PerformPrivateOutput: {} - dns_traffic_policy_PerformPublicOutput: {} - dns_traffic_policy_PerformPurgeSplitableOutput: {} - dns_traffic_policy_PerformSetClassMetadataOutput: {} - dns_traffic_policy_PerformSetUserMetadataOutput: {} - dns_traffic_policy_PerformStatusOutput: {} - dns_traffic_policy_ValidateCreateDataOutput: - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/DnsTrafficPolicyDetails' - type: object - dns_traffic_policy_ValidateUpdateDataOutput: - schema: - properties: - dns_traffic_policy: - $ref: '#/definitions/DnsTrafficPolicyDetails' - type: object - dns_zone_CustomizeDeleteOutput: - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneDetails' - type: object - dns_zone_FetchCustomizeColumnsOutput: - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneDetails' - type: object - dns_zone_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - dns_zone: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - dns_zone_GetDetailsClassMetadataOutput: - schema: - properties: - dns_zone: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_zone_GetDetailsExportsOutput: {} - dns_zone_GetDetailsMetadataOutput: - schema: - properties: - dns_zone: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_zone_GetDetailsStatusOutput: - schema: - properties: - dns_zone: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - dns_zone_GetPropertyCapabilityOutput: {} - dns_zone_GetPropertyDistinctFieldOutput: {} - dns_zone_GetPropertyDomainTagValuePairsOutput: {} - dns_zone_GetPropertyDomainTagValueTreeOutput: {} - dns_zone_GetPropertySplitableExportOutput: {} - dns_zone_GetPropertySplitableOutput: {} - dns_zone_GetPropertyStatisticsOutput: - schema: - properties: - dns_zone: - $ref: '#/definitions/StatusStatistic' - type: object - dns_zone_GetPropertyTagValuePairsOutput: {} - dns_zone_GetPropertyTagValueTreeOutput: {} - dns_zone_ListItemFilterOutput: - schema: - properties: - dns_zones: - items: - $ref: '#/definitions/DnsZoneDetails' - 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 - dns_zone_PerformAddVpcsOutput: {} - dns_zone_PerformCacheOutput: {} - dns_zone_PerformChangeOwnerOutput: {} - dns_zone_PerformClassMetadataOutput: {} - dns_zone_PerformDisableOutput: {} - dns_zone_PerformEnableOutput: {} - dns_zone_PerformPrivateOutput: {} - dns_zone_PerformPublicOutput: {} - dns_zone_PerformPurgeOutput: {} - dns_zone_PerformPurgeSplitableOutput: {} - dns_zone_PerformRemoveVpcsOutput: {} - dns_zone_PerformSetClassMetadataOutput: {} - dns_zone_PerformSetUserMetadataOutput: {} - dns_zone_PerformStatusOutput: {} - dns_zone_PerformSyncRecordsetsOutput: {} - dns_zone_PerformSyncstatusOutput: {} - dns_zone_PerformUncacheOutput: {} - dns_zone_ValidateCreateDataOutput: - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneDetails' - type: object - dns_zone_ValidateUpdateDataOutput: - schema: - properties: - dns_zone: - $ref: '#/definitions/DnsZoneDetails' - type: object - dns_zone_cache_CustomizeDeleteOutput: - schema: - properties: - dns_zone_cache: - $ref: '#/definitions/DnsZoneCacheDetails' - type: object - dns_zone_cache_FetchCustomizeColumnsOutput: - schema: - properties: - dns_zone_cache: - $ref: '#/definitions/DnsZoneCacheDetails' - type: object - dns_zone_cache_GetDetailsClassMetadataOutput: - schema: - properties: - dns_zone_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_zone_cache_GetDetailsMetadataOutput: - schema: - properties: - dns_zone_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dns_zone_cache_GetDetailsStatusOutput: - schema: - properties: - dns_zone_cache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - dns_zone_cache_GetPropertyDistinctFieldOutput: {} - dns_zone_cache_GetPropertySplitableExportOutput: {} - dns_zone_cache_GetPropertySplitableOutput: {} - dns_zone_cache_GetPropertyStatisticsOutput: - schema: - properties: - dns_zone_cache: - $ref: '#/definitions/StatusStatistic' - type: object - dns_zone_cache_GetPropertyTagValuePairsOutput: {} - dns_zone_cache_GetPropertyTagValueTreeOutput: {} - dns_zone_cache_ListItemFilterOutput: - schema: - properties: - dns_zone_caches: - items: - $ref: '#/definitions/DnsZoneCacheDetails' - 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 - dns_zone_cache_PerformClassMetadataOutput: {} - dns_zone_cache_PerformPurgeSplitableOutput: {} - dns_zone_cache_PerformSetClassMetadataOutput: {} - dns_zone_cache_PerformSetUserMetadataOutput: {} - dns_zone_cache_PerformStatusOutput: {} - dns_zone_cache_ValidateCreateDataOutput: - schema: - properties: - dns_zone_cache: - $ref: '#/definitions/DnsZoneCacheDetails' - type: object - dns_zone_cache_ValidateUpdateDataOutput: - schema: - properties: - dns_zone_cache: - $ref: '#/definitions/DnsZoneCacheDetails' - type: object - dns_zone_vpc_CustomizeDeleteOutput: - schema: - properties: - dns_zone_vpc: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - dns_zone_vpc_FetchCustomizeColumnsOutput: - schema: - properties: - dns_zone_vpc: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - dns_zone_vpc_GetPropertyDistinctFieldOutput: {} - dns_zone_vpc_GetPropertySplitableExportOutput: {} - dns_zone_vpc_GetPropertySplitableOutput: {} - dns_zone_vpc_ListItemFilterOutput: - schema: - properties: - dns_zone_vpcs: - items: - $ref: '#/definitions/JointResourceBaseDetails' - 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 - dns_zone_vpc_PerformPurgeSplitableOutput: {} - dns_zone_vpc_ValidateCreateDataOutput: - schema: - properties: - dns_zone_vpc: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - dns_zone_vpc_ValidateUpdateDataOutput: - schema: - properties: - dns_zone_vpc: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - dynamicschedtag_CustomizeDeleteOutput: - schema: - properties: - dynamicschedtag: - $ref: '#/definitions/DynamicschedtagDetails' - type: object - dynamicschedtag_FetchCustomizeColumnsOutput: - schema: - properties: - dynamicschedtag: - $ref: '#/definitions/DynamicschedtagDetails' - type: object - dynamicschedtag_GetDetailsClassMetadataOutput: - schema: - properties: - dynamicschedtag: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dynamicschedtag_GetDetailsMetadataOutput: - schema: - properties: - dynamicschedtag: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - dynamicschedtag_GetPropertyDistinctFieldOutput: {} - dynamicschedtag_GetPropertySplitableExportOutput: {} - dynamicschedtag_GetPropertySplitableOutput: {} - dynamicschedtag_GetPropertyTagValuePairsOutput: {} - dynamicschedtag_GetPropertyTagValueTreeOutput: {} - dynamicschedtag_ListItemFilterOutput: - schema: - properties: - dynamicschedtags: - items: - $ref: '#/definitions/DynamicschedtagDetails' - 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 - dynamicschedtag_PerformClassMetadataOutput: {} - dynamicschedtag_PerformEvaluateOutput: {} - dynamicschedtag_PerformPurgeSplitableOutput: {} - dynamicschedtag_PerformSetClassMetadataOutput: {} - dynamicschedtag_PerformSetUserMetadataOutput: {} - dynamicschedtag_ValidateCreateDataOutput: - schema: - properties: - dynamicschedtag: - $ref: '#/definitions/DynamicschedtagDetails' - type: object - dynamicschedtag_ValidateUpdateDataOutput: - schema: - properties: - dynamicschedtag: - $ref: '#/definitions/DynamicschedtagDetails' - type: object - elastic_search_CustomizeDeleteOutput: - schema: - properties: - elastic_search: - $ref: '#/definitions/ElasticSearchDetails' - type: object - elastic_search_FetchCustomizeColumnsOutput: - schema: - properties: - elastic_search: - $ref: '#/definitions/ElasticSearchDetails' - type: object - elastic_search_GetDetailsAccessInfoOutput: - schema: - properties: - elastic_search: - $ref: '#/definitions/ElasticSearchAccessInfo' - type: object - elastic_search_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - elastic_search: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - elastic_search_GetDetailsClassMetadataOutput: - schema: - properties: - elastic_search: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elastic_search_GetDetailsMetadataOutput: - schema: - properties: - elastic_search: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elastic_search_GetDetailsStatusOutput: - schema: - properties: - elastic_search: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - elastic_search_GetPropertyDistinctFieldOutput: {} - elastic_search_GetPropertyDomainStatisticsOutput: - schema: - properties: - elastic_search: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - elastic_search_GetPropertyProjectStatisticsOutput: - schema: - properties: - elastic_search: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - elastic_search_GetPropertyProjectTagValuePairsOutput: {} - elastic_search_GetPropertyProjectTagValueTreeOutput: {} - elastic_search_GetPropertySplitableExportOutput: {} - elastic_search_GetPropertySplitableOutput: {} - elastic_search_GetPropertyStatisticsOutput: - schema: - properties: - elastic_search: - $ref: '#/definitions/StatusStatistic' - type: object - elastic_search_GetPropertyTagValuePairsOutput: {} - elastic_search_GetPropertyTagValueTreeOutput: {} - elastic_search_ListItemFilterOutput: - schema: - properties: - elastic_searches: - items: - $ref: '#/definitions/ElasticSearchDetails' - 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 - elastic_search_PerformCancelDeleteOutput: {} - elastic_search_PerformChangeOwnerOutput: {} - elastic_search_PerformClassMetadataOutput: {} - elastic_search_PerformFreezeOutput: {} - elastic_search_PerformPurgeSplitableOutput: {} - elastic_search_PerformSetClassMetadataOutput: {} - elastic_search_PerformSetUserMetadataOutput: {} - elastic_search_PerformStatusOutput: {} - elastic_search_PerformSyncstatusOutput: {} - elastic_search_PerformUnfreezeOutput: {} - elastic_search_ValidateCreateDataOutput: - schema: - properties: - elastic_search: - $ref: '#/definitions/ElasticSearchDetails' - type: object - elastic_search_ValidateUpdateDataOutput: - schema: - properties: - elastic_search: - $ref: '#/definitions/ElasticSearchDetails' - type: object - elasticcache_CustomizeDeleteOutput: - schema: - properties: - elasticcache: - $ref: '#/definitions/ElasticcacheDetails' - type: object - elasticcache_FetchCustomizeColumnsOutput: - schema: - properties: - elasticcache: - $ref: '#/definitions/ElasticcacheDetails' - type: object - elasticcache_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - elasticcache: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - elasticcache_GetDetailsClassMetadataOutput: - schema: - properties: - elasticcache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_GetDetailsLoginInfoOutput: {} - elasticcache_GetDetailsMetadataOutput: - schema: - properties: - elasticcache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_GetDetailsStatusOutput: - schema: - properties: - elasticcache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - elasticcache_GetPropertyDistinctFieldOutput: {} - elasticcache_GetPropertyDomainStatisticsOutput: - schema: - properties: - elasticcache: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - elasticcache_GetPropertyProjectStatisticsOutput: - schema: - properties: - elasticcache: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - elasticcache_GetPropertyProjectTagValuePairsOutput: {} - elasticcache_GetPropertyProjectTagValueTreeOutput: {} - elasticcache_GetPropertySplitableExportOutput: {} - elasticcache_GetPropertySplitableOutput: {} - elasticcache_GetPropertyStatisticsOutput: - schema: - properties: - elasticcache: - $ref: '#/definitions/StatusStatistic' - type: object - elasticcache_GetPropertyTagValuePairsOutput: {} - elasticcache_GetPropertyTagValueTreeOutput: {} - elasticcache_ListItemFilterOutput: - schema: - properties: - elasticcaches: - items: - $ref: '#/definitions/ElasticcacheDetails' - 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 - elasticcache_PerformAddSecgroupOutput: {} - elasticcache_PerformAllocatePublicConnectionOutput: {} - elasticcache_PerformCancelDeleteOutput: {} - elasticcache_PerformCancelExpireOutput: {} - elasticcache_PerformChangeOwnerOutput: {} - elasticcache_PerformChangeSpecOutput: {} - elasticcache_PerformClassMetadataOutput: {} - elasticcache_PerformFlushInstanceOutput: {} - elasticcache_PerformFreezeOutput: {} - elasticcache_PerformPostpaidExpireOutput: {} - elasticcache_PerformPurgeSplitableOutput: {} - elasticcache_PerformReleasePublicConnectionOutput: {} - elasticcache_PerformRemoteUpdateOutput: {} - elasticcache_PerformRenewOutput: {} - elasticcache_PerformResetPasswordOutput: {} - elasticcache_PerformRestartOutput: {} - elasticcache_PerformRevokeSecgroupOutput: {} - elasticcache_PerformSetAutoRenewOutput: {} - elasticcache_PerformSetClassMetadataOutput: {} - elasticcache_PerformSetMaintainTimeOutput: {} - elasticcache_PerformSetSecgroupOutput: {} - elasticcache_PerformSetUserMetadataOutput: {} - elasticcache_PerformStatusOutput: {} - elasticcache_PerformSyncOutput: {} - elasticcache_PerformSyncstatusOutput: {} - elasticcache_PerformUnfreezeOutput: {} - elasticcache_PerformUpdateAuthModeOutput: {} - elasticcache_PerformUpdateBackupPolicyOutput: {} - elasticcache_PerformUpdateInstanceParametersOutput: {} - elasticcache_ValidateCreateDataOutput: - schema: - properties: - elasticcache: - $ref: '#/definitions/ElasticcacheDetails' - type: object - elasticcache_ValidateUpdateDataOutput: - schema: - properties: - elasticcache: - $ref: '#/definitions/ElasticcacheDetails' - type: object - elasticcache_account_CustomizeDeleteOutput: - schema: - properties: - elasticcache_account: - $ref: '#/definitions/ElasticcacheAccountDetails' - type: object - elasticcache_account_FetchCustomizeColumnsOutput: - schema: - properties: - elasticcache_account: - $ref: '#/definitions/ElasticcacheAccountDetails' - type: object - elasticcache_account_GetDetailsClassMetadataOutput: - schema: - properties: - elasticcache_account: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_account_GetDetailsLoginInfoOutput: {} - elasticcache_account_GetDetailsMetadataOutput: - schema: - properties: - elasticcache_account: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_account_GetDetailsStatusOutput: - schema: - properties: - elasticcache_account: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - elasticcache_account_GetPropertyDistinctFieldOutput: {} - elasticcache_account_GetPropertySplitableExportOutput: {} - elasticcache_account_GetPropertySplitableOutput: {} - elasticcache_account_GetPropertyStatisticsOutput: - schema: - properties: - elasticcache_account: - $ref: '#/definitions/StatusStatistic' - type: object - elasticcache_account_GetPropertyTagValuePairsOutput: {} - elasticcache_account_GetPropertyTagValueTreeOutput: {} - elasticcache_account_ListItemFilterOutput: - schema: - properties: - elasticcache_accounts: - items: - $ref: '#/definitions/ElasticcacheAccountDetails' - 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 - elasticcache_account_PerformClassMetadataOutput: {} - elasticcache_account_PerformPurgeSplitableOutput: {} - elasticcache_account_PerformResetPasswordOutput: {} - elasticcache_account_PerformSetClassMetadataOutput: {} - elasticcache_account_PerformSetUserMetadataOutput: {} - elasticcache_account_PerformStatusOutput: {} - elasticcache_account_ValidateCreateDataOutput: - schema: - properties: - elasticcache_account: - $ref: '#/definitions/ElasticcacheAccountDetails' - type: object - elasticcache_account_ValidateUpdateDataOutput: - schema: - properties: - elasticcache_account: - $ref: '#/definitions/ElasticcacheAccountDetails' - type: object - elasticcache_acl_CustomizeDeleteOutput: - schema: - properties: - elasticcache_acl: - $ref: '#/definitions/ElasticcacheAclDetails' - type: object - elasticcache_acl_FetchCustomizeColumnsOutput: - schema: - properties: - elasticcache_acl: - $ref: '#/definitions/ElasticcacheAclDetails' - type: object - elasticcache_acl_GetDetailsClassMetadataOutput: - schema: - properties: - elasticcache_acl: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_acl_GetDetailsMetadataOutput: - schema: - properties: - elasticcache_acl: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_acl_GetDetailsStatusOutput: - schema: - properties: - elasticcache_acl: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - elasticcache_acl_GetPropertyDistinctFieldOutput: {} - elasticcache_acl_GetPropertySplitableExportOutput: {} - elasticcache_acl_GetPropertySplitableOutput: {} - elasticcache_acl_GetPropertyTagValuePairsOutput: {} - elasticcache_acl_GetPropertyTagValueTreeOutput: {} - elasticcache_acl_ListItemFilterOutput: - schema: - properties: - elasticcache_acls: - items: - $ref: '#/definitions/ElasticcacheAclDetails' - 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 - elasticcache_acl_PerformClassMetadataOutput: {} - elasticcache_acl_PerformPurgeSplitableOutput: {} - elasticcache_acl_PerformSetClassMetadataOutput: {} - elasticcache_acl_PerformSetUserMetadataOutput: {} - elasticcache_acl_PerformStatusOutput: {} - elasticcache_acl_ValidateCreateDataOutput: - schema: - properties: - elasticcache_acl: - $ref: '#/definitions/ElasticcacheAclDetails' - type: object - elasticcache_acl_ValidateUpdateDataOutput: - schema: - properties: - elasticcache_acl: - $ref: '#/definitions/ElasticcacheAclDetails' - type: object - elasticcache_backup_CustomizeDeleteOutput: - schema: - properties: - elasticcache_backup: - $ref: '#/definitions/ElasticcacheBackupDetails' - type: object - elasticcache_backup_FetchCustomizeColumnsOutput: - schema: - properties: - elasticcache_backup: - $ref: '#/definitions/ElasticcacheBackupDetails' - type: object - elasticcache_backup_GetDetailsClassMetadataOutput: - schema: - properties: - elasticcache_backup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_backup_GetDetailsMetadataOutput: - schema: - properties: - elasticcache_backup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_backup_GetDetailsStatusOutput: - schema: - properties: - elasticcache_backup: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - elasticcache_backup_GetPropertyDistinctFieldOutput: {} - elasticcache_backup_GetPropertySplitableExportOutput: {} - elasticcache_backup_GetPropertySplitableOutput: {} - elasticcache_backup_GetPropertyStatisticsOutput: - schema: - properties: - elasticcache_backup: - $ref: '#/definitions/StatusStatistic' - type: object - elasticcache_backup_GetPropertyTagValuePairsOutput: {} - elasticcache_backup_GetPropertyTagValueTreeOutput: {} - elasticcache_backup_ListItemFilterOutput: - schema: - properties: - elasticcache_backups: - items: - $ref: '#/definitions/ElasticcacheBackupDetails' - 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 - elasticcache_backup_PerformClassMetadataOutput: {} - elasticcache_backup_PerformPurgeSplitableOutput: {} - elasticcache_backup_PerformRestoreInstanceOutput: {} - elasticcache_backup_PerformSetClassMetadataOutput: {} - elasticcache_backup_PerformSetUserMetadataOutput: {} - elasticcache_backup_PerformStatusOutput: {} - elasticcache_backup_ValidateCreateDataOutput: - schema: - properties: - elasticcache_backup: - $ref: '#/definitions/ElasticcacheBackupDetails' - type: object - elasticcache_backup_ValidateUpdateDataOutput: - schema: - properties: - elasticcache_backup: - $ref: '#/definitions/ElasticcacheBackupDetails' - type: object - elasticcache_parameter_CustomizeDeleteOutput: - schema: - properties: - elasticcache_parameter: - $ref: '#/definitions/ElasticcacheParameterDetails' - type: object - elasticcache_parameter_FetchCustomizeColumnsOutput: - schema: - properties: - elasticcache_parameter: - $ref: '#/definitions/ElasticcacheParameterDetails' - type: object - elasticcache_parameter_GetDetailsClassMetadataOutput: - schema: - properties: - elasticcache_parameter: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_parameter_GetDetailsMetadataOutput: - schema: - properties: - elasticcache_parameter: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_parameter_GetDetailsStatusOutput: - schema: - properties: - elasticcache_parameter: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - elasticcache_parameter_GetPropertyDistinctFieldOutput: {} - elasticcache_parameter_GetPropertySplitableExportOutput: {} - elasticcache_parameter_GetPropertySplitableOutput: {} - elasticcache_parameter_GetPropertyTagValuePairsOutput: {} - elasticcache_parameter_GetPropertyTagValueTreeOutput: {} - elasticcache_parameter_ListItemFilterOutput: - schema: - properties: - elasticcache_parameters: - items: - $ref: '#/definitions/ElasticcacheParameterDetails' - 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 - elasticcache_parameter_PerformClassMetadataOutput: {} - elasticcache_parameter_PerformPurgeSplitableOutput: {} - elasticcache_parameter_PerformSetClassMetadataOutput: {} - elasticcache_parameter_PerformSetUserMetadataOutput: {} - elasticcache_parameter_PerformStatusOutput: {} - elasticcache_parameter_ValidateCreateDataOutput: - schema: - properties: - elasticcache_parameter: - $ref: '#/definitions/ElasticcacheParameterDetails' - type: object - elasticcache_parameter_ValidateUpdateDataOutput: - schema: - properties: - elasticcache_parameter: - $ref: '#/definitions/ElasticcacheParameterDetails' - type: object - elasticcache_sku_CustomizeDeleteOutput: - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/ElasticcacheSkuDetails' - type: object - elasticcache_sku_FetchCustomizeColumnsOutput: - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/ElasticcacheSkuDetails' - type: object - elasticcache_sku_GetDetailsClassMetadataOutput: - schema: - properties: - elasticcache_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_sku_GetDetailsMetadataOutput: - schema: - properties: - elasticcache_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticcache_sku_GetDetailsStatusOutput: - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - elasticcache_sku_GetPropertyCapabilityOutput: {} - elasticcache_sku_GetPropertyDistinctFieldOutput: {} - elasticcache_sku_GetPropertyInstanceSpecsOutput: {} - elasticcache_sku_GetPropertySplitableExportOutput: {} - elasticcache_sku_GetPropertySplitableOutput: {} - elasticcache_sku_GetPropertyStatisticsOutput: - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/StatusStatistic' - type: object - elasticcache_sku_GetPropertySyncTasksOutput: {} - elasticcache_sku_GetPropertyTagValuePairsOutput: {} - elasticcache_sku_GetPropertyTagValueTreeOutput: {} - elasticcache_sku_ListItemFilterOutput: - schema: - properties: - elasticcache_skus: - items: - $ref: '#/definitions/ElasticcacheSkuDetails' - 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 - elasticcache_sku_PerformClassMetadataOutput: {} - elasticcache_sku_PerformPurgeSplitableOutput: {} - elasticcache_sku_PerformSetClassMetadataOutput: {} - elasticcache_sku_PerformSetUserMetadataOutput: {} - elasticcache_sku_PerformStatusOutput: {} - elasticcache_sku_PerformSyncSkusOutput: {} - elasticcache_sku_ValidateCreateDataOutput: - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/ElasticcacheSkuDetails' - type: object - elasticcache_sku_ValidateUpdateDataOutput: - schema: - properties: - elasticcache_sku: - $ref: '#/definitions/ElasticcacheSkuDetails' - type: object - elasticcachesecgroup_CustomizeDeleteOutput: - schema: - properties: - elasticcachesecgroup: - $ref: '#/definitions/ElasticcachesecgroupDetails' - type: object - elasticcachesecgroup_FetchCustomizeColumnsOutput: - schema: - properties: - elasticcachesecgroup: - $ref: '#/definitions/ElasticcachesecgroupDetails' - type: object - elasticcachesecgroup_GetPropertyDistinctFieldOutput: {} - elasticcachesecgroup_GetPropertySplitableExportOutput: {} - elasticcachesecgroup_GetPropertySplitableOutput: {} - elasticcachesecgroup_ListItemFilterOutput: - schema: - properties: - elasticcachesecgroups: - items: - $ref: '#/definitions/ElasticcachesecgroupDetails' - 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 - elasticcachesecgroup_PerformPurgeSplitableOutput: {} - elasticcachesecgroup_ValidateCreateDataOutput: - schema: - properties: - elasticcachesecgroup: - $ref: '#/definitions/ElasticcachesecgroupDetails' - type: object - elasticcachesecgroup_ValidateUpdateDataOutput: - schema: - properties: - elasticcachesecgroup: - $ref: '#/definitions/ElasticcachesecgroupDetails' - type: object - elasticip_CustomizeDeleteOutput: - schema: - properties: - elasticip: - $ref: '#/definitions/ElasticipDetails' - type: object - elasticip_FetchCustomizeColumnsOutput: - schema: - properties: - elasticip: - $ref: '#/definitions/ElasticipDetails' - type: object - elasticip_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - elasticip: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - elasticip_GetDetailsClassMetadataOutput: - schema: - properties: - elasticip: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticip_GetDetailsMetadataOutput: - schema: - properties: - elasticip: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - elasticip_GetDetailsStatusOutput: - schema: - properties: - elasticip: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - elasticip_GetPropertyDistinctFieldOutput: {} - elasticip_GetPropertyDomainStatisticsOutput: - schema: - properties: - elasticip: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - elasticip_GetPropertyProjectStatisticsOutput: - schema: - properties: - elasticip: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - elasticip_GetPropertyProjectTagValuePairsOutput: {} - elasticip_GetPropertyProjectTagValueTreeOutput: {} - elasticip_GetPropertySplitableExportOutput: {} - elasticip_GetPropertySplitableOutput: {} - elasticip_GetPropertyStatisticsOutput: - schema: - properties: - elasticip: - $ref: '#/definitions/StatusStatistic' - type: object - elasticip_GetPropertyTagValuePairsOutput: {} - elasticip_GetPropertyTagValueTreeOutput: {} - elasticip_ListItemFilterOutput: - schema: - properties: - elasticips: - items: - $ref: '#/definitions/ElasticipDetails' - 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 - elasticip_PerformAssociateOutput: - schema: - properties: - elasticip: - $ref: '#/definitions/ElasticipAssociateInput' - type: object - elasticip_PerformCancelDeleteOutput: {} - elasticip_PerformChangeBandwidthOutput: {} - elasticip_PerformChangeOwnerOutput: {} - elasticip_PerformClassMetadataOutput: {} - elasticip_PerformDissociateOutput: {} - elasticip_PerformFreezeOutput: {} - elasticip_PerformPurgeOutput: {} - elasticip_PerformPurgeSplitableOutput: {} - elasticip_PerformSetClassMetadataOutput: {} - elasticip_PerformSetUserMetadataOutput: {} - elasticip_PerformStatusOutput: {} - elasticip_PerformSyncOutput: {} - elasticip_PerformSyncstatusOutput: {} - elasticip_PerformUnfreezeOutput: {} - elasticip_ValidateCreateDataOutput: - schema: - properties: - elasticip: - $ref: '#/definitions/ElasticipDetails' - type: object - elasticip_ValidateUpdateDataOutput: - schema: - properties: - elasticip: - $ref: '#/definitions/ElasticipDetails' - type: object - external_project_CustomizeDeleteOutput: - schema: - properties: - external_project: - $ref: '#/definitions/ExternalProjectDetails' - type: object - external_project_FetchCustomizeColumnsOutput: - schema: - properties: - external_project: - $ref: '#/definitions/ExternalProjectDetails' - type: object - external_project_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - external_project: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - external_project_GetDetailsClassMetadataOutput: - schema: - properties: - external_project: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - external_project_GetDetailsMetadataOutput: - schema: - properties: - external_project: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - external_project_GetDetailsStatusOutput: - schema: - properties: - external_project: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - external_project_GetPropertyDistinctFieldOutput: {} - external_project_GetPropertyDomainStatisticsOutput: - schema: - properties: - external_project: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - external_project_GetPropertyProjectStatisticsOutput: - schema: - properties: - external_project: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - external_project_GetPropertyProjectTagValuePairsOutput: {} - external_project_GetPropertyProjectTagValueTreeOutput: {} - external_project_GetPropertySplitableExportOutput: {} - external_project_GetPropertySplitableOutput: {} - external_project_GetPropertyStatisticsOutput: - schema: - properties: - external_project: - $ref: '#/definitions/StatusStatistic' - type: object - external_project_GetPropertyTagValuePairsOutput: {} - external_project_GetPropertyTagValueTreeOutput: {} - external_project_ListItemFilterOutput: - schema: - properties: - external_projects: - items: - $ref: '#/definitions/ExternalProjectDetails' - 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 - external_project_PerformCancelDeleteOutput: {} - external_project_PerformChangeOwnerOutput: {} - external_project_PerformChangeProjectOutput: {} - external_project_PerformClassMetadataOutput: {} - external_project_PerformFreezeOutput: {} - external_project_PerformPurgeSplitableOutput: {} - external_project_PerformSetClassMetadataOutput: {} - external_project_PerformSetUserMetadataOutput: {} - external_project_PerformStatusOutput: {} - external_project_PerformUnfreezeOutput: {} - external_project_ValidateCreateDataOutput: - schema: - properties: - external_project: - $ref: '#/definitions/ExternalProjectDetails' - type: object - external_project_ValidateUpdateDataOutput: - schema: - properties: - external_project: - $ref: '#/definitions/ExternalProjectDetails' - type: object - file_system_CustomizeDeleteOutput: - schema: - properties: - file_system: - $ref: '#/definitions/FileSystemDetails' - type: object - file_system_FetchCustomizeColumnsOutput: - schema: - properties: - file_system: - $ref: '#/definitions/FileSystemDetails' - type: object - file_system_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - file_system: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - file_system_GetDetailsClassMetadataOutput: - schema: - properties: - file_system: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - file_system_GetDetailsMetadataOutput: - schema: - properties: - file_system: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - file_system_GetDetailsStatusOutput: - schema: - properties: - file_system: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - file_system_GetPropertyDistinctFieldOutput: {} - file_system_GetPropertyDomainTagValuePairsOutput: {} - file_system_GetPropertyDomainTagValueTreeOutput: {} - file_system_GetPropertySplitableExportOutput: {} - file_system_GetPropertySplitableOutput: {} - file_system_GetPropertyStatisticsOutput: - schema: - properties: - file_system: - $ref: '#/definitions/StatusStatistic' - type: object - file_system_GetPropertyTagValuePairsOutput: {} - file_system_GetPropertyTagValueTreeOutput: {} - file_system_ListItemFilterOutput: - schema: - properties: - file_systems: - items: - $ref: '#/definitions/FileSystemDetails' - 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 - file_system_PerformChangeOwnerOutput: {} - file_system_PerformClassMetadataOutput: {} - file_system_PerformPrivateOutput: {} - file_system_PerformPublicOutput: {} - file_system_PerformPurgeSplitableOutput: {} - file_system_PerformRemoteUpdateOutput: {} - file_system_PerformSetClassMetadataOutput: {} - file_system_PerformSetUserMetadataOutput: {} - file_system_PerformStatusOutput: {} - file_system_PerformSyncstatusOutput: {} - file_system_ValidateCreateDataOutput: - schema: - properties: - file_system: - $ref: '#/definitions/FileSystemDetails' - type: object - file_system_ValidateUpdateDataOutput: - schema: - properties: - file_system: - $ref: '#/definitions/FileSystemDetails' - type: object - global_vpc_CustomizeDeleteOutput: - schema: - properties: - global_vpc: - $ref: '#/definitions/GlobalVpcDetails' - type: object - global_vpc_FetchCustomizeColumnsOutput: - schema: - properties: - global_vpc: - $ref: '#/definitions/GlobalVpcDetails' - type: object - global_vpc_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - global_vpc: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - global_vpc_GetDetailsClassMetadataOutput: - schema: - properties: - global_vpc: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - global_vpc_GetDetailsMetadataOutput: - schema: - properties: - global_vpc: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - global_vpc_GetDetailsStatusOutput: - schema: - properties: - global_vpc: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - global_vpc_GetPropertyDistinctFieldOutput: {} - global_vpc_GetPropertyDomainTagValuePairsOutput: {} - global_vpc_GetPropertyDomainTagValueTreeOutput: {} - global_vpc_GetPropertySplitableExportOutput: {} - global_vpc_GetPropertySplitableOutput: {} - global_vpc_GetPropertyStatisticsOutput: - schema: - properties: - global_vpc: - $ref: '#/definitions/StatusStatistic' - type: object - global_vpc_GetPropertyTagValuePairsOutput: {} - global_vpc_GetPropertyTagValueTreeOutput: {} - global_vpc_ListItemFilterOutput: - schema: - properties: - global_vpcs: - items: - $ref: '#/definitions/GlobalVpcDetails' - 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 - global_vpc_PerformChangeOwnerOutput: {} - global_vpc_PerformClassMetadataOutput: {} - global_vpc_PerformDisableOutput: {} - global_vpc_PerformEnableOutput: {} - global_vpc_PerformPrivateOutput: {} - global_vpc_PerformPublicOutput: {} - global_vpc_PerformPurgeSplitableOutput: {} - global_vpc_PerformSetClassMetadataOutput: {} - global_vpc_PerformSetUserMetadataOutput: {} - global_vpc_PerformStatusOutput: {} - global_vpc_PerformSyncstatusOutput: {} - global_vpc_ValidateCreateDataOutput: - schema: - properties: - global_vpc: - $ref: '#/definitions/GlobalVpcDetails' - type: object - global_vpc_ValidateUpdateDataOutput: - schema: - properties: - global_vpc: - $ref: '#/definitions/GlobalVpcDetails' - type: object - group_CustomizeDeleteOutput: - schema: - properties: - group: - $ref: '#/definitions/InstanceGroupDetail' - type: object - group_FetchCustomizeColumnsOutput: - schema: - properties: - group: - $ref: '#/definitions/InstanceGroupDetail' - type: object - group_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - group: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - 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_GetDetailsStatusOutput: - schema: - properties: - group: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - group_GetPropertyDistinctFieldOutput: {} - group_GetPropertyDomainStatisticsOutput: - schema: - properties: - group: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - group_GetPropertyProjectStatisticsOutput: - schema: - properties: - group: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - group_GetPropertyProjectTagValuePairsOutput: {} - group_GetPropertyProjectTagValueTreeOutput: {} - group_GetPropertySplitableExportOutput: {} - group_GetPropertySplitableOutput: {} - group_GetPropertyStatisticsOutput: - schema: - properties: - group: - $ref: '#/definitions/StatusStatistic' - type: object - group_GetPropertyTagValuePairsOutput: {} - group_GetPropertyTagValueTreeOutput: {} - group_ListItemFilterOutput: - schema: - properties: - groups: - items: - $ref: '#/definitions/InstanceGroupDetail' - 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_PerformAssociateEipOutput: {} - group_PerformAttachnetworkOutput: - schema: - properties: - group: - $ref: '#/definitions/SGroup' - type: object - group_PerformBindGuestsOutput: {} - group_PerformCancelDeleteOutput: {} - group_PerformChangeOwnerOutput: {} - group_PerformClassMetadataOutput: {} - group_PerformCreateEipOutput: {} - group_PerformDetachnetworkOutput: - schema: - properties: - group: - $ref: '#/definitions/SGroup' - type: object - group_PerformDisableOutput: {} - group_PerformDissociateEipOutput: {} - group_PerformEnableOutput: {} - group_PerformFreezeOutput: {} - group_PerformPurgeSplitableOutput: {} - group_PerformSetClassMetadataOutput: {} - group_PerformSetUserMetadataOutput: {} - group_PerformStatusOutput: {} - group_PerformUnbindGuestsOutput: {} - group_PerformUnfreezeOutput: {} - group_ValidateCreateDataOutput: - schema: - properties: - group: - $ref: '#/definitions/InstanceGroupDetail' - type: object - group_ValidateUpdateDataOutput: - schema: - properties: - group: - $ref: '#/definitions/InstanceGroupDetail' - type: object - groupguest_CustomizeDeleteOutput: - schema: - properties: - groupguest: - $ref: '#/definitions/GroupguestDetails' - type: object - groupguest_FetchCustomizeColumnsOutput: - schema: - properties: - groupguest: - $ref: '#/definitions/GroupguestDetails' - type: object - groupguest_GetPropertyDistinctFieldOutput: {} - groupguest_GetPropertySplitableExportOutput: {} - groupguest_GetPropertySplitableOutput: {} - groupguest_ListItemFilterOutput: - schema: - properties: - groupguests: - items: - $ref: '#/definitions/GroupguestDetails' - 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 - groupguest_PerformPurgeSplitableOutput: {} - groupguest_ValidateCreateDataOutput: - schema: - properties: - groupguest: - $ref: '#/definitions/GroupguestDetails' - type: object - groupguest_ValidateUpdateDataOutput: - schema: - properties: - groupguest: - $ref: '#/definitions/GroupguestDetails' - type: object - groupnetwork_CustomizeDeleteOutput: - schema: - properties: - groupnetwork: - $ref: '#/definitions/GroupnetworkDetails' - type: object - groupnetwork_FetchCustomizeColumnsOutput: - schema: - properties: - groupnetwork: - $ref: '#/definitions/GroupnetworkDetails' - type: object - groupnetwork_GetPropertyDistinctFieldOutput: {} - groupnetwork_GetPropertySplitableExportOutput: {} - groupnetwork_GetPropertySplitableOutput: {} - groupnetwork_ListItemFilterOutput: - schema: - properties: - groupnetworks: - items: - $ref: '#/definitions/GroupnetworkDetails' - 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 - groupnetwork_PerformPurgeSplitableOutput: {} - groupnetwork_ValidateCreateDataOutput: - schema: - properties: - groupnetwork: - $ref: '#/definitions/GroupnetworkDetails' - type: object - groupnetwork_ValidateUpdateDataOutput: - schema: - properties: - groupnetwork: - $ref: '#/definitions/GroupnetworkDetails' - type: object - guest_template_CustomizeDeleteOutput: - schema: - properties: - guest_template: - $ref: '#/definitions/GuestTemplateDetails' - type: object - guest_template_FetchCustomizeColumnsOutput: - schema: - properties: - guest_template: - $ref: '#/definitions/GuestTemplateDetails' - type: object - guest_template_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - guest_template: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - guest_template_GetDetailsClassMetadataOutput: - schema: - properties: - guest_template: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - guest_template_GetDetailsMetadataOutput: - schema: - properties: - guest_template: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - guest_template_GetDetailsStatusOutput: - schema: - properties: - guest_template: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - guest_template_GetPropertyDistinctFieldOutput: {} - guest_template_GetPropertyDomainStatisticsOutput: - schema: - properties: - guest_template: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - guest_template_GetPropertyProjectStatisticsOutput: - schema: - properties: - guest_template: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - guest_template_GetPropertyProjectTagValuePairsOutput: {} - guest_template_GetPropertyProjectTagValueTreeOutput: {} - guest_template_GetPropertySplitableExportOutput: {} - guest_template_GetPropertySplitableOutput: {} - guest_template_GetPropertyStatisticsOutput: - schema: - properties: - guest_template: - $ref: '#/definitions/StatusStatistic' - type: object - guest_template_GetPropertyTagValuePairsOutput: {} - guest_template_GetPropertyTagValueTreeOutput: {} - guest_template_ListItemFilterOutput: - schema: - properties: - guest_templates: - items: - $ref: '#/definitions/GuestTemplateDetails' - 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 - guest_template_PerformCancelDeleteOutput: {} - guest_template_PerformChangeOwnerOutput: {} - guest_template_PerformClassMetadataOutput: {} - guest_template_PerformFreezeOutput: {} - guest_template_PerformInspectOutput: {} - guest_template_PerformPrivateOutput: {} - guest_template_PerformPublicOutput: {} - guest_template_PerformPurgeSplitableOutput: {} - guest_template_PerformSetClassMetadataOutput: {} - guest_template_PerformSetUserMetadataOutput: {} - guest_template_PerformStatusOutput: {} - guest_template_PerformUnfreezeOutput: {} - guest_template_ValidateCreateDataOutput: - schema: - properties: - guest_template: - $ref: '#/definitions/GuestTemplateDetails' - type: object - guest_template_ValidateUpdateDataOutput: - schema: - properties: - guest_template: - $ref: '#/definitions/GuestTemplateDetails' - type: object - guestdisk_CustomizeDeleteOutput: - schema: - properties: - guestdisk: - $ref: '#/definitions/GuestDiskDetails' - type: object - guestdisk_FetchCustomizeColumnsOutput: - schema: - properties: - guestdisk: - $ref: '#/definitions/GuestDiskDetails' - type: object - guestdisk_GetPropertyDistinctFieldOutput: {} - guestdisk_GetPropertySplitableExportOutput: {} - guestdisk_GetPropertySplitableOutput: {} - guestdisk_ListItemFilterOutput: - schema: - properties: - guestdisks: - items: - $ref: '#/definitions/GuestDiskDetails' - 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 - guestdisk_PerformPurgeSplitableOutput: {} - guestdisk_ValidateCreateDataOutput: - schema: - properties: - guestdisk: - $ref: '#/definitions/GuestDiskDetails' - type: object - guestdisk_ValidateUpdateDataOutput: - schema: - properties: - guestdisk: - $ref: '#/definitions/GuestDiskDetails' - type: object - guestnetwork_CustomizeDeleteOutput: - schema: - properties: - guestnetwork: - $ref: '#/definitions/GuestnetworkDetails' - type: object - guestnetwork_FetchCustomizeColumnsOutput: - schema: - properties: - guestnetwork: - $ref: '#/definitions/GuestnetworkDetails' - type: object - guestnetwork_GetPropertyDistinctFieldOutput: {} - guestnetwork_GetPropertySplitableExportOutput: {} - guestnetwork_GetPropertySplitableOutput: {} - guestnetwork_ListItemFilterOutput: - schema: - properties: - guestnetworks: - items: - $ref: '#/definitions/GuestnetworkDetails' - 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 - guestnetwork_PerformPurgeSplitableOutput: {} - guestnetwork_ValidateCreateDataOutput: - schema: - properties: - guestnetwork: - $ref: '#/definitions/GuestnetworkDetails' - type: object - guestnetwork_ValidateUpdateDataOutput: - schema: - properties: - guestnetwork: - $ref: '#/definitions/GuestnetworkDetails' - type: object - guestsecgroup_CustomizeDeleteOutput: - schema: - properties: - guestsecgroup: - $ref: '#/definitions/GuestsecgroupDetails' - type: object - guestsecgroup_FetchCustomizeColumnsOutput: - schema: - properties: - guestsecgroup: - $ref: '#/definitions/GuestsecgroupDetails' - type: object - guestsecgroup_GetPropertyDistinctFieldOutput: {} - guestsecgroup_GetPropertySplitableExportOutput: {} - guestsecgroup_GetPropertySplitableOutput: {} - guestsecgroup_ListItemFilterOutput: - schema: - properties: - guestsecgroups: - items: - $ref: '#/definitions/GuestsecgroupDetails' - 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 - guestsecgroup_PerformPurgeSplitableOutput: {} - guestsecgroup_ValidateCreateDataOutput: - schema: - properties: - guestsecgroup: - $ref: '#/definitions/GuestsecgroupDetails' - type: object - guestsecgroup_ValidateUpdateDataOutput: - schema: - properties: - guestsecgroup: - $ref: '#/definitions/GuestsecgroupDetails' - type: object - host_CustomizeDeleteOutput: - schema: - properties: - host: - $ref: '#/definitions/HostDetails' - type: object - host_FetchCustomizeColumnsOutput: - schema: - properties: - host: - $ref: '#/definitions/HostDetails' - type: object - host_GetDetailsAppOptionsOutput: {} - host_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - host: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - host_GetDetailsClassMetadataOutput: - schema: - properties: - host: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - host_GetDetailsIpmiOutput: {} - host_GetDetailsJnlpOutput: {} - host_GetDetailsMetadataOutput: - schema: - properties: - host: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - host_GetDetailsSpecOutput: {} - host_GetDetailsStatusOutput: - schema: - properties: - host: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - host_GetDetailsTapConfigOutput: - schema: - properties: - host: - $ref: '#/definitions/SHostTapConfig' - type: object - host_GetDetailsVncOutput: {} - host_GetPropertyBmStartRegisterScriptOutput: {} - host_GetPropertyDistinctFieldOutput: {} - host_GetPropertyDomainTagValuePairsOutput: {} - host_GetPropertyDomainTagValueTreeOutput: {} - host_GetPropertyHostTypeCountOutput: {} - host_GetPropertyK8sMasterNodeIpsOutput: {} - host_GetPropertyNodeCountOutput: {} - host_GetPropertySplitableExportOutput: {} - host_GetPropertySplitableOutput: {} - host_GetPropertyStatisticsOutput: - schema: - properties: - host: - $ref: '#/definitions/StatusStatistic' - type: object - host_GetPropertyTagValuePairsOutput: {} - host_GetPropertyTagValueTreeOutput: {} - host_ListItemFilterOutput: - schema: - properties: - hosts: - items: - $ref: '#/definitions/HostDetails' - 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 - host_PerformAddNetifOutput: {} - host_PerformAutoMigrateOnHostDownOutput: {} - host_PerformCacheImageOutput: {} - host_PerformChangeOwnerOutput: {} - host_PerformClassMetadataOutput: {} - host_PerformConvertHypervisorOutput: {} - host_PerformDisableNetifOutput: {} - host_PerformDisableOutput: {} - host_PerformEjectIsoOutput: {} - host_PerformEnableNetifOutput: {} - host_PerformEnableOutput: {} - host_PerformHostExitMaintenanceOutput: {} - host_PerformHostMaintenanceOutput: {} - host_PerformInitializeOutput: {} - host_PerformInsertIsoOutput: {} - host_PerformIpmiProbeOutput: {} - host_PerformMaintenanceOutput: {} - host_PerformOfflineOutput: {} - host_PerformOnlineOutput: {} - host_PerformPingOutput: {} - host_PerformPrepareOutput: {} - host_PerformPrivateOutput: {} - host_PerformProbeIsolatedDevicesOutput: {} - host_PerformPublicOutput: {} - host_PerformPurgeSplitableOutput: {} - host_PerformRemoveAllNetifsOutput: {} - host_PerformRemoveNetifOutput: {} - host_PerformRenewPrepaidRecycleOutput: {} - host_PerformReserveCpusOutput: {} - host_PerformResetOutput: {} - host_PerformSetClassMetadataOutput: {} - host_PerformSetReservedResourceForIsolatedDeviceOutput: {} - host_PerformSetSchedtagOutput: {} - host_PerformSetUserMetadataOutput: {} - host_PerformStartOutput: {} - host_PerformStatusOutput: {} - host_PerformStopOutput: {} - host_PerformSyncConfigOutput: {} - host_PerformSyncstatusOutput: {} - host_PerformUndoConvertOutput: {} - host_PerformUndoPrepaidRecycleOutput: {} - host_PerformUnmaintenanceOutput: {} - host_PerformUnreserveCpusOutput: {} - host_PerformUpdateStorageOutput: {} - host_ValidateCreateDataOutput: - schema: - properties: - host: - $ref: '#/definitions/HostDetails' - type: object - host_ValidateUpdateDataOutput: - schema: - properties: - host: - $ref: '#/definitions/HostDetails' - type: object - hostnetwork_CustomizeDeleteOutput: - schema: - properties: - hostnetwork: - $ref: '#/definitions/HostnetworkDetails' - type: object - hostnetwork_FetchCustomizeColumnsOutput: - schema: - properties: - hostnetwork: - $ref: '#/definitions/HostnetworkDetails' - type: object - hostnetwork_GetPropertyDistinctFieldOutput: {} - hostnetwork_GetPropertySplitableExportOutput: {} - hostnetwork_GetPropertySplitableOutput: {} - hostnetwork_ListItemFilterOutput: - schema: - properties: - hostnetworks: - items: - $ref: '#/definitions/HostnetworkDetails' - 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 - hostnetwork_PerformPurgeSplitableOutput: {} - hostnetwork_ValidateCreateDataOutput: - schema: - properties: - hostnetwork: - $ref: '#/definitions/HostnetworkDetails' - type: object - hostnetwork_ValidateUpdateDataOutput: - schema: - properties: - hostnetwork: - $ref: '#/definitions/HostnetworkDetails' - type: object - hoststorage_CustomizeDeleteOutput: - schema: - properties: - hoststorage: - $ref: '#/definitions/HoststorageDetails' - type: object - hoststorage_FetchCustomizeColumnsOutput: - schema: - properties: - hoststorage: - $ref: '#/definitions/HoststorageDetails' - type: object - hoststorage_GetPropertyDistinctFieldOutput: {} - hoststorage_GetPropertySplitableExportOutput: {} - hoststorage_GetPropertySplitableOutput: {} - hoststorage_ListItemFilterOutput: - schema: - properties: - hoststorages: - items: - $ref: '#/definitions/HoststorageDetails' - 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 - hoststorage_PerformPurgeSplitableOutput: {} - hoststorage_ValidateCreateDataOutput: - schema: - properties: - hoststorage: - $ref: '#/definitions/HoststorageDetails' - type: object - hoststorage_ValidateUpdateDataOutput: - schema: - properties: - hoststorage: - $ref: '#/definitions/HoststorageDetails' - type: object - hostwire_CustomizeDeleteOutput: - schema: - properties: - hostwire: - $ref: '#/definitions/HostwireDetails' - type: object - hostwire_FetchCustomizeColumnsOutput: - schema: - properties: - hostwire: - $ref: '#/definitions/HostwireDetails' - type: object - hostwire_GetPropertyDistinctFieldOutput: {} - hostwire_GetPropertySplitableExportOutput: {} - hostwire_GetPropertySplitableOutput: {} - hostwire_ListItemFilterOutput: - schema: - properties: - hostwires: - items: - $ref: '#/definitions/HostwireDetails' - 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 - hostwire_PerformPurgeSplitableOutput: {} - hostwire_ValidateCreateDataOutput: - schema: - properties: - hostwire: - $ref: '#/definitions/HostwireDetails' - type: object - hostwire_ValidateUpdateDataOutput: - schema: - properties: - hostwire: - $ref: '#/definitions/HostwireDetails' - type: object - instance_backup_CustomizeDeleteOutput: - schema: - properties: - instance_backup: - $ref: '#/definitions/InstanceBackupDetails' - type: object - instance_backup_FetchCustomizeColumnsOutput: - schema: - properties: - instance_backup: - $ref: '#/definitions/InstanceBackupDetails' - type: object - instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - instance_backup: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - instance_backup_GetDetailsClassMetadataOutput: - schema: - properties: - instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - instance_backup_GetDetailsMetadataOutput: - schema: - properties: - instance_backup: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - instance_backup_GetDetailsStatusOutput: - schema: - properties: - instance_backup: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - instance_backup_GetPropertyDistinctFieldOutput: {} - instance_backup_GetPropertyDomainStatisticsOutput: - schema: - properties: - instance_backup: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - instance_backup_GetPropertyProjectStatisticsOutput: - schema: - properties: - instance_backup: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - instance_backup_GetPropertyProjectTagValuePairsOutput: {} - instance_backup_GetPropertyProjectTagValueTreeOutput: {} - instance_backup_GetPropertySplitableExportOutput: {} - instance_backup_GetPropertySplitableOutput: {} - instance_backup_GetPropertyStatisticsOutput: - schema: - properties: - instance_backup: - $ref: '#/definitions/StatusStatistic' - type: object - instance_backup_GetPropertyTagValuePairsOutput: {} - instance_backup_GetPropertyTagValueTreeOutput: {} - instance_backup_ListItemFilterOutput: - schema: - properties: - instance_backups: - items: - $ref: '#/definitions/InstanceBackupDetails' - 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 - instance_backup_PerformCancelDeleteOutput: {} - instance_backup_PerformChangeOwnerOutput: {} - instance_backup_PerformClassMetadataOutput: {} - instance_backup_PerformFreezeOutput: {} - instance_backup_PerformPackOutput: {} - instance_backup_PerformPurgeSplitableOutput: {} - instance_backup_PerformRecoveryOutput: {} - instance_backup_PerformSetClassMetadataOutput: {} - instance_backup_PerformSetUserMetadataOutput: {} - instance_backup_PerformStatusOutput: {} - instance_backup_PerformSyncstatusOutput: {} - instance_backup_PerformUnfreezeOutput: {} - instance_backup_ValidateCreateDataOutput: - schema: - properties: - instance_backup: - $ref: '#/definitions/InstanceBackupDetails' - type: object - instance_backup_ValidateUpdateDataOutput: - schema: - properties: - instance_backup: - $ref: '#/definitions/InstanceBackupDetails' - type: object - instance_snapshot_CustomizeDeleteOutput: - schema: - properties: - instance_snapshot: - $ref: '#/definitions/InstanceSnapshotDetails' - type: object - instance_snapshot_FetchCustomizeColumnsOutput: - schema: - properties: - instance_snapshot: - $ref: '#/definitions/InstanceSnapshotDetails' - type: object - instance_snapshot_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - instance_snapshot: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - instance_snapshot_GetDetailsClassMetadataOutput: - schema: - properties: - instance_snapshot: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - instance_snapshot_GetDetailsMetadataOutput: - schema: - properties: - instance_snapshot: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - instance_snapshot_GetDetailsStatusOutput: - schema: - properties: - instance_snapshot: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - instance_snapshot_GetPropertyDistinctFieldOutput: {} - instance_snapshot_GetPropertyDomainStatisticsOutput: - schema: - properties: - instance_snapshot: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - instance_snapshot_GetPropertyProjectStatisticsOutput: - schema: - properties: - instance_snapshot: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - instance_snapshot_GetPropertyProjectTagValuePairsOutput: {} - instance_snapshot_GetPropertyProjectTagValueTreeOutput: {} - instance_snapshot_GetPropertySplitableExportOutput: {} - instance_snapshot_GetPropertySplitableOutput: {} - instance_snapshot_GetPropertyStatisticsOutput: - schema: - properties: - instance_snapshot: - $ref: '#/definitions/StatusStatistic' - type: object - instance_snapshot_GetPropertyTagValuePairsOutput: {} - instance_snapshot_GetPropertyTagValueTreeOutput: {} - instance_snapshot_ListItemFilterOutput: - schema: - properties: - instance_snapshots: - items: - $ref: '#/definitions/InstanceSnapshotDetails' - 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 - instance_snapshot_PerformCancelDeleteOutput: {} - instance_snapshot_PerformChangeOwnerOutput: {} - instance_snapshot_PerformClassMetadataOutput: {} - instance_snapshot_PerformFreezeOutput: {} - instance_snapshot_PerformPurgeSplitableOutput: {} - instance_snapshot_PerformSetClassMetadataOutput: {} - instance_snapshot_PerformSetUserMetadataOutput: {} - instance_snapshot_PerformStatusOutput: {} - instance_snapshot_PerformUnfreezeOutput: {} - instance_snapshot_ValidateCreateDataOutput: - schema: - properties: - instance_snapshot: - $ref: '#/definitions/InstanceSnapshotDetails' - type: object - instance_snapshot_ValidateUpdateDataOutput: - schema: - properties: - instance_snapshot: - $ref: '#/definitions/InstanceSnapshotDetails' - type: object - inter_vpc_network_CustomizeDeleteOutput: - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/InterVpcNetworkDetails' - type: object - inter_vpc_network_FetchCustomizeColumnsOutput: - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/InterVpcNetworkDetails' - type: object - inter_vpc_network_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - inter_vpc_network_GetDetailsClassMetadataOutput: - schema: - properties: - inter_vpc_network: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - inter_vpc_network_GetDetailsMetadataOutput: - schema: - properties: - inter_vpc_network: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - inter_vpc_network_GetDetailsStatusOutput: - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - inter_vpc_network_GetPropertyDistinctFieldOutput: {} - inter_vpc_network_GetPropertyDomainTagValuePairsOutput: {} - inter_vpc_network_GetPropertyDomainTagValueTreeOutput: {} - inter_vpc_network_GetPropertySplitableExportOutput: {} - inter_vpc_network_GetPropertySplitableOutput: {} - inter_vpc_network_GetPropertyStatisticsOutput: - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/StatusStatistic' - type: object - inter_vpc_network_GetPropertyTagValuePairsOutput: {} - inter_vpc_network_GetPropertyTagValueTreeOutput: {} - inter_vpc_network_ListItemFilterOutput: - schema: - properties: - inter_vpc_networks: - items: - $ref: '#/definitions/InterVpcNetworkDetails' - 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 - inter_vpc_network_PerformAddvpcOutput: {} - inter_vpc_network_PerformChangeOwnerOutput: {} - inter_vpc_network_PerformClassMetadataOutput: {} - inter_vpc_network_PerformDisableOutput: {} - inter_vpc_network_PerformEnableOutput: {} - inter_vpc_network_PerformPrivateOutput: {} - inter_vpc_network_PerformPublicOutput: {} - inter_vpc_network_PerformPurgeSplitableOutput: {} - inter_vpc_network_PerformRemovevpcOutput: {} - inter_vpc_network_PerformSetClassMetadataOutput: {} - inter_vpc_network_PerformSetUserMetadataOutput: {} - inter_vpc_network_PerformStatusOutput: {} - inter_vpc_network_PerformSyncstatusOutput: {} - inter_vpc_network_ValidateCreateDataOutput: - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/InterVpcNetworkDetails' - type: object - inter_vpc_network_ValidateUpdateDataOutput: - schema: - properties: - inter_vpc_network: - $ref: '#/definitions/InterVpcNetworkDetails' - type: object - inter_vpc_network_route_set_CustomizeDeleteOutput: - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/InterVpcNetworkRouteSetDetails' - type: object - inter_vpc_network_route_set_FetchCustomizeColumnsOutput: - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/InterVpcNetworkRouteSetDetails' - type: object - inter_vpc_network_route_set_GetDetailsClassMetadataOutput: - schema: - properties: - inter_vpc_network_route_set: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - inter_vpc_network_route_set_GetDetailsMetadataOutput: - schema: - properties: - inter_vpc_network_route_set: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - inter_vpc_network_route_set_GetDetailsStatusOutput: - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - inter_vpc_network_route_set_GetPropertyDistinctFieldOutput: {} - inter_vpc_network_route_set_GetPropertySplitableExportOutput: {} - inter_vpc_network_route_set_GetPropertySplitableOutput: {} - inter_vpc_network_route_set_GetPropertyStatisticsOutput: - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/StatusStatistic' - type: object - inter_vpc_network_route_set_GetPropertyTagValuePairsOutput: {} - inter_vpc_network_route_set_GetPropertyTagValueTreeOutput: {} - inter_vpc_network_route_set_ListItemFilterOutput: - schema: - properties: - inter_vpc_network_route_sets: - items: - $ref: '#/definitions/InterVpcNetworkRouteSetDetails' - 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 - inter_vpc_network_route_set_PerformClassMetadataOutput: {} - inter_vpc_network_route_set_PerformDisableOutput: {} - inter_vpc_network_route_set_PerformEnableOutput: {} - inter_vpc_network_route_set_PerformPurgeSplitableOutput: {} - inter_vpc_network_route_set_PerformSetClassMetadataOutput: {} - inter_vpc_network_route_set_PerformSetUserMetadataOutput: {} - inter_vpc_network_route_set_PerformStatusOutput: {} - inter_vpc_network_route_set_ValidateCreateDataOutput: - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/InterVpcNetworkRouteSetDetails' - type: object - inter_vpc_network_route_set_ValidateUpdateDataOutput: - schema: - properties: - inter_vpc_network_route_set: - $ref: '#/definitions/InterVpcNetworkRouteSetDetails' - type: object - inter_vpc_network_vpc_CustomizeDeleteOutput: - schema: - properties: - inter_vpc_network_vpc: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - inter_vpc_network_vpc_FetchCustomizeColumnsOutput: - schema: - properties: - inter_vpc_network_vpc: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - inter_vpc_network_vpc_GetPropertyDistinctFieldOutput: {} - inter_vpc_network_vpc_GetPropertySplitableExportOutput: {} - inter_vpc_network_vpc_GetPropertySplitableOutput: {} - inter_vpc_network_vpc_ListItemFilterOutput: - schema: - properties: - inter_vpc_network_vpcs: - items: - $ref: '#/definitions/JointResourceBaseDetails' - 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 - inter_vpc_network_vpc_PerformPurgeSplitableOutput: {} - inter_vpc_network_vpc_ValidateCreateDataOutput: - schema: - properties: - inter_vpc_network_vpc: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - inter_vpc_network_vpc_ValidateUpdateDataOutput: - schema: - properties: - inter_vpc_network_vpc: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - ipv6_gateway_CustomizeDeleteOutput: - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/IPv6GatewayDetails' - type: object - ipv6_gateway_FetchCustomizeColumnsOutput: - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/IPv6GatewayDetails' - type: object - ipv6_gateway_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - ipv6_gateway_GetDetailsClassMetadataOutput: - schema: - properties: - ipv6_gateway: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - ipv6_gateway_GetDetailsMetadataOutput: - schema: - properties: - ipv6_gateway: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - ipv6_gateway_GetDetailsStatusOutput: - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - ipv6_gateway_GetPropertyDistinctFieldOutput: {} - ipv6_gateway_GetPropertyDomainStatisticsOutput: - schema: - properties: - ipv6_gateway: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - ipv6_gateway_GetPropertyProjectStatisticsOutput: - schema: - properties: - ipv6_gateway: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - ipv6_gateway_GetPropertyProjectTagValuePairsOutput: {} - ipv6_gateway_GetPropertyProjectTagValueTreeOutput: {} - ipv6_gateway_GetPropertySplitableExportOutput: {} - ipv6_gateway_GetPropertySplitableOutput: {} - ipv6_gateway_GetPropertyStatisticsOutput: - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/StatusStatistic' - type: object - ipv6_gateway_GetPropertyTagValuePairsOutput: {} - ipv6_gateway_GetPropertyTagValueTreeOutput: {} - ipv6_gateway_ListItemFilterOutput: - schema: - properties: - ipv6_gateways: - items: - $ref: '#/definitions/IPv6GatewayDetails' - 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 - ipv6_gateway_PerformCancelDeleteOutput: {} - ipv6_gateway_PerformChangeOwnerOutput: {} - ipv6_gateway_PerformClassMetadataOutput: {} - ipv6_gateway_PerformFreezeOutput: {} - ipv6_gateway_PerformPrivateOutput: {} - ipv6_gateway_PerformPublicOutput: {} - ipv6_gateway_PerformPurgeSplitableOutput: {} - ipv6_gateway_PerformSetClassMetadataOutput: {} - ipv6_gateway_PerformSetUserMetadataOutput: {} - ipv6_gateway_PerformStatusOutput: {} - ipv6_gateway_PerformUnfreezeOutput: {} - ipv6_gateway_ValidateCreateDataOutput: - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/IPv6GatewayDetails' - type: object - ipv6_gateway_ValidateUpdateDataOutput: - schema: - properties: - ipv6_gateway: - $ref: '#/definitions/IPv6GatewayDetails' - type: object - isolated_device_CustomizeDeleteOutput: - schema: - properties: - isolated_device: - $ref: '#/definitions/IsolateDeviceDetails' - type: object - isolated_device_FetchCustomizeColumnsOutput: - schema: - properties: - isolated_device: - $ref: '#/definitions/IsolateDeviceDetails' - type: object - isolated_device_GetDetailsClassMetadataOutput: - schema: - properties: - isolated_device: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - isolated_device_GetDetailsMetadataOutput: - schema: - properties: - isolated_device: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - isolated_device_GetPropertyDistinctFieldOutput: {} - isolated_device_GetPropertySplitableExportOutput: {} - isolated_device_GetPropertySplitableOutput: {} - isolated_device_GetPropertyTagValuePairsOutput: {} - isolated_device_GetPropertyTagValueTreeOutput: {} - isolated_device_ListItemFilterOutput: - schema: - properties: - isolated_devices: - items: - $ref: '#/definitions/IsolateDeviceDetails' - 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 - isolated_device_PerformClassMetadataOutput: {} - isolated_device_PerformPurgeOutput: {} - isolated_device_PerformPurgeSplitableOutput: {} - isolated_device_PerformSetClassMetadataOutput: {} - isolated_device_PerformSetUserMetadataOutput: {} - isolated_device_ValidateCreateDataOutput: - schema: - properties: - isolated_device: - $ref: '#/definitions/IsolateDeviceDetails' - type: object - isolated_device_ValidateUpdateDataOutput: - schema: - properties: - isolated_device: - $ref: '#/definitions/IsolateDeviceDetails' - type: object - isolated_device_model_CustomizeDeleteOutput: - schema: - properties: - isolated_device_model: - $ref: '#/definitions/StandaloneAnonResourceDetails' - type: object - isolated_device_model_FetchCustomizeColumnsOutput: - schema: - properties: - isolated_device_model: - $ref: '#/definitions/StandaloneAnonResourceDetails' - type: object - isolated_device_model_GetDetailsClassMetadataOutput: - schema: - properties: - isolated_device_model: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - isolated_device_model_GetDetailsMetadataOutput: - schema: - properties: - isolated_device_model: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - isolated_device_model_GetPropertyDistinctFieldOutput: {} - isolated_device_model_GetPropertySplitableExportOutput: {} - isolated_device_model_GetPropertySplitableOutput: {} - isolated_device_model_GetPropertyTagValuePairsOutput: {} - isolated_device_model_GetPropertyTagValueTreeOutput: {} - isolated_device_model_ListItemFilterOutput: - schema: - properties: - isolated_device_models: - items: - $ref: '#/definitions/StandaloneAnonResourceDetails' - 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 - isolated_device_model_PerformClassMetadataOutput: {} - isolated_device_model_PerformPurgeSplitableOutput: {} - isolated_device_model_PerformSetClassMetadataOutput: {} - isolated_device_model_PerformSetUserMetadataOutput: {} - isolated_device_model_ValidateCreateDataOutput: - schema: - properties: - isolated_device_model: - $ref: '#/definitions/StandaloneAnonResourceDetails' - type: object - isolated_device_model_ValidateUpdateDataOutput: - schema: - properties: - isolated_device_model: - $ref: '#/definitions/StandaloneAnonResourceDetails' - type: object - kafka_CustomizeDeleteOutput: - schema: - properties: - kafka: - $ref: '#/definitions/KafkaDetails' - type: object - kafka_FetchCustomizeColumnsOutput: - schema: - properties: - kafka: - $ref: '#/definitions/KafkaDetails' - type: object - kafka_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - kafka: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - kafka_GetDetailsClassMetadataOutput: - schema: - properties: - kafka: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - kafka_GetDetailsMetadataOutput: - schema: - properties: - kafka: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - kafka_GetDetailsStatusOutput: - schema: - properties: - kafka: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - kafka_GetDetailsTopicsOutput: - schema: - properties: - kafka: - items: - $ref: '#/definitions/SKafkaTopic' - type: array - x-go-name: Output - type: object - kafka_GetPropertyDistinctFieldOutput: {} - kafka_GetPropertyDomainStatisticsOutput: - schema: - properties: - kafka: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - kafka_GetPropertyProjectStatisticsOutput: - schema: - properties: - kafka: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - kafka_GetPropertyProjectTagValuePairsOutput: {} - kafka_GetPropertyProjectTagValueTreeOutput: {} - kafka_GetPropertySplitableExportOutput: {} - kafka_GetPropertySplitableOutput: {} - kafka_GetPropertyStatisticsOutput: - schema: - properties: - kafka: - $ref: '#/definitions/StatusStatistic' - type: object - kafka_GetPropertyTagValuePairsOutput: {} - kafka_GetPropertyTagValueTreeOutput: {} - kafka_ListItemFilterOutput: - schema: - properties: - kafkas: - items: - $ref: '#/definitions/KafkaDetails' - 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 - kafka_PerformCancelDeleteOutput: {} - kafka_PerformChangeOwnerOutput: {} - kafka_PerformClassMetadataOutput: {} - kafka_PerformFreezeOutput: {} - kafka_PerformPurgeSplitableOutput: {} - kafka_PerformSetClassMetadataOutput: {} - kafka_PerformSetUserMetadataOutput: {} - kafka_PerformStatusOutput: {} - kafka_PerformSyncstatusOutput: {} - kafka_PerformUnfreezeOutput: {} - kafka_ValidateCreateDataOutput: - schema: - properties: - kafka: - $ref: '#/definitions/KafkaDetails' - type: object - kafka_ValidateUpdateDataOutput: - schema: - properties: - kafka: - $ref: '#/definitions/KafkaDetails' - type: object - keypair_CustomizeDeleteOutput: - schema: - properties: - keypair: - $ref: '#/definitions/KeypairDetails' - type: object - keypair_FetchCustomizeColumnsOutput: - schema: - properties: - keypair: - $ref: '#/definitions/KeypairDetails' - type: object - keypair_GetDetailsClassMetadataOutput: - schema: - properties: - keypair: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - keypair_GetDetailsMetadataOutput: - schema: - properties: - keypair: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - keypair_GetDetailsPrivatekeyOutput: {} - keypair_GetPropertyDistinctFieldOutput: {} - keypair_GetPropertySplitableExportOutput: {} - keypair_GetPropertySplitableOutput: {} - keypair_GetPropertyTagValuePairsOutput: {} - keypair_GetPropertyTagValueTreeOutput: {} - keypair_ListItemFilterOutput: - schema: - properties: - keypairs: - items: - $ref: '#/definitions/KeypairDetails' - 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 - keypair_PerformClassMetadataOutput: {} - keypair_PerformPurgeSplitableOutput: {} - keypair_PerformSetClassMetadataOutput: {} - keypair_PerformSetUserMetadataOutput: {} - keypair_ValidateCreateDataOutput: - schema: - properties: - keypair: - $ref: '#/definitions/KeypairDetails' - type: object - keypair_ValidateUpdateDataOutput: - schema: - properties: - keypair: - $ref: '#/definitions/KeypairDetails' - type: object - kube_cluster_CustomizeDeleteOutput: - schema: - properties: - kube_cluster: - $ref: '#/definitions/KubeClusterDetails' - type: object - kube_cluster_FetchCustomizeColumnsOutput: - schema: - properties: - kube_cluster: - $ref: '#/definitions/KubeClusterDetails' - type: object - kube_cluster_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - kube_cluster: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - kube_cluster_GetDetailsClassMetadataOutput: - schema: - properties: - kube_cluster: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - kube_cluster_GetDetailsKubeconfigOutput: - schema: - properties: - kube_cluster: - $ref: '#/definitions/SKubeconfig' - type: object - kube_cluster_GetDetailsMetadataOutput: - schema: - properties: - kube_cluster: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - kube_cluster_GetDetailsStatusOutput: - schema: - properties: - kube_cluster: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - kube_cluster_GetPropertyDistinctFieldOutput: {} - kube_cluster_GetPropertyDomainTagValuePairsOutput: {} - kube_cluster_GetPropertyDomainTagValueTreeOutput: {} - kube_cluster_GetPropertySplitableExportOutput: {} - kube_cluster_GetPropertySplitableOutput: {} - kube_cluster_GetPropertyStatisticsOutput: - schema: - properties: - kube_cluster: - $ref: '#/definitions/StatusStatistic' - type: object - kube_cluster_GetPropertyTagValuePairsOutput: {} - kube_cluster_GetPropertyTagValueTreeOutput: {} - kube_cluster_ListItemFilterOutput: - schema: - properties: - kube_clusters: - items: - $ref: '#/definitions/KubeClusterDetails' - 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 - kube_cluster_PerformChangeOwnerOutput: {} - kube_cluster_PerformClassMetadataOutput: {} - kube_cluster_PerformDisableOutput: {} - kube_cluster_PerformEnableOutput: {} - kube_cluster_PerformPrivateOutput: {} - kube_cluster_PerformPublicOutput: {} - kube_cluster_PerformPurgeSplitableOutput: {} - kube_cluster_PerformSetClassMetadataOutput: {} - kube_cluster_PerformSetUserMetadataOutput: {} - kube_cluster_PerformStatusOutput: {} - kube_cluster_PerformSyncstatusOutput: {} - kube_cluster_ValidateCreateDataOutput: - schema: - properties: - kube_cluster: - $ref: '#/definitions/KubeClusterDetails' - type: object - kube_cluster_ValidateUpdateDataOutput: - schema: - properties: - kube_cluster: - $ref: '#/definitions/KubeClusterDetails' - type: object - kube_node_CustomizeDeleteOutput: - schema: - properties: - kube_node: - $ref: '#/definitions/KubeNodeDetails' - type: object - kube_node_FetchCustomizeColumnsOutput: - schema: - properties: - kube_node: - $ref: '#/definitions/KubeNodeDetails' - type: object - kube_node_GetDetailsClassMetadataOutput: - schema: - properties: - kube_node: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - kube_node_GetDetailsMetadataOutput: - schema: - properties: - kube_node: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - kube_node_GetDetailsStatusOutput: - schema: - properties: - kube_node: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - kube_node_GetPropertyDistinctFieldOutput: {} - kube_node_GetPropertySplitableExportOutput: {} - kube_node_GetPropertySplitableOutput: {} - kube_node_GetPropertyStatisticsOutput: - schema: - properties: - kube_node: - $ref: '#/definitions/StatusStatistic' - type: object - kube_node_GetPropertyTagValuePairsOutput: {} - kube_node_GetPropertyTagValueTreeOutput: {} - kube_node_ListItemFilterOutput: - schema: - properties: - kube_nodes: - items: - $ref: '#/definitions/KubeNodeDetails' - 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 - kube_node_PerformClassMetadataOutput: {} - kube_node_PerformPurgeSplitableOutput: {} - kube_node_PerformSetClassMetadataOutput: {} - kube_node_PerformSetUserMetadataOutput: {} - kube_node_PerformStatusOutput: {} - kube_node_ValidateCreateDataOutput: - schema: - properties: - kube_node: - $ref: '#/definitions/KubeNodeDetails' - type: object - kube_node_ValidateUpdateDataOutput: - schema: - properties: - kube_node: - $ref: '#/definitions/KubeNodeDetails' - type: object - kube_node_pool_CustomizeDeleteOutput: - schema: - properties: - kube_node_pool: - $ref: '#/definitions/KubeNodePoolDetails' - type: object - kube_node_pool_FetchCustomizeColumnsOutput: - schema: - properties: - kube_node_pool: - $ref: '#/definitions/KubeNodePoolDetails' - type: object - kube_node_pool_GetDetailsClassMetadataOutput: - schema: - properties: - kube_node_pool: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - kube_node_pool_GetDetailsMetadataOutput: - schema: - properties: - kube_node_pool: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - kube_node_pool_GetDetailsStatusOutput: - schema: - properties: - kube_node_pool: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - kube_node_pool_GetPropertyDistinctFieldOutput: {} - kube_node_pool_GetPropertySplitableExportOutput: {} - kube_node_pool_GetPropertySplitableOutput: {} - kube_node_pool_GetPropertyStatisticsOutput: - schema: - properties: - kube_node_pool: - $ref: '#/definitions/StatusStatistic' - type: object - kube_node_pool_GetPropertyTagValuePairsOutput: {} - kube_node_pool_GetPropertyTagValueTreeOutput: {} - kube_node_pool_ListItemFilterOutput: - schema: - properties: - kube_node_pools: - items: - $ref: '#/definitions/KubeNodePoolDetails' - 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 - kube_node_pool_PerformClassMetadataOutput: {} - kube_node_pool_PerformPurgeSplitableOutput: {} - kube_node_pool_PerformSetClassMetadataOutput: {} - kube_node_pool_PerformSetUserMetadataOutput: {} - kube_node_pool_PerformStatusOutput: {} - kube_node_pool_PerformSyncstatusOutput: {} - kube_node_pool_ValidateCreateDataOutput: - schema: - properties: - kube_node_pool: - $ref: '#/definitions/KubeNodePoolDetails' - type: object - kube_node_pool_ValidateUpdateDataOutput: - schema: - properties: - kube_node_pool: - $ref: '#/definitions/KubeNodePoolDetails' - type: object - loadbalancer_CustomizeDeleteOutput: - schema: - properties: - loadbalancer: - $ref: '#/definitions/LoadbalancerDetails' - type: object - loadbalancer_FetchCustomizeColumnsOutput: - schema: - properties: - loadbalancer: - $ref: '#/definitions/LoadbalancerDetails' - type: object - loadbalancer_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - loadbalancer: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - loadbalancer_GetDetailsClassMetadataOutput: - schema: - properties: - loadbalancer: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_GetDetailsMetadataOutput: - schema: - properties: - loadbalancer: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_GetDetailsStatusOutput: - schema: - properties: - loadbalancer: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - loadbalancer_GetPropertyDistinctFieldOutput: {} - loadbalancer_GetPropertyDomainStatisticsOutput: - schema: - properties: - loadbalancer: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - loadbalancer_GetPropertyProjectStatisticsOutput: - schema: - properties: - loadbalancer: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - loadbalancer_GetPropertyProjectTagValuePairsOutput: {} - loadbalancer_GetPropertyProjectTagValueTreeOutput: {} - loadbalancer_GetPropertySplitableExportOutput: {} - loadbalancer_GetPropertySplitableOutput: {} - loadbalancer_GetPropertyStatisticsOutput: - schema: - properties: - loadbalancer: - $ref: '#/definitions/StatusStatistic' - type: object - loadbalancer_GetPropertyTagValuePairsOutput: {} - loadbalancer_GetPropertyTagValueTreeOutput: {} - loadbalancer_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - loadbalancers: - items: - $ref: '#/definitions/LoadbalancerDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - loadbalancer_PerformAssociateEipOutput: {} - loadbalancer_PerformCancelDeleteOutput: {} - loadbalancer_PerformChangeOwnerOutput: {} - loadbalancer_PerformClassMetadataOutput: {} - loadbalancer_PerformCreateEipOutput: {} - loadbalancer_PerformDissociateEipOutput: {} - loadbalancer_PerformFreezeOutput: {} - loadbalancer_PerformPurgeOutput: {} - loadbalancer_PerformPurgeSplitableOutput: {} - loadbalancer_PerformRemoteUpdateOutput: {} - loadbalancer_PerformSetClassMetadataOutput: {} - loadbalancer_PerformSetUserMetadataOutput: {} - loadbalancer_PerformStatusOutput: {} - loadbalancer_PerformSyncstatusOutput: {} - loadbalancer_PerformUnfreezeOutput: {} - loadbalancer_ValidateCreateDataOutput: - schema: - properties: - loadbalancer: - $ref: '#/definitions/LoadbalancerDetails' - type: object - loadbalancer_ValidateUpdateDataOutput: - schema: - properties: - loadbalancer: - $ref: '#/definitions/LoadbalancerDetails' - type: object - loadbalancer_acl_CustomizeDeleteOutput: - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/LoadbalancerAclDetails' - type: object - loadbalancer_acl_FetchCustomizeColumnsOutput: - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/LoadbalancerAclDetails' - type: object - loadbalancer_acl_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - loadbalancer_acl_GetDetailsClassMetadataOutput: - schema: - properties: - loadbalancer_acl: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_acl_GetDetailsMetadataOutput: - schema: - properties: - loadbalancer_acl: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_acl_GetDetailsStatusOutput: - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - loadbalancer_acl_GetPropertyDistinctFieldOutput: {} - loadbalancer_acl_GetPropertyDomainStatisticsOutput: - schema: - properties: - loadbalancer_acl: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - loadbalancer_acl_GetPropertyProjectStatisticsOutput: - schema: - properties: - loadbalancer_acl: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - loadbalancer_acl_GetPropertyProjectTagValuePairsOutput: {} - loadbalancer_acl_GetPropertyProjectTagValueTreeOutput: {} - loadbalancer_acl_GetPropertySplitableExportOutput: {} - loadbalancer_acl_GetPropertySplitableOutput: {} - loadbalancer_acl_GetPropertyStatisticsOutput: - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/StatusStatistic' - type: object - loadbalancer_acl_GetPropertyTagValuePairsOutput: {} - loadbalancer_acl_GetPropertyTagValueTreeOutput: {} - loadbalancer_acl_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - loadbalancer_acls: - items: - $ref: '#/definitions/LoadbalancerAclDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - loadbalancer_acl_PerformCancelDeleteOutput: {} - loadbalancer_acl_PerformChangeOwnerOutput: {} - loadbalancer_acl_PerformClassMetadataOutput: {} - loadbalancer_acl_PerformFreezeOutput: {} - loadbalancer_acl_PerformPatchOutput: {} - loadbalancer_acl_PerformPrivateOutput: {} - loadbalancer_acl_PerformPublicOutput: {} - loadbalancer_acl_PerformPurgeOutput: {} - loadbalancer_acl_PerformPurgeSplitableOutput: {} - loadbalancer_acl_PerformSetClassMetadataOutput: {} - loadbalancer_acl_PerformSetUserMetadataOutput: {} - loadbalancer_acl_PerformStatusOutput: {} - loadbalancer_acl_PerformUnfreezeOutput: {} - loadbalancer_acl_ValidateCreateDataOutput: - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/LoadbalancerAclDetails' - type: object - loadbalancer_acl_ValidateUpdateDataOutput: - schema: - properties: - loadbalancer_acl: - $ref: '#/definitions/LoadbalancerAclDetails' - type: object - loadbalancer_agent_CustomizeDeleteOutput: - schema: - properties: - loadbalancer_agent: - $ref: '#/definitions/LoadbalancerAgentDetails' - type: object - loadbalancer_agent_FetchCustomizeColumnsOutput: - schema: - properties: - loadbalancer_agent: - $ref: '#/definitions/LoadbalancerAgentDetails' - type: object - loadbalancer_agent_GetDetailsClassMetadataOutput: - schema: - properties: - loadbalancer_agent: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_agent_GetDetailsMetadataOutput: - schema: - properties: - loadbalancer_agent: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_agent_GetPropertyDefaultParamsOutput: {} - loadbalancer_agent_GetPropertyDistinctFieldOutput: {} - loadbalancer_agent_GetPropertySplitableExportOutput: {} - loadbalancer_agent_GetPropertySplitableOutput: {} - loadbalancer_agent_GetPropertyTagValuePairsOutput: {} - loadbalancer_agent_GetPropertyTagValueTreeOutput: {} - loadbalancer_agent_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - loadbalancer_agents: - items: - $ref: '#/definitions/LoadbalancerAgentDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - loadbalancer_agent_PerformClassMetadataOutput: {} - loadbalancer_agent_PerformDeployOutput: - schema: - properties: - loadbalancer_agent: - $ref: '#/definitions/LoadbalancerAgentDeployInput' - type: object - loadbalancer_agent_PerformHbOutput: {} - loadbalancer_agent_PerformJoinClusterOutput: {} - loadbalancer_agent_PerformLeaveClusterOutput: {} - loadbalancer_agent_PerformParamsPatchOutput: {} - loadbalancer_agent_PerformPurgeSplitableOutput: {} - loadbalancer_agent_PerformSetClassMetadataOutput: {} - loadbalancer_agent_PerformSetUserMetadataOutput: {} - loadbalancer_agent_PerformUndeployOutput: {} - loadbalancer_agent_ValidateCreateDataOutput: - schema: - properties: - loadbalancer_agent: - $ref: '#/definitions/LoadbalancerAgentDetails' - type: object - loadbalancer_agent_ValidateUpdateDataOutput: - schema: - properties: - loadbalancer_agent: - $ref: '#/definitions/LoadbalancerAgentDetails' - type: object - loadbalancer_backend_CustomizeDeleteOutput: - schema: - properties: - loadbalancer_backend: - $ref: '#/definitions/LoadbalancerBackendDetails' - type: object - loadbalancer_backend_FetchCustomizeColumnsOutput: - schema: - properties: - loadbalancer_backend: - $ref: '#/definitions/LoadbalancerBackendDetails' - type: object - loadbalancer_backend_GetDetailsClassMetadataOutput: - schema: - properties: - loadbalancer_backend: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_backend_GetDetailsMetadataOutput: - schema: - properties: - loadbalancer_backend: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_backend_GetDetailsStatusOutput: - schema: - properties: - loadbalancer_backend: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - loadbalancer_backend_GetPropertyDistinctFieldOutput: {} - loadbalancer_backend_GetPropertySplitableExportOutput: {} - loadbalancer_backend_GetPropertySplitableOutput: {} - loadbalancer_backend_GetPropertyStatisticsOutput: - schema: - properties: - loadbalancer_backend: - $ref: '#/definitions/StatusStatistic' - type: object - loadbalancer_backend_GetPropertyTagValuePairsOutput: {} - loadbalancer_backend_GetPropertyTagValueTreeOutput: {} - loadbalancer_backend_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - loadbalancer_backends: - items: - $ref: '#/definitions/LoadbalancerBackendDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - loadbalancer_backend_PerformClassMetadataOutput: {} - loadbalancer_backend_PerformPurgeOutput: {} - loadbalancer_backend_PerformPurgeSplitableOutput: {} - loadbalancer_backend_PerformSetClassMetadataOutput: {} - loadbalancer_backend_PerformSetUserMetadataOutput: {} - loadbalancer_backend_PerformStatusOutput: {} - loadbalancer_backend_ValidateCreateDataOutput: - schema: - properties: - loadbalancer_backend: - $ref: '#/definitions/LoadbalancerBackendDetails' - type: object - loadbalancer_backend_ValidateUpdateDataOutput: - schema: - properties: - loadbalancer_backend: - $ref: '#/definitions/LoadbalancerBackendDetails' - type: object - loadbalancer_backend_group_CustomizeDeleteOutput: - schema: - properties: - loadbalancer_backend_group: - $ref: '#/definitions/LoadbalancerBackendGroupDetails' - type: object - loadbalancer_backend_group_FetchCustomizeColumnsOutput: - schema: - properties: - loadbalancer_backend_group: - $ref: '#/definitions/LoadbalancerBackendGroupDetails' - type: object - loadbalancer_backend_group_GetDetailsClassMetadataOutput: - schema: - properties: - loadbalancer_backend_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_backend_group_GetDetailsMetadataOutput: - schema: - properties: - loadbalancer_backend_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_backend_group_GetDetailsStatusOutput: - schema: - properties: - loadbalancer_backend_group: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - loadbalancer_backend_group_GetPropertyDistinctFieldOutput: {} - loadbalancer_backend_group_GetPropertySplitableExportOutput: {} - loadbalancer_backend_group_GetPropertySplitableOutput: {} - loadbalancer_backend_group_GetPropertyStatisticsOutput: - schema: - properties: - loadbalancer_backend_group: - $ref: '#/definitions/StatusStatistic' - type: object - loadbalancer_backend_group_GetPropertyTagValuePairsOutput: {} - loadbalancer_backend_group_GetPropertyTagValueTreeOutput: {} - loadbalancer_backend_group_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - loadbalancer_backend_groups: - items: - $ref: '#/definitions/LoadbalancerBackendGroupDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - loadbalancer_backend_group_PerformClassMetadataOutput: {} - loadbalancer_backend_group_PerformPurgeOutput: {} - loadbalancer_backend_group_PerformPurgeSplitableOutput: {} - loadbalancer_backend_group_PerformSetClassMetadataOutput: {} - loadbalancer_backend_group_PerformSetUserMetadataOutput: {} - loadbalancer_backend_group_PerformStatusOutput: {} - loadbalancer_backend_group_ValidateCreateDataOutput: - schema: - properties: - loadbalancer_backend_group: - $ref: '#/definitions/LoadbalancerBackendGroupDetails' - type: object - loadbalancer_backend_group_ValidateUpdateDataOutput: - schema: - properties: - loadbalancer_backend_group: - $ref: '#/definitions/LoadbalancerBackendGroupDetails' - type: object - loadbalancer_certificate_CustomizeDeleteOutput: - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/LoadbalancerCertificateDetails' - type: object - loadbalancer_certificate_FetchCustomizeColumnsOutput: - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/LoadbalancerCertificateDetails' - type: object - loadbalancer_certificate_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - loadbalancer_certificate_GetDetailsClassMetadataOutput: - schema: - properties: - loadbalancer_certificate: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_certificate_GetDetailsMetadataOutput: - schema: - properties: - loadbalancer_certificate: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_certificate_GetDetailsStatusOutput: - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - loadbalancer_certificate_GetPropertyDistinctFieldOutput: {} - loadbalancer_certificate_GetPropertyDomainStatisticsOutput: - schema: - properties: - loadbalancer_certificate: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - loadbalancer_certificate_GetPropertyProjectStatisticsOutput: - schema: - properties: - loadbalancer_certificate: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - loadbalancer_certificate_GetPropertyProjectTagValuePairsOutput: {} - loadbalancer_certificate_GetPropertyProjectTagValueTreeOutput: {} - loadbalancer_certificate_GetPropertySplitableExportOutput: {} - loadbalancer_certificate_GetPropertySplitableOutput: {} - loadbalancer_certificate_GetPropertyStatisticsOutput: - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/StatusStatistic' - type: object - loadbalancer_certificate_GetPropertyTagValuePairsOutput: {} - loadbalancer_certificate_GetPropertyTagValueTreeOutput: {} - loadbalancer_certificate_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - loadbalancer_certificates: - items: - $ref: '#/definitions/LoadbalancerCertificateDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - loadbalancer_certificate_PerformCancelDeleteOutput: {} - loadbalancer_certificate_PerformChangeOwnerOutput: {} - loadbalancer_certificate_PerformClassMetadataOutput: {} - loadbalancer_certificate_PerformFreezeOutput: {} - loadbalancer_certificate_PerformPrivateOutput: {} - loadbalancer_certificate_PerformPublicOutput: {} - loadbalancer_certificate_PerformPurgeSplitableOutput: {} - loadbalancer_certificate_PerformSetClassMetadataOutput: {} - loadbalancer_certificate_PerformSetUserMetadataOutput: {} - loadbalancer_certificate_PerformStatusOutput: {} - loadbalancer_certificate_PerformUnfreezeOutput: {} - loadbalancer_certificate_ValidateCreateDataOutput: - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/LoadbalancerCertificateDetails' - type: object - loadbalancer_certificate_ValidateUpdateDataOutput: - schema: - properties: - loadbalancer_certificate: - $ref: '#/definitions/LoadbalancerCertificateDetails' - type: object - loadbalancer_cluster_CustomizeDeleteOutput: - schema: - properties: - loadbalancer_cluster: - $ref: '#/definitions/LoadbalancerClusterDetails' - type: object - loadbalancer_cluster_FetchCustomizeColumnsOutput: - schema: - properties: - loadbalancer_cluster: - $ref: '#/definitions/LoadbalancerClusterDetails' - type: object - loadbalancer_cluster_GetDetailsClassMetadataOutput: - schema: - properties: - loadbalancer_cluster: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_cluster_GetDetailsMetadataOutput: - schema: - properties: - loadbalancer_cluster: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_cluster_GetPropertyDistinctFieldOutput: {} - loadbalancer_cluster_GetPropertySplitableExportOutput: {} - loadbalancer_cluster_GetPropertySplitableOutput: {} - loadbalancer_cluster_GetPropertyTagValuePairsOutput: {} - loadbalancer_cluster_GetPropertyTagValueTreeOutput: {} - loadbalancer_cluster_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - loadbalancer_clusters: - items: - $ref: '#/definitions/LoadbalancerClusterDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - loadbalancer_cluster_PerformClassMetadataOutput: {} - loadbalancer_cluster_PerformParamsPatchOutput: {} - loadbalancer_cluster_PerformPurgeSplitableOutput: {} - loadbalancer_cluster_PerformSetClassMetadataOutput: {} - loadbalancer_cluster_PerformSetUserMetadataOutput: {} - loadbalancer_cluster_ValidateCreateDataOutput: - schema: - properties: - loadbalancer_cluster: - $ref: '#/definitions/LoadbalancerClusterDetails' - type: object - loadbalancer_cluster_ValidateUpdateDataOutput: - schema: - properties: - loadbalancer_cluster: - $ref: '#/definitions/LoadbalancerClusterDetails' - type: object - loadbalancer_listener_CustomizeDeleteOutput: - schema: - properties: - loadbalancer_listener: - $ref: '#/definitions/LoadbalancerListenerDetails' - type: object - loadbalancer_listener_FetchCustomizeColumnsOutput: - schema: - properties: - loadbalancer_listener: - $ref: '#/definitions/LoadbalancerListenerDetails' - type: object - loadbalancer_listener_GetDetailsBackendStatusOutput: {} - loadbalancer_listener_GetDetailsClassMetadataOutput: - schema: - properties: - loadbalancer_listener: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_listener_GetDetailsMetadataOutput: - schema: - properties: - loadbalancer_listener: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_listener_GetDetailsStatusOutput: - schema: - properties: - loadbalancer_listener: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - loadbalancer_listener_GetPropertyDistinctFieldOutput: {} - loadbalancer_listener_GetPropertySplitableExportOutput: {} - loadbalancer_listener_GetPropertySplitableOutput: {} - loadbalancer_listener_GetPropertyStatisticsOutput: - schema: - properties: - loadbalancer_listener: - $ref: '#/definitions/StatusStatistic' - type: object - loadbalancer_listener_GetPropertyTagValuePairsOutput: {} - loadbalancer_listener_GetPropertyTagValueTreeOutput: {} - loadbalancer_listener_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - loadbalancer_listeners: - items: - $ref: '#/definitions/LoadbalancerListenerDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - loadbalancer_listener_PerformClassMetadataOutput: {} - loadbalancer_listener_PerformPurgeOutput: {} - loadbalancer_listener_PerformPurgeSplitableOutput: {} - loadbalancer_listener_PerformSetClassMetadataOutput: {} - loadbalancer_listener_PerformSetUserMetadataOutput: {} - loadbalancer_listener_PerformStatusOutput: {} - loadbalancer_listener_PerformSyncOutput: {} - loadbalancer_listener_PerformSyncstatusOutput: {} - loadbalancer_listener_ValidateCreateDataOutput: - schema: - properties: - loadbalancer_listener: - $ref: '#/definitions/LoadbalancerListenerDetails' - type: object - loadbalancer_listener_ValidateUpdateDataOutput: - schema: - properties: - loadbalancer_listener: - $ref: '#/definitions/LoadbalancerListenerDetails' - type: object - loadbalancer_listener_rule_CustomizeDeleteOutput: - schema: - properties: - loadbalancer_listener_rule: - $ref: '#/definitions/LoadbalancerListenerRuleDetails' - type: object - loadbalancer_listener_rule_FetchCustomizeColumnsOutput: - schema: - properties: - loadbalancer_listener_rule: - $ref: '#/definitions/LoadbalancerListenerRuleDetails' - type: object - loadbalancer_listener_rule_GetDetailsBackendStatusOutput: {} - loadbalancer_listener_rule_GetDetailsClassMetadataOutput: - schema: - properties: - loadbalancer_listener_rule: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_listener_rule_GetDetailsMetadataOutput: - schema: - properties: - loadbalancer_listener_rule: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - loadbalancer_listener_rule_GetDetailsStatusOutput: - schema: - properties: - loadbalancer_listener_rule: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - loadbalancer_listener_rule_GetPropertyDistinctFieldOutput: {} - loadbalancer_listener_rule_GetPropertySplitableExportOutput: {} - loadbalancer_listener_rule_GetPropertySplitableOutput: {} - loadbalancer_listener_rule_GetPropertyStatisticsOutput: - schema: - properties: - loadbalancer_listener_rule: - $ref: '#/definitions/StatusStatistic' - type: object - loadbalancer_listener_rule_GetPropertyTagValuePairsOutput: {} - loadbalancer_listener_rule_GetPropertyTagValueTreeOutput: {} - loadbalancer_listener_rule_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - loadbalancer_listener_rules: - items: - $ref: '#/definitions/LoadbalancerListenerRuleDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - loadbalancer_listener_rule_PerformClassMetadataOutput: {} - loadbalancer_listener_rule_PerformPurgeOutput: {} - loadbalancer_listener_rule_PerformPurgeSplitableOutput: {} - loadbalancer_listener_rule_PerformSetClassMetadataOutput: {} - loadbalancer_listener_rule_PerformSetUserMetadataOutput: {} - loadbalancer_listener_rule_PerformStatusOutput: {} - loadbalancer_listener_rule_ValidateCreateDataOutput: - schema: - properties: - loadbalancer_listener_rule: - $ref: '#/definitions/LoadbalancerListenerRuleDetails' - type: object - loadbalancer_listener_rule_ValidateUpdateDataOutput: - schema: - properties: - loadbalancer_listener_rule: - $ref: '#/definitions/LoadbalancerListenerRuleDetails' - type: object - misc_resource_CustomizeDeleteOutput: - schema: - properties: - misc_resource: - $ref: '#/definitions/MiscResourceDetails' - type: object - misc_resource_FetchCustomizeColumnsOutput: - schema: - properties: - misc_resource: - $ref: '#/definitions/MiscResourceDetails' - type: object - misc_resource_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - misc_resource: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - misc_resource_GetDetailsClassMetadataOutput: - schema: - properties: - misc_resource: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - misc_resource_GetDetailsMetadataOutput: - schema: - properties: - misc_resource: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - misc_resource_GetDetailsStatusOutput: - schema: - properties: - misc_resource: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - misc_resource_GetPropertyDistinctFieldOutput: {} - misc_resource_GetPropertyDomainStatisticsOutput: - schema: - properties: - misc_resource: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - misc_resource_GetPropertyProjectStatisticsOutput: - schema: - properties: - misc_resource: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - misc_resource_GetPropertyProjectTagValuePairsOutput: {} - misc_resource_GetPropertyProjectTagValueTreeOutput: {} - misc_resource_GetPropertySplitableExportOutput: {} - misc_resource_GetPropertySplitableOutput: {} - misc_resource_GetPropertyStatisticsOutput: - schema: - properties: - misc_resource: - $ref: '#/definitions/StatusStatistic' - type: object - misc_resource_GetPropertyTagValuePairsOutput: {} - misc_resource_GetPropertyTagValueTreeOutput: {} - misc_resource_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - misc_resources: - items: - $ref: '#/definitions/MiscResourceDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - misc_resource_PerformCancelDeleteOutput: {} - misc_resource_PerformChangeOwnerOutput: {} - misc_resource_PerformClassMetadataOutput: {} - misc_resource_PerformFreezeOutput: {} - misc_resource_PerformPurgeSplitableOutput: {} - misc_resource_PerformSetClassMetadataOutput: {} - misc_resource_PerformSetUserMetadataOutput: {} - misc_resource_PerformStatusOutput: {} - misc_resource_PerformUnfreezeOutput: {} - misc_resource_ValidateCreateDataOutput: - schema: - properties: - misc_resource: - $ref: '#/definitions/MiscResourceDetails' - type: object - misc_resource_ValidateUpdateDataOutput: - schema: - properties: - misc_resource: - $ref: '#/definitions/MiscResourceDetails' - type: object - modelarts_pool_CustomizeDeleteOutput: - schema: - properties: - modelarts_pool: - $ref: '#/definitions/ModelartsPoolDetails' - type: object - modelarts_pool_FetchCustomizeColumnsOutput: - schema: - properties: - modelarts_pool: - $ref: '#/definitions/ModelartsPoolDetails' - type: object - modelarts_pool_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - modelarts_pool: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - modelarts_pool_GetDetailsClassMetadataOutput: - schema: - properties: - modelarts_pool: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - modelarts_pool_GetDetailsMetadataOutput: - schema: - properties: - modelarts_pool: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - modelarts_pool_GetDetailsStatusOutput: - schema: - properties: - modelarts_pool: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - modelarts_pool_GetPropertyDistinctFieldOutput: {} - modelarts_pool_GetPropertyDomainStatisticsOutput: - schema: - properties: - modelarts_pool: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - modelarts_pool_GetPropertyProjectStatisticsOutput: - schema: - properties: - modelarts_pool: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - modelarts_pool_GetPropertyProjectTagValuePairsOutput: {} - modelarts_pool_GetPropertyProjectTagValueTreeOutput: {} - modelarts_pool_GetPropertySplitableExportOutput: {} - modelarts_pool_GetPropertySplitableOutput: {} - modelarts_pool_GetPropertyStatisticsOutput: - schema: - properties: - modelarts_pool: - $ref: '#/definitions/StatusStatistic' - type: object - modelarts_pool_GetPropertyTagValuePairsOutput: {} - modelarts_pool_GetPropertyTagValueTreeOutput: {} - modelarts_pool_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - modelarts_pools: - items: - $ref: '#/definitions/ModelartsPoolDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - modelarts_pool_PerformCancelDeleteOutput: {} - modelarts_pool_PerformChangeConfigOutput: {} - modelarts_pool_PerformChangeOwnerOutput: {} - modelarts_pool_PerformClassMetadataOutput: {} - modelarts_pool_PerformFreezeOutput: {} - modelarts_pool_PerformPurgeSplitableOutput: {} - modelarts_pool_PerformSetClassMetadataOutput: {} - modelarts_pool_PerformSetUserMetadataOutput: {} - modelarts_pool_PerformStatusOutput: {} - modelarts_pool_PerformSyncstatusOutput: {} - modelarts_pool_PerformUnfreezeOutput: {} - modelarts_pool_ValidateCreateDataOutput: - schema: - properties: - modelarts_pool: - $ref: '#/definitions/ModelartsPoolDetails' - type: object - modelarts_pool_ValidateUpdateDataOutput: - schema: - properties: - modelarts_pool: - $ref: '#/definitions/ModelartsPoolDetails' - type: object - modelarts_pool_sku_CustomizeDeleteOutput: - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/ModelartsPoolSkuDetails' - type: object - modelarts_pool_sku_FetchCustomizeColumnsOutput: - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/ModelartsPoolSkuDetails' - type: object - modelarts_pool_sku_GetDetailsClassMetadataOutput: - schema: - properties: - modelarts_pool_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - modelarts_pool_sku_GetDetailsMetadataOutput: - schema: - properties: - modelarts_pool_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - modelarts_pool_sku_GetDetailsStatusOutput: - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - modelarts_pool_sku_GetPropertyDistinctFieldOutput: {} - modelarts_pool_sku_GetPropertySplitableExportOutput: {} - modelarts_pool_sku_GetPropertySplitableOutput: {} - modelarts_pool_sku_GetPropertyStatisticsOutput: - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/StatusStatistic' - type: object - modelarts_pool_sku_GetPropertyTagValuePairsOutput: {} - modelarts_pool_sku_GetPropertyTagValueTreeOutput: {} - modelarts_pool_sku_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - modelarts_pool_skus: - items: - $ref: '#/definitions/ModelartsPoolSkuDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - modelarts_pool_sku_PerformClassMetadataOutput: {} - modelarts_pool_sku_PerformDisableOutput: {} - modelarts_pool_sku_PerformEnableOutput: {} - modelarts_pool_sku_PerformPurgeSplitableOutput: {} - modelarts_pool_sku_PerformSetClassMetadataOutput: {} - modelarts_pool_sku_PerformSetUserMetadataOutput: {} - modelarts_pool_sku_PerformStatusOutput: {} - modelarts_pool_sku_ValidateCreateDataOutput: - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/ModelartsPoolSkuDetails' - type: object - modelarts_pool_sku_ValidateUpdateDataOutput: - schema: - properties: - modelarts_pool_sku: - $ref: '#/definitions/ModelartsPoolSkuDetails' - type: object - models_GetDomainQuotaOutput: - schema: - properties: - domain_quotas: - items: - $ref: '#/definitions/SDomainQuotaDetail' - type: array - x-go-name: Output - type: object - models_GetInfrasQuotaOutput: - schema: - properties: - infras_quotas: - items: - $ref: '#/definitions/SInfrasQuotaDetail' - type: array - x-go-name: Output - type: object - models_GetProjectQuotaOutput: - schema: - properties: - project_quotas: - items: - $ref: '#/definitions/SProjectQuotaDetail' - type: array - x-go-name: Output - type: object - models_GetQuotaOutput: - schema: - properties: - quotas: - items: - $ref: '#/definitions/SQuotaDetail' - type: array - x-go-name: Output - type: object - models_GetRegionQuotaOutput: - schema: - properties: - region_quotas: - items: - $ref: '#/definitions/SRegionQuotaDetail' - type: array - x-go-name: Output - type: object - models_GetZoneQuotaOutput: - schema: - properties: - zone_quotas: - items: - $ref: '#/definitions/SZoneQuotaDetail' - type: array - x-go-name: Output - type: object - models_ListDomainQuotasOutput: - schema: - properties: - domain_quotas: - items: - $ref: '#/definitions/SDomainQuotaDetail' - type: array - x-go-name: Output - type: object - models_ListInfrasQuotasOutput: - schema: - properties: - infras_quotas: - items: - $ref: '#/definitions/SInfrasQuotaDetail' - type: array - x-go-name: Output - type: object - models_ListProjectQuotasOutput: - schema: - properties: - project_quotas: - items: - $ref: '#/definitions/SProjectQuotaDetail' - type: array - x-go-name: Output - type: object - models_ListQuotasOutput: - schema: - properties: - quotas: - items: - $ref: '#/definitions/SQuotaDetail' - type: array - x-go-name: Output - type: object - models_ListRegionQuotasOutput: - schema: - properties: - region_quotas: - items: - $ref: '#/definitions/SRegionQuotaDetail' - type: array - x-go-name: Output - type: object - models_ListZoneQuotasOutput: - schema: - properties: - zone_quotas: - items: - $ref: '#/definitions/SZoneQuotaDetail' - type: array - x-go-name: Output - type: object - models_SetDomainQuotasOutput: - schema: - properties: - domain_quotas: - items: - $ref: '#/definitions/SDomainQuotaDetail' - type: array - x-go-name: Output - type: object - models_SetInfrasQuotasOutput: - schema: - properties: - infras_quotas: - items: - $ref: '#/definitions/SInfrasQuotaDetail' - type: array - x-go-name: Output - type: object - models_SetProjectQuotasOutput: - schema: - properties: - project_quotas: - items: - $ref: '#/definitions/SProjectQuotaDetail' - type: array - x-go-name: Output - type: object - models_SetQuotasOutput: - schema: - properties: - quotas: - items: - $ref: '#/definitions/SQuotaDetail' - type: array - x-go-name: Output - type: object - models_SetRegionQuotasOutput: - schema: - properties: - region_quotas: - items: - $ref: '#/definitions/SRegionQuotaDetail' - type: array - x-go-name: Output - type: object - models_SetZoneQuotasOutput: - schema: - properties: - zone_quotas: - items: - $ref: '#/definitions/SZoneQuotaDetail' - type: array - x-go-name: Output - type: object - mongo_db_CustomizeDeleteOutput: - schema: - properties: - mongo_db: - $ref: '#/definitions/MongoDBDetails' - type: object - mongo_db_FetchCustomizeColumnsOutput: - schema: - properties: - mongo_db: - $ref: '#/definitions/MongoDBDetails' - type: object - mongo_db_GetDetailsBackupsOutput: - schema: - properties: - mongo_db: - $ref: '#/definitions/SMongoDBBackups' - type: object - mongo_db_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - mongo_db: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - mongo_db_GetDetailsClassMetadataOutput: - schema: - properties: - mongo_db: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - mongo_db_GetDetailsMetadataOutput: - schema: - properties: - mongo_db: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - mongo_db_GetDetailsStatusOutput: - schema: - properties: - mongo_db: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - mongo_db_GetPropertyDistinctFieldOutput: {} - mongo_db_GetPropertyDomainStatisticsOutput: - schema: - properties: - mongo_db: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - mongo_db_GetPropertyProjectStatisticsOutput: - schema: - properties: - mongo_db: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - mongo_db_GetPropertyProjectTagValuePairsOutput: {} - mongo_db_GetPropertyProjectTagValueTreeOutput: {} - mongo_db_GetPropertySplitableExportOutput: {} - mongo_db_GetPropertySplitableOutput: {} - mongo_db_GetPropertyStatisticsOutput: - schema: - properties: - mongo_db: - $ref: '#/definitions/StatusStatistic' - type: object - mongo_db_GetPropertyTagValuePairsOutput: {} - mongo_db_GetPropertyTagValueTreeOutput: {} - mongo_db_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - mongo_dbs: - items: - $ref: '#/definitions/MongoDBDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - mongo_db_PerformCancelDeleteOutput: {} - mongo_db_PerformCancelExpireOutput: {} - mongo_db_PerformChangeOwnerOutput: {} - mongo_db_PerformClassMetadataOutput: {} - mongo_db_PerformFreezeOutput: {} - mongo_db_PerformPostpaidExpireOutput: {} - mongo_db_PerformPurgeSplitableOutput: {} - mongo_db_PerformRemoteUpdateOutput: {} - mongo_db_PerformSetClassMetadataOutput: {} - mongo_db_PerformSetUserMetadataOutput: {} - mongo_db_PerformStatusOutput: {} - mongo_db_PerformSyncstatusOutput: {} - mongo_db_PerformUnfreezeOutput: {} - mongo_db_ValidateCreateDataOutput: - schema: - properties: - mongo_db: - $ref: '#/definitions/MongoDBDetails' - type: object - mongo_db_ValidateUpdateDataOutput: - schema: - properties: - mongo_db: - $ref: '#/definitions/MongoDBDetails' - type: object - mount_target_CustomizeDeleteOutput: - schema: - properties: - mount_target: - $ref: '#/definitions/MountTargetDetails' - type: object - mount_target_FetchCustomizeColumnsOutput: - schema: - properties: - mount_target: - $ref: '#/definitions/MountTargetDetails' - type: object - mount_target_GetDetailsClassMetadataOutput: - schema: - properties: - mount_target: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - mount_target_GetDetailsMetadataOutput: - schema: - properties: - mount_target: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - mount_target_GetDetailsStatusOutput: - schema: - properties: - mount_target: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - mount_target_GetPropertyDistinctFieldOutput: {} - mount_target_GetPropertySplitableExportOutput: {} - mount_target_GetPropertySplitableOutput: {} - mount_target_GetPropertyStatisticsOutput: - schema: - properties: - mount_target: - $ref: '#/definitions/StatusStatistic' - type: object - mount_target_GetPropertyTagValuePairsOutput: {} - mount_target_GetPropertyTagValueTreeOutput: {} - mount_target_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - mount_targets: - items: - $ref: '#/definitions/MountTargetDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - mount_target_PerformClassMetadataOutput: {} - mount_target_PerformPurgeSplitableOutput: {} - mount_target_PerformSetClassMetadataOutput: {} - mount_target_PerformSetUserMetadataOutput: {} - mount_target_PerformStatusOutput: {} - mount_target_PerformSyncstatusOutput: {} - mount_target_ValidateCreateDataOutput: - schema: - properties: - mount_target: - $ref: '#/definitions/MountTargetDetails' - type: object - mount_target_ValidateUpdateDataOutput: - schema: - properties: - mount_target: - $ref: '#/definitions/MountTargetDetails' - type: object - nas_sku_CustomizeDeleteOutput: - schema: - properties: - nas_sku: - $ref: '#/definitions/NasSkuDetails' - type: object - nas_sku_FetchCustomizeColumnsOutput: - schema: - properties: - nas_sku: - $ref: '#/definitions/NasSkuDetails' - type: object - nas_sku_GetDetailsClassMetadataOutput: - schema: - properties: - nas_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nas_sku_GetDetailsMetadataOutput: - schema: - properties: - nas_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nas_sku_GetDetailsStatusOutput: - schema: - properties: - nas_sku: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - nas_sku_GetPropertyDistinctFieldOutput: {} - nas_sku_GetPropertySplitableExportOutput: {} - nas_sku_GetPropertySplitableOutput: {} - nas_sku_GetPropertyStatisticsOutput: - schema: - properties: - nas_sku: - $ref: '#/definitions/StatusStatistic' - type: object - nas_sku_GetPropertySyncTasksOutput: {} - nas_sku_GetPropertyTagValuePairsOutput: {} - nas_sku_GetPropertyTagValueTreeOutput: {} - nas_sku_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - nas_skus: - items: - $ref: '#/definitions/NasSkuDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - nas_sku_PerformClassMetadataOutput: {} - nas_sku_PerformDisableOutput: {} - nas_sku_PerformEnableOutput: {} - nas_sku_PerformPurgeSplitableOutput: {} - nas_sku_PerformSetClassMetadataOutput: {} - nas_sku_PerformSetUserMetadataOutput: {} - nas_sku_PerformStatusOutput: {} - nas_sku_PerformSyncSkusOutput: {} - nas_sku_ValidateCreateDataOutput: - schema: - properties: - nas_sku: - $ref: '#/definitions/NasSkuDetails' - type: object - nas_sku_ValidateUpdateDataOutput: - schema: - properties: - nas_sku: - $ref: '#/definitions/NasSkuDetails' - type: object - nat_dentry_CustomizeDeleteOutput: - schema: - properties: - nat_dentry: - $ref: '#/definitions/NatDEntryDetails' - type: object - nat_dentry_FetchCustomizeColumnsOutput: - schema: - properties: - nat_dentry: - $ref: '#/definitions/NatDEntryDetails' - type: object - nat_dentry_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - nat_dentry: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - nat_dentry_GetDetailsClassMetadataOutput: - schema: - properties: - nat_dentry: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_dentry_GetDetailsMetadataOutput: - schema: - properties: - nat_dentry: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_dentry_GetDetailsStatusOutput: - schema: - properties: - nat_dentry: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - nat_dentry_GetPropertyDistinctFieldOutput: {} - nat_dentry_GetPropertyDomainTagValuePairsOutput: {} - nat_dentry_GetPropertyDomainTagValueTreeOutput: {} - nat_dentry_GetPropertySplitableExportOutput: {} - nat_dentry_GetPropertySplitableOutput: {} - nat_dentry_GetPropertyStatisticsOutput: - schema: - properties: - nat_dentry: - $ref: '#/definitions/StatusStatistic' - type: object - nat_dentry_GetPropertyTagValuePairsOutput: {} - nat_dentry_GetPropertyTagValueTreeOutput: {} - nat_dentry_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - nat_dentries: - items: - $ref: '#/definitions/NatDEntryDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - nat_dentry_PerformChangeOwnerOutput: {} - nat_dentry_PerformClassMetadataOutput: {} - nat_dentry_PerformPrivateOutput: {} - nat_dentry_PerformPublicOutput: {} - nat_dentry_PerformPurgeSplitableOutput: {} - nat_dentry_PerformSetClassMetadataOutput: {} - nat_dentry_PerformSetUserMetadataOutput: {} - nat_dentry_PerformStatusOutput: {} - nat_dentry_ValidateCreateDataOutput: - schema: - properties: - nat_dentry: - $ref: '#/definitions/NatDEntryDetails' - type: object - nat_dentry_ValidateUpdateDataOutput: - schema: - properties: - nat_dentry: - $ref: '#/definitions/NatDEntryDetails' - type: object - nat_entry_CustomizeDeleteOutput: - schema: - properties: - nat_entry: - $ref: '#/definitions/NatEntryDetails' - type: object - nat_entry_FetchCustomizeColumnsOutput: - schema: - properties: - nat_entry: - $ref: '#/definitions/NatEntryDetails' - type: object - nat_entry_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - nat_entry: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - nat_entry_GetDetailsClassMetadataOutput: - schema: - properties: - nat_entry: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_entry_GetDetailsMetadataOutput: - schema: - properties: - nat_entry: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_entry_GetDetailsStatusOutput: - schema: - properties: - nat_entry: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - nat_entry_GetPropertyDistinctFieldOutput: {} - nat_entry_GetPropertyDomainTagValuePairsOutput: {} - nat_entry_GetPropertyDomainTagValueTreeOutput: {} - nat_entry_GetPropertySplitableExportOutput: {} - nat_entry_GetPropertySplitableOutput: {} - nat_entry_GetPropertyStatisticsOutput: - schema: - properties: - nat_entry: - $ref: '#/definitions/StatusStatistic' - type: object - nat_entry_GetPropertyTagValuePairsOutput: {} - nat_entry_GetPropertyTagValueTreeOutput: {} - nat_entry_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - nat_entries: - items: - $ref: '#/definitions/NatEntryDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - nat_entry_PerformChangeOwnerOutput: {} - nat_entry_PerformClassMetadataOutput: {} - nat_entry_PerformPrivateOutput: {} - nat_entry_PerformPublicOutput: {} - nat_entry_PerformPurgeSplitableOutput: {} - nat_entry_PerformSetClassMetadataOutput: {} - nat_entry_PerformSetUserMetadataOutput: {} - nat_entry_PerformStatusOutput: {} - nat_entry_ValidateCreateDataOutput: - schema: - properties: - nat_entry: - $ref: '#/definitions/NatEntryDetails' - type: object - nat_entry_ValidateUpdateDataOutput: - schema: - properties: - nat_entry: - $ref: '#/definitions/NatEntryDetails' - type: object - nat_gateway_CustomizeDeleteOutput: - schema: - properties: - nat_gateway: - $ref: '#/definitions/NatgatewayDetails' - type: object - nat_gateway_FetchCustomizeColumnsOutput: - schema: - properties: - nat_gateway: - $ref: '#/definitions/NatgatewayDetails' - type: object - nat_gateway_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - nat_gateway: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - nat_gateway_GetDetailsClassMetadataOutput: - schema: - properties: - nat_gateway: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_gateway_GetDetailsMetadataOutput: - schema: - properties: - nat_gateway: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_gateway_GetDetailsStatusOutput: - schema: - properties: - nat_gateway: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - nat_gateway_GetPropertyDistinctFieldOutput: {} - nat_gateway_GetPropertyDomainTagValuePairsOutput: {} - nat_gateway_GetPropertyDomainTagValueTreeOutput: {} - nat_gateway_GetPropertySplitableExportOutput: {} - nat_gateway_GetPropertySplitableOutput: {} - nat_gateway_GetPropertyStatisticsOutput: - schema: - properties: - nat_gateway: - $ref: '#/definitions/StatusStatistic' - type: object - nat_gateway_GetPropertyTagValuePairsOutput: {} - nat_gateway_GetPropertyTagValueTreeOutput: {} - nat_gateway_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - nat_gateways: - items: - $ref: '#/definitions/NatgatewayDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - nat_gateway_PerformCancelExpireOutput: {} - nat_gateway_PerformChangeOwnerOutput: {} - nat_gateway_PerformClassMetadataOutput: {} - nat_gateway_PerformDnatResourcesOutput: {} - nat_gateway_PerformPostpaidExpireOutput: {} - nat_gateway_PerformPrivateOutput: {} - nat_gateway_PerformPublicOutput: {} - nat_gateway_PerformPurgeSplitableOutput: {} - nat_gateway_PerformRemoteUpdateOutput: {} - nat_gateway_PerformRenewOutput: {} - nat_gateway_PerformSetAutoRenewOutput: {} - nat_gateway_PerformSetClassMetadataOutput: {} - nat_gateway_PerformSetUserMetadataOutput: {} - nat_gateway_PerformSnatResourcesOutput: {} - nat_gateway_PerformStatusOutput: {} - nat_gateway_PerformSyncstatusOutput: {} - nat_gateway_ValidateCreateDataOutput: - schema: - properties: - nat_gateway: - $ref: '#/definitions/NatgatewayDetails' - type: object - nat_gateway_ValidateUpdateDataOutput: - schema: - properties: - nat_gateway: - $ref: '#/definitions/NatgatewayDetails' - type: object - nat_sentry_CustomizeDeleteOutput: - schema: - properties: - nat_sentry: - $ref: '#/definitions/NatSEntryDetails' - type: object - nat_sentry_FetchCustomizeColumnsOutput: - schema: - properties: - nat_sentry: - $ref: '#/definitions/NatSEntryDetails' - type: object - nat_sentry_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - nat_sentry: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - nat_sentry_GetDetailsClassMetadataOutput: - schema: - properties: - nat_sentry: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_sentry_GetDetailsMetadataOutput: - schema: - properties: - nat_sentry: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_sentry_GetDetailsStatusOutput: - schema: - properties: - nat_sentry: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - nat_sentry_GetPropertyDistinctFieldOutput: {} - nat_sentry_GetPropertyDomainTagValuePairsOutput: {} - nat_sentry_GetPropertyDomainTagValueTreeOutput: {} - nat_sentry_GetPropertySplitableExportOutput: {} - nat_sentry_GetPropertySplitableOutput: {} - nat_sentry_GetPropertyStatisticsOutput: - schema: - properties: - nat_sentry: - $ref: '#/definitions/StatusStatistic' - type: object - nat_sentry_GetPropertyTagValuePairsOutput: {} - nat_sentry_GetPropertyTagValueTreeOutput: {} - nat_sentry_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - nat_sentries: - items: - $ref: '#/definitions/NatSEntryDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - nat_sentry_PerformChangeOwnerOutput: {} - nat_sentry_PerformClassMetadataOutput: {} - nat_sentry_PerformPrivateOutput: {} - nat_sentry_PerformPublicOutput: {} - nat_sentry_PerformPurgeSplitableOutput: {} - nat_sentry_PerformSetClassMetadataOutput: {} - nat_sentry_PerformSetUserMetadataOutput: {} - nat_sentry_PerformStatusOutput: {} - nat_sentry_ValidateCreateDataOutput: - schema: - properties: - nat_sentry: - $ref: '#/definitions/NatSEntryDetails' - type: object - nat_sentry_ValidateUpdateDataOutput: - schema: - properties: - nat_sentry: - $ref: '#/definitions/NatSEntryDetails' - type: object - nat_sku_CustomizeDeleteOutput: - schema: - properties: - nat_sku: - $ref: '#/definitions/NatSkuDetails' - type: object - nat_sku_FetchCustomizeColumnsOutput: - schema: - properties: - nat_sku: - $ref: '#/definitions/NatSkuDetails' - type: object - nat_sku_GetDetailsClassMetadataOutput: - schema: - properties: - nat_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_sku_GetDetailsMetadataOutput: - schema: - properties: - nat_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - nat_sku_GetDetailsStatusOutput: - schema: - properties: - nat_sku: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - nat_sku_GetPropertyDistinctFieldOutput: {} - nat_sku_GetPropertySplitableExportOutput: {} - nat_sku_GetPropertySplitableOutput: {} - nat_sku_GetPropertyStatisticsOutput: - schema: - properties: - nat_sku: - $ref: '#/definitions/StatusStatistic' - type: object - nat_sku_GetPropertySyncTasksOutput: {} - nat_sku_GetPropertyTagValuePairsOutput: {} - nat_sku_GetPropertyTagValueTreeOutput: {} - nat_sku_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - nat_skus: - items: - $ref: '#/definitions/NatSkuDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - nat_sku_PerformClassMetadataOutput: {} - nat_sku_PerformDisableOutput: {} - nat_sku_PerformEnableOutput: {} - nat_sku_PerformPurgeSplitableOutput: {} - nat_sku_PerformSetClassMetadataOutput: {} - nat_sku_PerformSetUserMetadataOutput: {} - nat_sku_PerformStatusOutput: {} - nat_sku_PerformSyncSkusOutput: {} - nat_sku_ValidateCreateDataOutput: - schema: - properties: - nat_sku: - $ref: '#/definitions/NatSkuDetails' - type: object - nat_sku_ValidateUpdateDataOutput: - schema: - properties: - nat_sku: - $ref: '#/definitions/NatSkuDetails' - type: object - net_tap_flow_CustomizeDeleteOutput: - schema: - properties: - net_tap_flow: - $ref: '#/definitions/NetTapFlowDetails' - type: object - net_tap_flow_FetchCustomizeColumnsOutput: - schema: - properties: - net_tap_flow: - $ref: '#/definitions/NetTapFlowDetails' - type: object - net_tap_flow_GetDetailsClassMetadataOutput: - schema: - properties: - net_tap_flow: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - net_tap_flow_GetDetailsMetadataOutput: - schema: - properties: - net_tap_flow: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - net_tap_flow_GetDetailsStatusOutput: - schema: - properties: - net_tap_flow: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - net_tap_flow_GetPropertyDistinctFieldOutput: {} - net_tap_flow_GetPropertySplitableExportOutput: {} - net_tap_flow_GetPropertySplitableOutput: {} - net_tap_flow_GetPropertyStatisticsOutput: - schema: - properties: - net_tap_flow: - $ref: '#/definitions/StatusStatistic' - type: object - net_tap_flow_GetPropertyTagValuePairsOutput: {} - net_tap_flow_GetPropertyTagValueTreeOutput: {} - net_tap_flow_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - net_tap_flows: - items: - $ref: '#/definitions/NetTapFlowDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - net_tap_flow_PerformClassMetadataOutput: {} - net_tap_flow_PerformDisableOutput: {} - net_tap_flow_PerformEnableOutput: {} - net_tap_flow_PerformPurgeSplitableOutput: {} - net_tap_flow_PerformSetClassMetadataOutput: {} - net_tap_flow_PerformSetUserMetadataOutput: {} - net_tap_flow_PerformStatusOutput: {} - net_tap_flow_ValidateCreateDataOutput: - schema: - properties: - net_tap_flow: - $ref: '#/definitions/NetTapFlowDetails' - type: object - net_tap_flow_ValidateUpdateDataOutput: - schema: - properties: - net_tap_flow: - $ref: '#/definitions/NetTapFlowDetails' - type: object - net_tap_service_CustomizeDeleteOutput: - schema: - properties: - net_tap_service: - $ref: '#/definitions/NetTapServiceDetails' - type: object - net_tap_service_FetchCustomizeColumnsOutput: - schema: - properties: - net_tap_service: - $ref: '#/definitions/NetTapServiceDetails' - type: object - net_tap_service_GetDetailsClassMetadataOutput: - schema: - properties: - net_tap_service: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - net_tap_service_GetDetailsMetadataOutput: - schema: - properties: - net_tap_service: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - net_tap_service_GetDetailsStatusOutput: - schema: - properties: - net_tap_service: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - net_tap_service_GetPropertyDistinctFieldOutput: {} - net_tap_service_GetPropertySplitableExportOutput: {} - net_tap_service_GetPropertySplitableOutput: {} - net_tap_service_GetPropertyStatisticsOutput: - schema: - properties: - net_tap_service: - $ref: '#/definitions/StatusStatistic' - type: object - net_tap_service_GetPropertyTagValuePairsOutput: {} - net_tap_service_GetPropertyTagValueTreeOutput: {} - net_tap_service_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - net_tap_services: - items: - $ref: '#/definitions/NetTapServiceDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - net_tap_service_PerformClassMetadataOutput: {} - net_tap_service_PerformDisableOutput: {} - net_tap_service_PerformEnableOutput: {} - net_tap_service_PerformPurgeSplitableOutput: {} - net_tap_service_PerformSetClassMetadataOutput: {} - net_tap_service_PerformSetUserMetadataOutput: {} - net_tap_service_PerformStatusOutput: {} - net_tap_service_ValidateCreateDataOutput: - schema: - properties: - net_tap_service: - $ref: '#/definitions/NetTapServiceDetails' - type: object - net_tap_service_ValidateUpdateDataOutput: - schema: - properties: - net_tap_service: - $ref: '#/definitions/NetTapServiceDetails' - type: object - network_CustomizeDeleteOutput: - schema: - properties: - network: - $ref: '#/definitions/NetworkDetails' - type: object - network_FetchCustomizeColumnsOutput: - schema: - properties: - network: - $ref: '#/definitions/NetworkDetails' - type: object - network_GetDetailsAddressesOutput: - schema: - properties: - network: - $ref: '#/definitions/GetNetworkAddressesOutput' - type: object - network_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - network: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - network_GetDetailsClassMetadataOutput: - schema: - properties: - network: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - network_GetDetailsMetadataOutput: - schema: - properties: - network: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - network_GetDetailsReservedIpsOutput: {} - network_GetDetailsStatusOutput: - schema: - properties: - network: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - network_GetPropertyDistinctFieldOutput: {} - network_GetPropertyDomainStatisticsOutput: - schema: - properties: - network: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - network_GetPropertyProjectStatisticsOutput: - schema: - properties: - network: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - network_GetPropertyProjectTagValuePairsOutput: {} - network_GetPropertyProjectTagValueTreeOutput: {} - network_GetPropertySplitableExportOutput: {} - network_GetPropertySplitableOutput: {} - network_GetPropertyStatisticsOutput: - schema: - properties: - network: - $ref: '#/definitions/StatusStatistic' - type: object - network_GetPropertyTagValuePairsOutput: {} - network_GetPropertyTagValueTreeOutput: {} - network_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - networks: - items: - $ref: '#/definitions/NetworkDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - network_PerformCancelDeleteOutput: {} - network_PerformChangeOwnerOutput: {} - network_PerformClassMetadataOutput: {} - network_PerformFreezeOutput: {} - network_PerformMergeOutput: {} - network_PerformPrivateOutput: {} - network_PerformPublicOutput: {} - network_PerformPurgeOutput: {} - network_PerformPurgeSplitableOutput: {} - network_PerformReleaseReservedIpOutput: {} - network_PerformReserveIpOutput: {} - network_PerformSetBgpTypeOutput: {} - network_PerformSetClassMetadataOutput: {} - network_PerformSetSchedtagOutput: {} - network_PerformSetUserMetadataOutput: {} - network_PerformSplitOutput: {} - network_PerformStatusOutput: {} - network_PerformSwitchWireOutput: {} - network_PerformSyncOutput: {} - network_PerformSyncstatusOutput: {} - network_PerformTryCreateNetworkOutput: {} - network_PerformUnfreezeOutput: {} - network_ValidateCreateDataOutput: - schema: - properties: - network: - $ref: '#/definitions/NetworkDetails' - type: object - network_ValidateUpdateDataOutput: - schema: - properties: - network: - $ref: '#/definitions/NetworkDetails' - type: object - network_address_CustomizeDeleteOutput: - schema: - properties: - network_address: - $ref: '#/definitions/NetworkAddressDetails' - type: object - network_address_FetchCustomizeColumnsOutput: - schema: - properties: - network_address: - $ref: '#/definitions/NetworkAddressDetails' - type: object - network_address_GetDetailsClassMetadataOutput: - schema: - properties: - network_address: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - network_address_GetDetailsMetadataOutput: - schema: - properties: - network_address: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - network_address_GetPropertyDistinctFieldOutput: {} - network_address_GetPropertySplitableExportOutput: {} - network_address_GetPropertySplitableOutput: {} - network_address_GetPropertyTagValuePairsOutput: {} - network_address_GetPropertyTagValueTreeOutput: {} - network_address_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - network_addresses: - items: - $ref: '#/definitions/NetworkAddressDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - network_address_PerformClassMetadataOutput: {} - network_address_PerformPurgeSplitableOutput: {} - network_address_PerformSetClassMetadataOutput: {} - network_address_PerformSetUserMetadataOutput: {} - network_address_ValidateCreateDataOutput: - schema: - properties: - network_address: - $ref: '#/definitions/NetworkAddressDetails' - type: object - network_address_ValidateUpdateDataOutput: - schema: - properties: - network_address: - $ref: '#/definitions/NetworkAddressDetails' - type: object - network_interface_CustomizeDeleteOutput: - schema: - properties: - network_interface: - $ref: '#/definitions/NetworkInterfaceDetails' - type: object - network_interface_FetchCustomizeColumnsOutput: - schema: - properties: - network_interface: - $ref: '#/definitions/NetworkInterfaceDetails' - type: object - network_interface_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - network_interface: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - network_interface_GetDetailsClassMetadataOutput: - schema: - properties: - network_interface: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - network_interface_GetDetailsMetadataOutput: - schema: - properties: - network_interface: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - network_interface_GetDetailsStatusOutput: - schema: - properties: - network_interface: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - network_interface_GetPropertyDistinctFieldOutput: {} - network_interface_GetPropertyDomainTagValuePairsOutput: {} - network_interface_GetPropertyDomainTagValueTreeOutput: {} - network_interface_GetPropertySplitableExportOutput: {} - network_interface_GetPropertySplitableOutput: {} - network_interface_GetPropertyStatisticsOutput: - schema: - properties: - network_interface: - $ref: '#/definitions/StatusStatistic' - type: object - network_interface_GetPropertyTagValuePairsOutput: {} - network_interface_GetPropertyTagValueTreeOutput: {} - network_interface_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - network_interfaces: - items: - $ref: '#/definitions/NetworkInterfaceDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - network_interface_PerformChangeOwnerOutput: {} - network_interface_PerformClassMetadataOutput: {} - network_interface_PerformPrivateOutput: {} - network_interface_PerformPublicOutput: {} - network_interface_PerformPurgeSplitableOutput: {} - network_interface_PerformSetClassMetadataOutput: {} - network_interface_PerformSetUserMetadataOutput: {} - network_interface_PerformStatusOutput: {} - network_interface_ValidateCreateDataOutput: - schema: - properties: - network_interface: - $ref: '#/definitions/NetworkInterfaceDetails' - type: object - network_interface_ValidateUpdateDataOutput: - schema: - properties: - network_interface: - $ref: '#/definitions/NetworkInterfaceDetails' - type: object - network_ip_mac_CustomizeDeleteOutput: - schema: - properties: - network_ip_mac: - $ref: '#/definitions/NetworkIpMacDetails' - type: object - network_ip_mac_FetchCustomizeColumnsOutput: - schema: - properties: - network_ip_mac: - $ref: '#/definitions/NetworkIpMacDetails' - type: object - network_ip_mac_GetDetailsClassMetadataOutput: - schema: - properties: - network_ip_mac: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - network_ip_mac_GetDetailsMetadataOutput: - schema: - properties: - network_ip_mac: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - network_ip_mac_GetPropertyDistinctFieldOutput: {} - network_ip_mac_GetPropertySplitableExportOutput: {} - network_ip_mac_GetPropertySplitableOutput: {} - network_ip_mac_GetPropertyTagValuePairsOutput: {} - network_ip_mac_GetPropertyTagValueTreeOutput: {} - network_ip_mac_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - network_ip_macs: - items: - $ref: '#/definitions/NetworkIpMacDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - network_ip_mac_PerformBatchCreateOutput: {} - network_ip_mac_PerformClassMetadataOutput: {} - network_ip_mac_PerformPurgeSplitableOutput: {} - network_ip_mac_PerformSetClassMetadataOutput: {} - network_ip_mac_PerformSetUserMetadataOutput: {} - network_ip_mac_ValidateCreateDataOutput: - schema: - properties: - network_ip_mac: - $ref: '#/definitions/NetworkIpMacDetails' - type: object - network_ip_mac_ValidateUpdateDataOutput: - schema: - properties: - network_ip_mac: - $ref: '#/definitions/NetworkIpMacDetails' - type: object - networkinterfacenetwork_CustomizeDeleteOutput: - schema: - properties: - networkinterfacenetwork: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - networkinterfacenetwork_FetchCustomizeColumnsOutput: - schema: - properties: - networkinterfacenetwork: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - networkinterfacenetwork_GetPropertyDistinctFieldOutput: {} - networkinterfacenetwork_GetPropertySplitableExportOutput: {} - networkinterfacenetwork_GetPropertySplitableOutput: {} - networkinterfacenetwork_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - networkinterfacenetworks: - items: - $ref: '#/definitions/JointResourceBaseDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - networkinterfacenetwork_PerformPurgeSplitableOutput: {} - networkinterfacenetwork_ValidateCreateDataOutput: - schema: - properties: - networkinterfacenetwork: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - networkinterfacenetwork_ValidateUpdateDataOutput: - schema: - properties: - networkinterfacenetwork: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - policy_assignment_CustomizeDeleteOutput: - schema: - properties: - policy_assignment: - $ref: '#/definitions/PolicyAssignmentDetails' - type: object - policy_assignment_FetchCustomizeColumnsOutput: - schema: - properties: - policy_assignment: - $ref: '#/definitions/PolicyAssignmentDetails' - type: object - policy_assignment_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - policy_assignment: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - policy_assignment_GetDetailsClassMetadataOutput: - schema: - properties: - policy_assignment: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - policy_assignment_GetDetailsMetadataOutput: - schema: - properties: - policy_assignment: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - policy_assignment_GetPropertyDistinctFieldOutput: {} - policy_assignment_GetPropertyDomainTagValuePairsOutput: {} - policy_assignment_GetPropertyDomainTagValueTreeOutput: {} - policy_assignment_GetPropertySplitableExportOutput: {} - policy_assignment_GetPropertySplitableOutput: {} - policy_assignment_GetPropertyTagValuePairsOutput: {} - policy_assignment_GetPropertyTagValueTreeOutput: {} - policy_assignment_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - policy_assignments: - items: - $ref: '#/definitions/PolicyAssignmentDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - policy_assignment_PerformChangeOwnerOutput: {} - policy_assignment_PerformClassMetadataOutput: {} - policy_assignment_PerformPurgeSplitableOutput: {} - policy_assignment_PerformSetClassMetadataOutput: {} - policy_assignment_PerformSetUserMetadataOutput: {} - policy_assignment_ValidateCreateDataOutput: - schema: - properties: - policy_assignment: - $ref: '#/definitions/PolicyAssignmentDetails' - type: object - policy_assignment_ValidateUpdateDataOutput: - schema: - properties: - policy_assignment: - $ref: '#/definitions/PolicyAssignmentDetails' - type: object - policy_definition_CustomizeDeleteOutput: - schema: - properties: - policy_definition: - $ref: '#/definitions/PolicyDefinitionDetails' - type: object - policy_definition_FetchCustomizeColumnsOutput: - schema: - properties: - policy_definition: - $ref: '#/definitions/PolicyDefinitionDetails' - type: object - policy_definition_GetDetailsClassMetadataOutput: - schema: - properties: - policy_definition: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - policy_definition_GetDetailsMetadataOutput: - schema: - properties: - policy_definition: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - policy_definition_GetDetailsStatusOutput: - schema: - properties: - policy_definition: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - policy_definition_GetPropertyDistinctFieldOutput: {} - policy_definition_GetPropertySplitableExportOutput: {} - policy_definition_GetPropertySplitableOutput: {} - policy_definition_GetPropertyStatisticsOutput: - schema: - properties: - policy_definition: - $ref: '#/definitions/StatusStatistic' - type: object - policy_definition_GetPropertyTagValuePairsOutput: {} - policy_definition_GetPropertyTagValueTreeOutput: {} - policy_definition_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - policy_definitions: - items: - $ref: '#/definitions/PolicyDefinitionDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - policy_definition_PerformClassMetadataOutput: {} - policy_definition_PerformPurgeSplitableOutput: {} - policy_definition_PerformSetClassMetadataOutput: {} - policy_definition_PerformSetUserMetadataOutput: {} - policy_definition_PerformStatusOutput: {} - policy_definition_ValidateCreateDataOutput: - schema: - properties: - policy_definition: - $ref: '#/definitions/PolicyDefinitionDetails' - type: object - policy_definition_ValidateUpdateDataOutput: - schema: - properties: - policy_definition: - $ref: '#/definitions/PolicyDefinitionDetails' - type: object - project_mapping_CustomizeDeleteOutput: - schema: - properties: - project_mapping: - $ref: '#/definitions/ProjectMappingDetails' - type: object - project_mapping_FetchCustomizeColumnsOutput: - schema: - properties: - project_mapping: - $ref: '#/definitions/ProjectMappingDetails' - type: object - project_mapping_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - project_mapping: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - project_mapping_GetDetailsClassMetadataOutput: - schema: - properties: - project_mapping: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - project_mapping_GetDetailsMetadataOutput: - schema: - properties: - project_mapping: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - project_mapping_GetDetailsStatusOutput: - schema: - properties: - project_mapping: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - project_mapping_GetPropertyDistinctFieldOutput: {} - project_mapping_GetPropertyDomainTagValuePairsOutput: {} - project_mapping_GetPropertyDomainTagValueTreeOutput: {} - project_mapping_GetPropertySplitableExportOutput: {} - project_mapping_GetPropertySplitableOutput: {} - project_mapping_GetPropertyStatisticsOutput: - schema: - properties: - project_mapping: - $ref: '#/definitions/StatusStatistic' - type: object - project_mapping_GetPropertyTagValuePairsOutput: {} - project_mapping_GetPropertyTagValueTreeOutput: {} - project_mapping_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - project_mappings: - items: - $ref: '#/definitions/ProjectMappingDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - project_mapping_PerformChangeOwnerOutput: {} - project_mapping_PerformClassMetadataOutput: {} - project_mapping_PerformDisableOutput: {} - project_mapping_PerformEnableOutput: {} - project_mapping_PerformPrivateOutput: {} - project_mapping_PerformPublicOutput: {} - project_mapping_PerformPurgeSplitableOutput: {} - project_mapping_PerformSetClassMetadataOutput: {} - project_mapping_PerformSetUserMetadataOutput: {} - project_mapping_PerformStatusOutput: {} - project_mapping_ValidateCreateDataOutput: - schema: - properties: - project_mapping: - $ref: '#/definitions/ProjectMappingDetails' - type: object - project_mapping_ValidateUpdateDataOutput: - schema: - properties: - project_mapping: - $ref: '#/definitions/ProjectMappingDetails' - type: object - reservedip_CustomizeDeleteOutput: - schema: - properties: - reservedip: - $ref: '#/definitions/ReservedipDetails' - type: object - reservedip_FetchCustomizeColumnsOutput: - schema: - properties: - reservedip: - $ref: '#/definitions/ReservedipDetails' - type: object - reservedip_GetPropertyDistinctFieldOutput: {} - reservedip_GetPropertySplitableExportOutput: {} - reservedip_GetPropertySplitableOutput: {} - reservedip_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - reservedips: - items: - $ref: '#/definitions/ReservedipDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - reservedip_PerformPurgeSplitableOutput: {} - reservedip_ValidateCreateDataOutput: - schema: - properties: - reservedip: - $ref: '#/definitions/ReservedipDetails' - type: object - reservedip_ValidateUpdateDataOutput: - schema: - properties: - reservedip: - $ref: '#/definitions/ReservedipDetails' - type: object - route_table_CustomizeDeleteOutput: - schema: - properties: - route_table: - $ref: '#/definitions/RouteTableDetails' - type: object - route_table_FetchCustomizeColumnsOutput: - schema: - properties: - route_table: - $ref: '#/definitions/RouteTableDetails' - type: object - route_table_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - route_table: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - route_table_GetDetailsClassMetadataOutput: - schema: - properties: - route_table: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - route_table_GetDetailsMetadataOutput: - schema: - properties: - route_table: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - route_table_GetDetailsStatusOutput: - schema: - properties: - route_table: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - route_table_GetPropertyDistinctFieldOutput: {} - route_table_GetPropertyDomainTagValuePairsOutput: {} - route_table_GetPropertyDomainTagValueTreeOutput: {} - route_table_GetPropertySplitableExportOutput: {} - route_table_GetPropertySplitableOutput: {} - route_table_GetPropertyStatisticsOutput: - schema: - properties: - route_table: - $ref: '#/definitions/StatusStatistic' - type: object - route_table_GetPropertyTagValuePairsOutput: {} - route_table_GetPropertyTagValueTreeOutput: {} - route_table_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - route_tables: - items: - $ref: '#/definitions/RouteTableDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - route_table_PerformAddRoutesOutput: {} - route_table_PerformChangeOwnerOutput: {} - route_table_PerformClassMetadataOutput: {} - route_table_PerformDelRoutesOutput: {} - route_table_PerformPrivateOutput: {} - route_table_PerformPublicOutput: {} - route_table_PerformPurgeOutput: {} - route_table_PerformPurgeSplitableOutput: {} - route_table_PerformSetClassMetadataOutput: {} - route_table_PerformSetUserMetadataOutput: {} - route_table_PerformStatusOutput: {} - route_table_PerformSyncstatusOutput: {} - route_table_ValidateCreateDataOutput: - schema: - properties: - route_table: - $ref: '#/definitions/RouteTableDetails' - type: object - route_table_ValidateUpdateDataOutput: - schema: - properties: - route_table: - $ref: '#/definitions/RouteTableDetails' - type: object - route_table_association_CustomizeDeleteOutput: - schema: - properties: - route_table_association: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: object - route_table_association_FetchCustomizeColumnsOutput: - schema: - properties: - route_table_association: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: object - route_table_association_GetDetailsClassMetadataOutput: - schema: - properties: - route_table_association: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - route_table_association_GetDetailsMetadataOutput: - schema: - properties: - route_table_association: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - route_table_association_GetDetailsStatusOutput: - schema: - properties: - route_table_association: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - route_table_association_GetPropertyDistinctFieldOutput: {} - route_table_association_GetPropertySplitableExportOutput: {} - route_table_association_GetPropertySplitableOutput: {} - route_table_association_GetPropertyStatisticsOutput: - schema: - properties: - route_table_association: - $ref: '#/definitions/StatusStatistic' - type: object - route_table_association_GetPropertyTagValuePairsOutput: {} - route_table_association_GetPropertyTagValueTreeOutput: {} - route_table_association_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - route_table_associations: - items: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - route_table_association_PerformClassMetadataOutput: {} - route_table_association_PerformPurgeSplitableOutput: {} - route_table_association_PerformSetClassMetadataOutput: {} - route_table_association_PerformSetUserMetadataOutput: {} - route_table_association_PerformStatusOutput: {} - route_table_association_ValidateCreateDataOutput: - schema: - properties: - route_table_association: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: object - route_table_association_ValidateUpdateDataOutput: - schema: - properties: - route_table_association: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: object - route_table_route_set_CustomizeDeleteOutput: - schema: - properties: - route_table_route_set: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: object - route_table_route_set_FetchCustomizeColumnsOutput: - schema: - properties: - route_table_route_set: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: object - route_table_route_set_GetDetailsClassMetadataOutput: - schema: - properties: - route_table_route_set: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - route_table_route_set_GetDetailsMetadataOutput: - schema: - properties: - route_table_route_set: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - route_table_route_set_GetDetailsStatusOutput: - schema: - properties: - route_table_route_set: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - route_table_route_set_GetPropertyDistinctFieldOutput: {} - route_table_route_set_GetPropertySplitableExportOutput: {} - route_table_route_set_GetPropertySplitableOutput: {} - route_table_route_set_GetPropertyStatisticsOutput: - schema: - properties: - route_table_route_set: - $ref: '#/definitions/StatusStatistic' - type: object - route_table_route_set_GetPropertyTagValuePairsOutput: {} - route_table_route_set_GetPropertyTagValueTreeOutput: {} - route_table_route_set_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - route_table_route_sets: - items: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - route_table_route_set_PerformClassMetadataOutput: {} - route_table_route_set_PerformPurgeSplitableOutput: {} - route_table_route_set_PerformSetClassMetadataOutput: {} - route_table_route_set_PerformSetUserMetadataOutput: {} - route_table_route_set_PerformStatusOutput: {} - route_table_route_set_ValidateCreateDataOutput: - schema: - properties: - route_table_route_set: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: object - route_table_route_set_ValidateUpdateDataOutput: - schema: - properties: - route_table_route_set: - $ref: '#/definitions/StatusStandaloneResourceDetails' - type: object - scaling_activity_CustomizeDeleteOutput: - schema: - properties: - scaling_activity: - $ref: '#/definitions/ScalingActivityDetails' - type: object - scaling_activity_FetchCustomizeColumnsOutput: - schema: - properties: - scaling_activity: - $ref: '#/definitions/ScalingActivityDetails' - type: object - scaling_activity_GetDetailsClassMetadataOutput: - schema: - properties: - scaling_activity: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_activity_GetDetailsMetadataOutput: - schema: - properties: - scaling_activity: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_activity_GetDetailsStatusOutput: - schema: - properties: - scaling_activity: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - scaling_activity_GetPropertyDistinctFieldOutput: {} - scaling_activity_GetPropertySplitableExportOutput: {} - scaling_activity_GetPropertySplitableOutput: {} - scaling_activity_GetPropertyStatisticsOutput: - schema: - properties: - scaling_activity: - $ref: '#/definitions/StatusStatistic' - type: object - scaling_activity_GetPropertyTagValuePairsOutput: {} - scaling_activity_GetPropertyTagValueTreeOutput: {} - scaling_activity_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - scaling_activities: - items: - $ref: '#/definitions/ScalingActivityDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - scaling_activity_PerformClassMetadataOutput: {} - scaling_activity_PerformPurgeSplitableOutput: {} - scaling_activity_PerformSetClassMetadataOutput: {} - scaling_activity_PerformSetUserMetadataOutput: {} - scaling_activity_PerformStatusOutput: {} - scaling_activity_ValidateCreateDataOutput: - schema: - properties: - scaling_activity: - $ref: '#/definitions/ScalingActivityDetails' - type: object - scaling_activity_ValidateUpdateDataOutput: - schema: - properties: - scaling_activity: - $ref: '#/definitions/ScalingActivityDetails' - type: object - scaling_alarm_CustomizeDeleteOutput: - schema: - properties: - scaling_alarm: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - scaling_alarm_FetchCustomizeColumnsOutput: - schema: - properties: - scaling_alarm: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - scaling_alarm_GetDetailsClassMetadataOutput: - schema: - properties: - scaling_alarm: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_alarm_GetDetailsMetadataOutput: - schema: - properties: - scaling_alarm: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_alarm_GetPropertyDistinctFieldOutput: {} - scaling_alarm_GetPropertySplitableExportOutput: {} - scaling_alarm_GetPropertySplitableOutput: {} - scaling_alarm_GetPropertyTagValuePairsOutput: {} - scaling_alarm_GetPropertyTagValueTreeOutput: {} - scaling_alarm_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - scaling_alarms: - items: - $ref: '#/definitions/StandaloneResourceDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - scaling_alarm_PerformClassMetadataOutput: {} - scaling_alarm_PerformPurgeSplitableOutput: {} - scaling_alarm_PerformSetClassMetadataOutput: {} - scaling_alarm_PerformSetUserMetadataOutput: {} - scaling_alarm_ValidateCreateDataOutput: - schema: - properties: - scaling_alarm: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - scaling_alarm_ValidateUpdateDataOutput: - schema: - properties: - scaling_alarm: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - scaling_group_CustomizeDeleteOutput: - schema: - properties: - scaling_group: - $ref: '#/definitions/ScalingGroupDetails' - type: object - scaling_group_FetchCustomizeColumnsOutput: - schema: - properties: - scaling_group: - $ref: '#/definitions/ScalingGroupDetails' - type: object - scaling_group_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - scaling_group: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - scaling_group_GetDetailsClassMetadataOutput: - schema: - properties: - scaling_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_group_GetDetailsMetadataOutput: - schema: - properties: - scaling_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_group_GetDetailsStatusOutput: - schema: - properties: - scaling_group: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - scaling_group_GetPropertyDistinctFieldOutput: {} - scaling_group_GetPropertyDomainStatisticsOutput: - schema: - properties: - scaling_group: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - scaling_group_GetPropertyProjectStatisticsOutput: - schema: - properties: - scaling_group: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - scaling_group_GetPropertyProjectTagValuePairsOutput: {} - scaling_group_GetPropertyProjectTagValueTreeOutput: {} - scaling_group_GetPropertySplitableExportOutput: {} - scaling_group_GetPropertySplitableOutput: {} - scaling_group_GetPropertyStatisticsOutput: - schema: - properties: - scaling_group: - $ref: '#/definitions/StatusStatistic' - type: object - scaling_group_GetPropertyTagValuePairsOutput: {} - scaling_group_GetPropertyTagValueTreeOutput: {} - scaling_group_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - scaling_groups: - items: - $ref: '#/definitions/ScalingGroupDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - scaling_group_PerformCancelDeleteOutput: {} - scaling_group_PerformChangeOwnerOutput: {} - scaling_group_PerformClassMetadataOutput: {} - scaling_group_PerformDisableOutput: {} - scaling_group_PerformEnableOutput: {} - scaling_group_PerformFreezeOutput: {} - scaling_group_PerformPurgeSplitableOutput: {} - scaling_group_PerformSetClassMetadataOutput: {} - scaling_group_PerformSetUserMetadataOutput: {} - scaling_group_PerformStatusOutput: {} - scaling_group_PerformUnfreezeOutput: {} - scaling_group_ValidateCreateDataOutput: - schema: - properties: - scaling_group: - $ref: '#/definitions/ScalingGroupDetails' - type: object - scaling_group_ValidateUpdateDataOutput: - schema: - properties: - scaling_group: - $ref: '#/definitions/ScalingGroupDetails' - type: object - scaling_group_guest_CustomizeDeleteOutput: - schema: - properties: - scaling_group_guest: - $ref: '#/definitions/GuestJointResourceDetails' - type: object - scaling_group_guest_FetchCustomizeColumnsOutput: - schema: - properties: - scaling_group_guest: - $ref: '#/definitions/GuestJointResourceDetails' - type: object - scaling_group_guest_GetPropertyDistinctFieldOutput: {} - scaling_group_guest_GetPropertySplitableExportOutput: {} - scaling_group_guest_GetPropertySplitableOutput: {} - scaling_group_guest_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - scaling_group_guests: - items: - $ref: '#/definitions/GuestJointResourceDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - scaling_group_guest_PerformPurgeSplitableOutput: {} - scaling_group_guest_ValidateCreateDataOutput: - schema: - properties: - scaling_group_guest: - $ref: '#/definitions/GuestJointResourceDetails' - type: object - scaling_group_guest_ValidateUpdateDataOutput: - schema: - properties: - scaling_group_guest: - $ref: '#/definitions/GuestJointResourceDetails' - type: object - scaling_group_network_CustomizeDeleteOutput: - schema: - properties: - scaling_group_network: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - type: object - scaling_group_network_FetchCustomizeColumnsOutput: - schema: - properties: - scaling_group_network: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - type: object - scaling_group_network_GetPropertyDistinctFieldOutput: {} - scaling_group_network_GetPropertySplitableExportOutput: {} - scaling_group_network_GetPropertySplitableOutput: {} - scaling_group_network_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - scaling_group_networks: - items: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - scaling_group_network_PerformPurgeSplitableOutput: {} - scaling_group_network_ValidateCreateDataOutput: - schema: - properties: - scaling_group_network: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - type: object - scaling_group_network_ValidateUpdateDataOutput: - schema: - properties: - scaling_group_network: - $ref: '#/definitions/VirtualJointResourceBaseDetails' - type: object - scaling_policy_CustomizeDeleteOutput: - schema: - properties: - scaling_policy: - $ref: '#/definitions/ScalingPolicyDetails' - type: object - scaling_policy_FetchCustomizeColumnsOutput: - schema: - properties: - scaling_policy: - $ref: '#/definitions/ScalingPolicyDetails' - type: object - scaling_policy_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - scaling_policy: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - scaling_policy_GetDetailsClassMetadataOutput: - schema: - properties: - scaling_policy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_policy_GetDetailsMetadataOutput: - schema: - properties: - scaling_policy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_policy_GetDetailsStatusOutput: - schema: - properties: - scaling_policy: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - scaling_policy_GetPropertyDistinctFieldOutput: {} - scaling_policy_GetPropertyDomainStatisticsOutput: - schema: - properties: - scaling_policy: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - scaling_policy_GetPropertyProjectStatisticsOutput: - schema: - properties: - scaling_policy: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - scaling_policy_GetPropertyProjectTagValuePairsOutput: {} - scaling_policy_GetPropertyProjectTagValueTreeOutput: {} - scaling_policy_GetPropertySplitableExportOutput: {} - scaling_policy_GetPropertySplitableOutput: {} - scaling_policy_GetPropertyStatisticsOutput: - schema: - properties: - scaling_policy: - $ref: '#/definitions/StatusStatistic' - type: object - scaling_policy_GetPropertyTagValuePairsOutput: {} - scaling_policy_GetPropertyTagValueTreeOutput: {} - scaling_policy_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - scaling_policies: - items: - $ref: '#/definitions/ScalingPolicyDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - scaling_policy_PerformCancelDeleteOutput: {} - scaling_policy_PerformChangeOwnerOutput: {} - scaling_policy_PerformClassMetadataOutput: {} - scaling_policy_PerformDisableOutput: {} - scaling_policy_PerformEnableOutput: {} - scaling_policy_PerformFreezeOutput: {} - scaling_policy_PerformPurgeSplitableOutput: {} - scaling_policy_PerformSetClassMetadataOutput: {} - scaling_policy_PerformSetUserMetadataOutput: {} - scaling_policy_PerformStatusOutput: {} - scaling_policy_PerformTriggerOutput: {} - scaling_policy_PerformUnfreezeOutput: {} - scaling_policy_ValidateCreateDataOutput: - schema: - properties: - scaling_policy: - $ref: '#/definitions/ScalingPolicyDetails' - type: object - scaling_policy_ValidateUpdateDataOutput: - schema: - properties: - scaling_policy: - $ref: '#/definitions/ScalingPolicyDetails' - type: object - scaling_timer_CustomizeDeleteOutput: - schema: - properties: - scaling_timer: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - scaling_timer_FetchCustomizeColumnsOutput: - schema: - properties: - scaling_timer: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - scaling_timer_GetDetailsClassMetadataOutput: - schema: - properties: - scaling_timer: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_timer_GetDetailsMetadataOutput: - schema: - properties: - scaling_timer: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scaling_timer_GetPropertyDistinctFieldOutput: {} - scaling_timer_GetPropertySplitableExportOutput: {} - scaling_timer_GetPropertySplitableOutput: {} - scaling_timer_GetPropertyTagValuePairsOutput: {} - scaling_timer_GetPropertyTagValueTreeOutput: {} - scaling_timer_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - scaling_timers: - items: - $ref: '#/definitions/StandaloneResourceDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - scaling_timer_PerformClassMetadataOutput: {} - scaling_timer_PerformPurgeSplitableOutput: {} - scaling_timer_PerformSetClassMetadataOutput: {} - scaling_timer_PerformSetUserMetadataOutput: {} - scaling_timer_ValidateCreateDataOutput: - schema: - properties: - scaling_timer: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - scaling_timer_ValidateUpdateDataOutput: - schema: - properties: - scaling_timer: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - schedpolicy_CustomizeDeleteOutput: - schema: - properties: - schedpolicy: - $ref: '#/definitions/SchedpolicyDetails' - type: object - schedpolicy_FetchCustomizeColumnsOutput: - schema: - properties: - schedpolicy: - $ref: '#/definitions/SchedpolicyDetails' - type: object - schedpolicy_GetDetailsClassMetadataOutput: - schema: - properties: - schedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - schedpolicy_GetDetailsMetadataOutput: - schema: - properties: - schedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - schedpolicy_GetPropertyDistinctFieldOutput: {} - schedpolicy_GetPropertySplitableExportOutput: {} - schedpolicy_GetPropertySplitableOutput: {} - schedpolicy_GetPropertyTagValuePairsOutput: {} - schedpolicy_GetPropertyTagValueTreeOutput: {} - schedpolicy_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - schedpolicies: - items: - $ref: '#/definitions/SchedpolicyDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - schedpolicy_PerformClassMetadataOutput: {} - schedpolicy_PerformEvaluateOutput: {} - schedpolicy_PerformPurgeSplitableOutput: {} - schedpolicy_PerformSetClassMetadataOutput: {} - schedpolicy_PerformSetUserMetadataOutput: {} - schedpolicy_ValidateCreateDataOutput: - schema: - properties: - schedpolicy: - $ref: '#/definitions/SchedpolicyDetails' - type: object - schedpolicy_ValidateUpdateDataOutput: - schema: - properties: - schedpolicy: - $ref: '#/definitions/SchedpolicyDetails' - type: object - schedtag_CustomizeDeleteOutput: - schema: - properties: - schedtag: - $ref: '#/definitions/SchedtagDetails' - type: object - schedtag_FetchCustomizeColumnsOutput: - schema: - properties: - schedtag: - $ref: '#/definitions/SchedtagDetails' - type: object - schedtag_GetDetailsClassMetadataOutput: - schema: - properties: - schedtag: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - schedtag_GetDetailsMetadataOutput: - schema: - properties: - schedtag: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - schedtag_GetPropertyDistinctFieldOutput: {} - schedtag_GetPropertySplitableExportOutput: {} - schedtag_GetPropertySplitableOutput: {} - schedtag_GetPropertyTagValuePairsOutput: {} - schedtag_GetPropertyTagValueTreeOutput: {} - schedtag_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - schedtags: - items: - $ref: '#/definitions/SchedtagDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - schedtag_PerformClassMetadataOutput: {} - schedtag_PerformPurgeSplitableOutput: {} - schedtag_PerformSetClassMetadataOutput: {} - schedtag_PerformSetResourceOutput: {} - schedtag_PerformSetScopeOutput: {} - schedtag_PerformSetUserMetadataOutput: {} - schedtag_ValidateCreateDataOutput: - schema: - properties: - schedtag: - $ref: '#/definitions/SchedtagDetails' - type: object - schedtag_ValidateUpdateDataOutput: - schema: - properties: - schedtag: - $ref: '#/definitions/SchedtagDetails' - type: object - security_group_CustomizeDeleteOutput: - schema: - properties: - security_group: - $ref: '#/definitions/SecgroupDetails' - type: object - security_group_FetchCustomizeColumnsOutput: - schema: - properties: - security_group: - $ref: '#/definitions/SecgroupDetails' - type: object - security_group_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - security_group: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - security_group_GetDetailsClassMetadataOutput: - schema: - properties: - security_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - security_group_GetDetailsMetadataOutput: - schema: - properties: - security_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - security_group_GetDetailsStatusOutput: - schema: - properties: - security_group: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - security_group_GetPropertyDistinctFieldOutput: {} - security_group_GetPropertyDomainStatisticsOutput: - schema: - properties: - security_group: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - security_group_GetPropertyProjectStatisticsOutput: - schema: - properties: - security_group: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - security_group_GetPropertyProjectTagValuePairsOutput: {} - security_group_GetPropertyProjectTagValueTreeOutput: {} - security_group_GetPropertySplitableExportOutput: {} - security_group_GetPropertySplitableOutput: {} - security_group_GetPropertyStatisticsOutput: - schema: - properties: - security_group: - $ref: '#/definitions/StatusStatistic' - type: object - security_group_GetPropertyTagValuePairsOutput: {} - security_group_GetPropertyTagValueTreeOutput: {} - security_group_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - security_groups: - items: - $ref: '#/definitions/SecgroupDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - security_group_PerformAddRuleOutput: {} - security_group_PerformCacheSecgroupOutput: {} - security_group_PerformCancelDeleteOutput: {} - security_group_PerformChangeOwnerOutput: {} - security_group_PerformClassMetadataOutput: {} - security_group_PerformCloneOutput: - schema: - properties: - security_group: - $ref: '#/definitions/SecurityGroupCloneInput' - type: object - security_group_PerformFreezeOutput: {} - security_group_PerformImportRulesOutput: {} - security_group_PerformMergeOutput: {} - security_group_PerformPrivateOutput: {} - security_group_PerformPublicOutput: {} - security_group_PerformPurgeOutput: {} - security_group_PerformPurgeSplitableOutput: {} - security_group_PerformSetClassMetadataOutput: {} - security_group_PerformSetUserMetadataOutput: {} - security_group_PerformStatusOutput: {} - security_group_PerformUncacheSecgroupOutput: {} - security_group_PerformUnfreezeOutput: {} - security_group_ValidateCreateDataOutput: - schema: - properties: - security_group: - $ref: '#/definitions/SecgroupDetails' - type: object - security_group_ValidateUpdateDataOutput: - schema: - properties: - security_group: - $ref: '#/definitions/SecgroupDetails' - type: object - security_group_cache_CustomizeDeleteOutput: - schema: - properties: - security_group_cache: - $ref: '#/definitions/SecurityGroupCacheDetails' - type: object - security_group_cache_FetchCustomizeColumnsOutput: - schema: - properties: - security_group_cache: - $ref: '#/definitions/SecurityGroupCacheDetails' - type: object - security_group_cache_GetDetailsClassMetadataOutput: - schema: - properties: - security_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - security_group_cache_GetDetailsMetadataOutput: - schema: - properties: - security_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - security_group_cache_GetDetailsReferencesOutput: - schema: - properties: - security_group_cache: - items: - $ref: '#/definitions/SecurityGroupReference' - type: array - x-go-name: Output - type: object - security_group_cache_GetDetailsStatusOutput: - schema: - properties: - security_group_cache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - security_group_cache_GetPropertyDistinctFieldOutput: {} - security_group_cache_GetPropertySplitableExportOutput: {} - security_group_cache_GetPropertySplitableOutput: {} - security_group_cache_GetPropertyStatisticsOutput: - schema: - properties: - security_group_cache: - $ref: '#/definitions/StatusStatistic' - type: object - security_group_cache_GetPropertyTagValuePairsOutput: {} - security_group_cache_GetPropertyTagValueTreeOutput: {} - security_group_cache_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - security_group_caches: - items: - $ref: '#/definitions/SecurityGroupCacheDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - security_group_cache_PerformClassMetadataOutput: {} - security_group_cache_PerformPurgeSplitableOutput: {} - security_group_cache_PerformSetClassMetadataOutput: {} - security_group_cache_PerformSetUserMetadataOutput: {} - security_group_cache_PerformStatusOutput: {} - security_group_cache_PerformSyncstatusOutput: {} - security_group_cache_ValidateCreateDataOutput: - schema: - properties: - security_group_cache: - $ref: '#/definitions/SecurityGroupCacheDetails' - type: object - security_group_cache_ValidateUpdateDataOutput: - schema: - properties: - security_group_cache: - $ref: '#/definitions/SecurityGroupCacheDetails' - type: object - security_group_rule_CustomizeDeleteOutput: - schema: - properties: - security_group_rule: - $ref: '#/definitions/SecgroupRuleDetails' - type: object - security_group_rule_FetchCustomizeColumnsOutput: - schema: - properties: - security_group_rule: - $ref: '#/definitions/SecgroupRuleDetails' - type: object - security_group_rule_GetPropertyDistinctFieldOutput: {} - security_group_rule_GetPropertySplitableExportOutput: {} - security_group_rule_GetPropertySplitableOutput: {} - security_group_rule_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - security_group_rules: - items: - $ref: '#/definitions/SecgroupRuleDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - security_group_rule_PerformPurgeSplitableOutput: {} - security_group_rule_ValidateCreateDataOutput: - schema: - properties: - security_group_rule: - $ref: '#/definitions/SecgroupRuleDetails' - type: object - security_group_rule_ValidateUpdateDataOutput: - schema: - properties: - security_group_rule: - $ref: '#/definitions/SecgroupRuleDetails' - type: object - server_CustomizeDeleteOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerDetails' - type: object - server_FetchCustomizeColumnsOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerDetails' - type: object - server_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - server: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - server_GetDetailsClassMetadataOutput: - schema: - properties: - server: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - server_GetDetailsCpusetCoresOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerGetCPUSetCoresResp' - type: object - server_GetDetailsCreateParamsOutput: {} - server_GetDetailsDescOutput: {} - server_GetDetailsIsoOutput: {} - server_GetDetailsJnlpOutput: {} - server_GetDetailsMakeSshableCmdOutput: - schema: - properties: - server: - $ref: '#/definitions/GuestMakeSshableCmdOutput' - type: object - server_GetDetailsMetadataOutput: - schema: - properties: - server: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - server_GetDetailsQemuInfoOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerQemuInfo' - type: object - server_GetDetailsRemoteNicsOutput: {} - server_GetDetailsSshableOutput: {} - server_GetDetailsSshportOutput: - schema: - properties: - server: - $ref: '#/definitions/GuestSshportOutput' - type: object - server_GetDetailsStatusOutput: - schema: - properties: - server: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - server_GetDetailsTasksOutput: {} - server_GetDetailsVirtInstallOutput: {} - server_GetDetailsVncOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerVncOutput' - type: object - server_GetPropertyDistinctFieldOutput: {} - server_GetPropertyDomainStatisticsOutput: - schema: - properties: - server: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - server_GetPropertyProjectStatisticsOutput: - schema: - properties: - server: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - server_GetPropertyProjectTagValuePairsOutput: {} - server_GetPropertyProjectTagValueTreeOutput: {} - server_GetPropertySplitableExportOutput: {} - server_GetPropertySplitableOutput: {} - server_GetPropertyStatisticsOutput: - schema: - properties: - server: - $ref: '#/definitions/StatusStatistic' - type: object - server_GetPropertyTagValuePairsOutput: {} - server_GetPropertyTagValueTreeOutput: {} - server_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - servers: - items: - $ref: '#/definitions/ServerDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - server_PerformAddSecgroupOutput: {} - server_PerformAssignAdminSecgroupOutput: {} - server_PerformAssociateEipOutput: {} - server_PerformAttachIsolatedDeviceOutput: {} - server_PerformAttachdiskOutput: {} - server_PerformAttachnetworkOutput: - schema: - properties: - server: - $ref: '#/definitions/SGuest' - type: object - server_PerformBatchMigrateOutput: {} - server_PerformBatchSetUserMetadataOutput: {} - server_PerformBatchUserMetadataOutput: {} - server_PerformBindGroupsOutput: {} - server_PerformBlockMirrorReadyOutput: {} - server_PerformBlockStreamFailedOutput: {} - server_PerformCalculateRecordChecksumOutput: {} - server_PerformCancelDeleteOutput: {} - server_PerformCancelExpireOutput: {} - server_PerformCancelLiveMigrateOutput: {} - server_PerformChangeBandwidthOutput: {} - server_PerformChangeConfigOutput: {} - server_PerformChangeDiskStorageOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerChangeDiskStorageInput' - type: object - server_PerformChangeIpaddrOutput: {} - server_PerformChangeOwnerOutput: {} - server_PerformChangeStorageOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerChangeStorageInput' - type: object - server_PerformClassMetadataOutput: {} - server_PerformCloneOutput: {} - server_PerformCloseForwardOutput: {} - server_PerformConvertOutput: {} - server_PerformConvertToKvmOutput: {} - server_PerformCpusetOutput: {} - server_PerformCpusetRemoveOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerCPUSetRemoveResp' - type: object - server_PerformCreateBackupOutput: {} - server_PerformCreateEipOutput: {} - server_PerformCreatediskOutput: {} - server_PerformDelExtraOptionOutput: {} - server_PerformDeleteBackupOutput: {} - server_PerformDeployOutput: {} - server_PerformDetachIsolatedDeviceOutput: {} - server_PerformDetachScalingGroupOutput: {} - server_PerformDetachdiskOutput: {} - server_PerformDetachnetworkOutput: {} - server_PerformDirtyServerStartOutput: {} - server_PerformDirtyServerVerifyOutput: {} - server_PerformDissociateEipOutput: {} - server_PerformEjectisoOutput: {} - server_PerformEjectvfdOutput: {} - server_PerformEnableMemcleanOutput: {} - server_PerformEventOutput: {} - server_PerformFreezeOutput: {} - server_PerformHaveAgentOutput: - schema: - properties: - server: - $ref: '#/definitions/GuestHaveAgentOutput' - type: object - server_PerformImportFromLibvirtOutput: {} - server_PerformImportOutput: {} - server_PerformInsertisoOutput: {} - server_PerformInsertvfdOutput: {} - server_PerformInstanceBackupOutput: {} - server_PerformInstanceSnapshotOutput: {} - server_PerformInstanceSnapshotResetOutput: {} - server_PerformIoThrottleOutput: {} - server_PerformListForwardOutput: {} - server_PerformLiveMigrateOutput: {} - server_PerformMakeSshableOutput: - schema: - properties: - server: - $ref: '#/definitions/GuestMakeSshableOutput' - type: object - server_PerformMigrateForecastOutput: {} - server_PerformMigrateNetworkOutput: {} - server_PerformMigrateOutput: {} - server_PerformModifySrcCheckOutput: {} - server_PerformMonitorOutput: {} - server_PerformOpenForwardOutput: {} - server_PerformPostpaidExpireOutput: {} - server_PerformPrepaidRecycleOutput: {} - server_PerformProbeIsolatedDevicesOutput: {} - server_PerformPublicipToEipOutput: {} - server_PerformPurgeOutput: {} - server_PerformPurgeSplitableOutput: {} - server_PerformQgaCommandOutput: {} - server_PerformQgaSetPasswordOutput: {} - server_PerformRebuildRootOutput: - schema: - properties: - server: - $ref: '#/definitions/SGuest' - type: object - server_PerformRemoteUpdateOutput: {} - server_PerformRenewOutput: {} - server_PerformResetOutput: {} - server_PerformResizeDiskOutput: {} - server_PerformRestartOutput: {} - server_PerformResumeOutput: {} - server_PerformRevokeAdminSecgroupOutput: {} - server_PerformRevokeSecgroupOutput: {} - server_PerformSaveGuestImageOutput: {} - server_PerformSaveImageOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerSaveImageInput' - type: object - server_PerformSaveTemplateOutput: {} - server_PerformSendkeysOutput: {} - server_PerformSetAutoRenewOutput: {} - server_PerformSetBootIndexOutput: {} - server_PerformSetClassMetadataOutput: {} - server_PerformSetExtraOptionOutput: {} - server_PerformSetIsolatedDeviceOutput: {} - server_PerformSetLiveMigrateParamsOutput: {} - server_PerformSetPasswordOutput: {} - server_PerformSetQemuParamsOutput: {} - server_PerformSetSecgroupOutput: {} - server_PerformSetSshportOutput: {} - server_PerformSetUserMetadataOutput: {} - server_PerformSlaveBlockStreamReadyOutput: {} - server_PerformSnapshotAndCloneOutput: {} - server_PerformStartBackupOutput: {} - server_PerformStartOutput: {} - server_PerformStatusOutput: {} - server_PerformStopOutput: {} - server_PerformStreamDisksCompleteOutput: {} - server_PerformSuspendOutput: {} - server_PerformSwitchToBackupOutput: {} - server_PerformSyncFixNicsOutput: {} - server_PerformSyncOutput: {} - server_PerformSyncstatusOutput: {} - server_PerformUnbindGroupsOutput: {} - server_PerformUndoPrepaidRecycleOutput: {} - server_PerformUnfreezeOutput: {} - server_PerformUserDataOutput: {} - server_ValidateCreateDataOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerDetails' - type: object - server_ValidateUpdateDataOutput: - schema: - properties: - server: - $ref: '#/definitions/ServerDetails' - type: object - server_sku_CustomizeDeleteOutput: - schema: - properties: - server_sku: - $ref: '#/definitions/ServerSkuDetails' - type: object - server_sku_FetchCustomizeColumnsOutput: - schema: - properties: - server_sku: - $ref: '#/definitions/ServerSkuDetails' - type: object - server_sku_GetDetailsClassMetadataOutput: - schema: - properties: - server_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - server_sku_GetDetailsMetadataOutput: - schema: - properties: - server_sku: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - server_sku_GetDetailsStatusOutput: - schema: - properties: - server_sku: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - server_sku_GetPropertyDistinctFieldOutput: {} - server_sku_GetPropertyInstanceSpecsOutput: {} - server_sku_GetPropertySplitableExportOutput: {} - server_sku_GetPropertySplitableOutput: {} - server_sku_GetPropertyStatisticsOutput: - schema: - properties: - server_sku: - $ref: '#/definitions/StatusStatistic' - type: object - server_sku_GetPropertySyncTasksOutput: {} - server_sku_GetPropertyTagValuePairsOutput: {} - server_sku_GetPropertyTagValueTreeOutput: {} - server_sku_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - server_skus: - items: - $ref: '#/definitions/ServerSkuDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - server_sku_PerformClassMetadataOutput: {} - server_sku_PerformDisableOutput: {} - server_sku_PerformEnableOutput: {} - server_sku_PerformPurgeSplitableOutput: {} - server_sku_PerformSetClassMetadataOutput: {} - server_sku_PerformSetUserMetadataOutput: {} - server_sku_PerformStatusOutput: {} - server_sku_PerformSyncSkusOutput: {} - server_sku_ValidateCreateDataOutput: - schema: - properties: - server_sku: - $ref: '#/definitions/ServerSkuDetails' - type: object - server_sku_ValidateUpdateDataOutput: - schema: - properties: - server_sku: - $ref: '#/definitions/ServerSkuDetails' - type: object - service_catalog_CustomizeDeleteOutput: - schema: - properties: - service_catalog: - $ref: '#/definitions/ServiceCatalogDetails' - type: object - service_catalog_FetchCustomizeColumnsOutput: - schema: - properties: - service_catalog: - $ref: '#/definitions/ServiceCatalogDetails' - type: object - service_catalog_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - service_catalog: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - service_catalog_GetDetailsClassMetadataOutput: - schema: - properties: - service_catalog: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - service_catalog_GetDetailsMetadataOutput: - schema: - properties: - service_catalog: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - service_catalog_GetDetailsStatusOutput: - schema: - properties: - service_catalog: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - service_catalog_GetPropertyDistinctFieldOutput: {} - service_catalog_GetPropertyDomainStatisticsOutput: - schema: - properties: - service_catalog: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - service_catalog_GetPropertyProjectStatisticsOutput: - schema: - properties: - service_catalog: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - service_catalog_GetPropertyProjectTagValuePairsOutput: {} - service_catalog_GetPropertyProjectTagValueTreeOutput: {} - service_catalog_GetPropertySplitableExportOutput: {} - service_catalog_GetPropertySplitableOutput: {} - service_catalog_GetPropertyStatisticsOutput: - schema: - properties: - service_catalog: - $ref: '#/definitions/StatusStatistic' - type: object - service_catalog_GetPropertyTagValuePairsOutput: {} - service_catalog_GetPropertyTagValueTreeOutput: {} - service_catalog_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - service_catalogs: - items: - $ref: '#/definitions/ServiceCatalogDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - service_catalog_PerformCancelDeleteOutput: {} - service_catalog_PerformChangeOwnerOutput: {} - service_catalog_PerformClassMetadataOutput: {} - service_catalog_PerformDeployOutput: {} - service_catalog_PerformFreezeOutput: {} - service_catalog_PerformPrivateOutput: {} - service_catalog_PerformPublicOutput: {} - service_catalog_PerformPurgeSplitableOutput: {} - service_catalog_PerformSetClassMetadataOutput: {} - service_catalog_PerformSetUserMetadataOutput: {} - service_catalog_PerformStatusOutput: {} - service_catalog_PerformUnfreezeOutput: {} - service_catalog_ValidateCreateDataOutput: - schema: - properties: - service_catalog: - $ref: '#/definitions/ServiceCatalogDetails' - type: object - service_catalog_ValidateUpdateDataOutput: - schema: - properties: - service_catalog: - $ref: '#/definitions/ServiceCatalogDetails' - type: object - snapshot_CustomizeDeleteOutput: - schema: - properties: - snapshot: - $ref: '#/definitions/SnapshotDetails' - type: object - snapshot_FetchCustomizeColumnsOutput: - schema: - properties: - snapshot: - $ref: '#/definitions/SnapshotDetails' - type: object - snapshot_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - snapshot: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - snapshot_GetDetailsClassMetadataOutput: - schema: - properties: - snapshot: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - snapshot_GetDetailsMetadataOutput: - schema: - properties: - snapshot: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - snapshot_GetDetailsStatusOutput: - schema: - properties: - snapshot: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - snapshot_GetPropertyDistinctFieldOutput: {} - snapshot_GetPropertyDomainStatisticsOutput: - schema: - properties: - snapshot: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - snapshot_GetPropertyMaxCountOutput: {} - snapshot_GetPropertyProjectStatisticsOutput: - schema: - properties: - snapshot: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - snapshot_GetPropertyProjectTagValuePairsOutput: {} - snapshot_GetPropertyProjectTagValueTreeOutput: {} - snapshot_GetPropertySplitableExportOutput: {} - snapshot_GetPropertySplitableOutput: {} - snapshot_GetPropertyStatisticsOutput: - schema: - properties: - snapshot: - $ref: '#/definitions/StatusStatistic' - type: object - snapshot_GetPropertyTagValuePairsOutput: {} - snapshot_GetPropertyTagValueTreeOutput: {} - snapshot_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - snapshots: - items: - $ref: '#/definitions/SnapshotDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - snapshot_PerformCancelDeleteOutput: {} - snapshot_PerformChangeOwnerOutput: {} - snapshot_PerformClassMetadataOutput: {} - snapshot_PerformDeleteDiskSnapshotsOutput: {} - snapshot_PerformDeletedOutput: {} - snapshot_PerformFreezeOutput: {} - snapshot_PerformPurgeOutput: {} - snapshot_PerformPurgeSplitableOutput: {} - snapshot_PerformSetClassMetadataOutput: {} - snapshot_PerformSetUserMetadataOutput: {} - snapshot_PerformStatusOutput: {} - snapshot_PerformSyncstatusOutput: {} - snapshot_PerformUnfreezeOutput: {} - snapshot_ValidateCreateDataOutput: - schema: - properties: - snapshot: - $ref: '#/definitions/SnapshotDetails' - type: object - snapshot_ValidateUpdateDataOutput: - schema: - properties: - snapshot: - $ref: '#/definitions/SnapshotDetails' - type: object - snapshot_policy_CustomizeDeleteOutput: - schema: - properties: - snapshot_policy: - $ref: '#/definitions/SnapshotPolicyDetails' - type: object - snapshot_policy_FetchCustomizeColumnsOutput: - schema: - properties: - snapshot_policy: - $ref: '#/definitions/SnapshotPolicyDetails' - type: object - snapshot_policy_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - snapshot_policy: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - snapshot_policy_GetDetailsClassMetadataOutput: - schema: - properties: - snapshot_policy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - snapshot_policy_GetDetailsMetadataOutput: - schema: - properties: - snapshot_policy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - snapshot_policy_GetDetailsStatusOutput: - schema: - properties: - snapshot_policy: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - snapshot_policy_GetPropertyDistinctFieldOutput: {} - snapshot_policy_GetPropertyDomainStatisticsOutput: - schema: - properties: - snapshot_policy: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - snapshot_policy_GetPropertyProjectStatisticsOutput: - schema: - properties: - snapshot_policy: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - snapshot_policy_GetPropertyProjectTagValuePairsOutput: {} - snapshot_policy_GetPropertyProjectTagValueTreeOutput: {} - snapshot_policy_GetPropertySplitableExportOutput: {} - snapshot_policy_GetPropertySplitableOutput: {} - snapshot_policy_GetPropertyStatisticsOutput: - schema: - properties: - snapshot_policy: - $ref: '#/definitions/StatusStatistic' - type: object - snapshot_policy_GetPropertyTagValuePairsOutput: {} - snapshot_policy_GetPropertyTagValueTreeOutput: {} - snapshot_policy_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - snapshot_policies: - items: - $ref: '#/definitions/SnapshotPolicyDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - snapshot_policy_PerformBindDisksOutput: {} - snapshot_policy_PerformCacheOutput: {} - snapshot_policy_PerformCancelDeleteOutput: {} - snapshot_policy_PerformChangeOwnerOutput: {} - snapshot_policy_PerformClassMetadataOutput: {} - snapshot_policy_PerformFreezeOutput: {} - snapshot_policy_PerformPurgeSplitableOutput: {} - snapshot_policy_PerformSetClassMetadataOutput: {} - snapshot_policy_PerformSetUserMetadataOutput: {} - snapshot_policy_PerformStatusOutput: {} - snapshot_policy_PerformUnbindDisksOutput: {} - snapshot_policy_PerformUnfreezeOutput: {} - snapshot_policy_PerformUpdateOutput: {} - snapshot_policy_ValidateCreateDataOutput: - schema: - properties: - snapshot_policy: - $ref: '#/definitions/SnapshotPolicyDetails' - type: object - snapshot_policy_ValidateUpdateDataOutput: - schema: - properties: - snapshot_policy: - $ref: '#/definitions/SnapshotPolicyDetails' - type: object - snapshot_policy_cache_CustomizeDeleteOutput: - schema: - properties: - snapshot_policy_cache: - $ref: '#/definitions/SnapshotPolicyCacheDetails' - type: object - snapshot_policy_cache_FetchCustomizeColumnsOutput: - schema: - properties: - snapshot_policy_cache: - $ref: '#/definitions/SnapshotPolicyCacheDetails' - type: object - snapshot_policy_cache_GetDetailsClassMetadataOutput: - schema: - properties: - snapshot_policy_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - snapshot_policy_cache_GetDetailsMetadataOutput: - schema: - properties: - snapshot_policy_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - snapshot_policy_cache_GetDetailsStatusOutput: - schema: - properties: - snapshot_policy_cache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - snapshot_policy_cache_GetPropertyDistinctFieldOutput: {} - snapshot_policy_cache_GetPropertySplitableExportOutput: {} - snapshot_policy_cache_GetPropertySplitableOutput: {} - snapshot_policy_cache_GetPropertyStatisticsOutput: - schema: - properties: - snapshot_policy_cache: - $ref: '#/definitions/StatusStatistic' - type: object - snapshot_policy_cache_GetPropertyTagValuePairsOutput: {} - snapshot_policy_cache_GetPropertyTagValueTreeOutput: {} - snapshot_policy_cache_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - snapshot_policy_caches: - items: - $ref: '#/definitions/SnapshotPolicyCacheDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - snapshot_policy_cache_PerformClassMetadataOutput: {} - snapshot_policy_cache_PerformPurgeSplitableOutput: {} - snapshot_policy_cache_PerformSetClassMetadataOutput: {} - snapshot_policy_cache_PerformSetUserMetadataOutput: {} - snapshot_policy_cache_PerformStatusOutput: {} - snapshot_policy_cache_ValidateCreateDataOutput: - schema: - properties: - snapshot_policy_cache: - $ref: '#/definitions/SnapshotPolicyCacheDetails' - type: object - snapshot_policy_cache_ValidateUpdateDataOutput: - schema: - properties: - snapshot_policy_cache: - $ref: '#/definitions/SnapshotPolicyCacheDetails' - type: object - snapshot_policy_disk_CustomizeDeleteOutput: - schema: - properties: - snapshot_policy_disk: - $ref: '#/definitions/SnapshotPolicyDiskDetails' - type: object - snapshot_policy_disk_FetchCustomizeColumnsOutput: - schema: - properties: - snapshot_policy_disk: - $ref: '#/definitions/SnapshotPolicyDiskDetails' - type: object - snapshot_policy_disk_GetPropertyDistinctFieldOutput: {} - snapshot_policy_disk_GetPropertySplitableExportOutput: {} - snapshot_policy_disk_GetPropertySplitableOutput: {} - snapshot_policy_disk_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - snapshot_policy_disks: - items: - $ref: '#/definitions/SnapshotPolicyDiskDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - snapshot_policy_disk_PerformPurgeSplitableOutput: {} - snapshot_policy_disk_ValidateCreateDataOutput: - schema: - properties: - snapshot_policy_disk: - $ref: '#/definitions/SnapshotPolicyDiskDetails' - type: object - snapshot_policy_disk_ValidateUpdateDataOutput: - schema: - properties: - snapshot_policy_disk: - $ref: '#/definitions/SnapshotPolicyDiskDetails' - type: object - storage_CustomizeDeleteOutput: - schema: - properties: - storage: - $ref: '#/definitions/StorageDetails' - type: object - storage_FetchCustomizeColumnsOutput: - schema: - properties: - storage: - $ref: '#/definitions/StorageDetails' - type: object - storage_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - storage: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - storage_GetDetailsClassMetadataOutput: - schema: - properties: - storage: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - storage_GetDetailsMetadataOutput: - schema: - properties: - storage: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - storage_GetDetailsStatusOutput: - schema: - properties: - storage: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - storage_GetPropertyDistinctFieldOutput: {} - storage_GetPropertyDomainTagValuePairsOutput: {} - storage_GetPropertyDomainTagValueTreeOutput: {} - storage_GetPropertySplitableExportOutput: {} - storage_GetPropertySplitableOutput: {} - storage_GetPropertyStatisticsOutput: - schema: - properties: - storage: - $ref: '#/definitions/StatusStatistic' - type: object - storage_GetPropertyTagValuePairsOutput: {} - storage_GetPropertyTagValueTreeOutput: {} - storage_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - storages: - items: - $ref: '#/definitions/StorageDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - storage_PerformCacheImageOutput: {} - storage_PerformChangeOwnerOutput: {} - storage_PerformClassMetadataOutput: {} - storage_PerformDisableOutput: {} - storage_PerformEnableOutput: {} - storage_PerformForceDetachHostOutput: {} - storage_PerformOfflineOutput: {} - storage_PerformOnlineOutput: {} - storage_PerformPrivateOutput: {} - storage_PerformPublicOutput: {} - storage_PerformPurgeSplitableOutput: {} - storage_PerformSetClassMetadataOutput: {} - storage_PerformSetSchedtagOutput: {} - storage_PerformSetUserMetadataOutput: {} - storage_PerformStatusOutput: {} - storage_PerformUncacheImageOutput: {} - storage_ValidateCreateDataOutput: - schema: - properties: - storage: - $ref: '#/definitions/StorageDetails' - type: object - storage_ValidateUpdateDataOutput: - schema: - properties: - storage: - $ref: '#/definitions/StorageDetails' - type: object - storagecache_CustomizeDeleteOutput: - schema: - properties: - storagecache: - $ref: '#/definitions/StoragecacheDetails' - type: object - storagecache_FetchCustomizeColumnsOutput: - schema: - properties: - storagecache: - $ref: '#/definitions/StoragecacheDetails' - type: object - storagecache_GetDetailsClassMetadataOutput: - schema: - properties: - storagecache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - storagecache_GetDetailsMetadataOutput: - schema: - properties: - storagecache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - storagecache_GetPropertyDistinctFieldOutput: {} - storagecache_GetPropertySplitableExportOutput: {} - storagecache_GetPropertySplitableOutput: {} - storagecache_GetPropertyTagValuePairsOutput: {} - storagecache_GetPropertyTagValueTreeOutput: {} - storagecache_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - storagecaches: - items: - $ref: '#/definitions/StoragecacheDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - storagecache_PerformCacheImageOutput: {} - storagecache_PerformClassMetadataOutput: {} - storagecache_PerformPurgeSplitableOutput: {} - storagecache_PerformSetClassMetadataOutput: {} - storagecache_PerformSetUserMetadataOutput: {} - storagecache_PerformUncacheImageOutput: {} - storagecache_ValidateCreateDataOutput: - schema: - properties: - storagecache: - $ref: '#/definitions/StoragecacheDetails' - type: object - storagecache_ValidateUpdateDataOutput: - schema: - properties: - storagecache: - $ref: '#/definitions/StoragecacheDetails' - type: object - storagecachedimage_CustomizeDeleteOutput: - schema: - properties: - storagecachedimage: - $ref: '#/definitions/StoragecachedimageDetails' - type: object - storagecachedimage_FetchCustomizeColumnsOutput: - schema: - properties: - storagecachedimage: - $ref: '#/definitions/StoragecachedimageDetails' - type: object - storagecachedimage_GetPropertyDistinctFieldOutput: {} - storagecachedimage_GetPropertySplitableExportOutput: {} - storagecachedimage_GetPropertySplitableOutput: {} - storagecachedimage_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - storagecachedimages: - items: - $ref: '#/definitions/StoragecachedimageDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - storagecachedimage_PerformPurgeSplitableOutput: {} - storagecachedimage_ValidateCreateDataOutput: - schema: - properties: - storagecachedimage: - $ref: '#/definitions/StoragecachedimageDetails' - type: object - storagecachedimage_ValidateUpdateDataOutput: - schema: - properties: - storagecachedimage: - $ref: '#/definitions/StoragecachedimageDetails' - type: object - tablestore_CustomizeDeleteOutput: - schema: - properties: - tablestore: - $ref: '#/definitions/TablestoreDetails' - type: object - tablestore_FetchCustomizeColumnsOutput: - schema: - properties: - tablestore: - $ref: '#/definitions/TablestoreDetails' - type: object - tablestore_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - tablestore: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - tablestore_GetDetailsClassMetadataOutput: - schema: - properties: - tablestore: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - tablestore_GetDetailsMetadataOutput: - schema: - properties: - tablestore: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - tablestore_GetDetailsStatusOutput: - schema: - properties: - tablestore: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - tablestore_GetPropertyDistinctFieldOutput: {} - tablestore_GetPropertyDomainStatisticsOutput: - schema: - properties: - tablestore: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - tablestore_GetPropertyProjectStatisticsOutput: - schema: - properties: - tablestore: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - tablestore_GetPropertyProjectTagValuePairsOutput: {} - tablestore_GetPropertyProjectTagValueTreeOutput: {} - tablestore_GetPropertySplitableExportOutput: {} - tablestore_GetPropertySplitableOutput: {} - tablestore_GetPropertyStatisticsOutput: - schema: - properties: - tablestore: - $ref: '#/definitions/StatusStatistic' - type: object - tablestore_GetPropertyTagValuePairsOutput: {} - tablestore_GetPropertyTagValueTreeOutput: {} - tablestore_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - tablestores: - items: - $ref: '#/definitions/TablestoreDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - tablestore_PerformCancelDeleteOutput: {} - tablestore_PerformChangeOwnerOutput: {} - tablestore_PerformClassMetadataOutput: {} - tablestore_PerformFreezeOutput: {} - tablestore_PerformPurgeSplitableOutput: {} - tablestore_PerformSetClassMetadataOutput: {} - tablestore_PerformSetUserMetadataOutput: {} - tablestore_PerformStatusOutput: {} - tablestore_PerformUnfreezeOutput: {} - tablestore_ValidateCreateDataOutput: - schema: - properties: - tablestore: - $ref: '#/definitions/TablestoreDetails' - type: object - tablestore_ValidateUpdateDataOutput: - schema: - properties: - tablestore: - $ref: '#/definitions/TablestoreDetails' - type: object - vpc_CustomizeDeleteOutput: - schema: - properties: - vpc: - $ref: '#/definitions/VpcDetails' - type: object - vpc_FetchCustomizeColumnsOutput: - schema: - properties: - vpc: - $ref: '#/definitions/VpcDetails' - type: object - vpc_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - vpc: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - vpc_GetDetailsClassMetadataOutput: - schema: - properties: - vpc: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - vpc_GetDetailsMetadataOutput: - schema: - properties: - vpc: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - vpc_GetDetailsStatusOutput: - schema: - properties: - vpc: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - vpc_GetDetailsTopologyOutput: - schema: - properties: - vpc: - $ref: '#/definitions/VpcTopologyOutput' - type: object - vpc_GetPropertyDistinctFieldOutput: {} - vpc_GetPropertyDomainTagValuePairsOutput: {} - vpc_GetPropertyDomainTagValueTreeOutput: {} - vpc_GetPropertySplitableExportOutput: {} - vpc_GetPropertySplitableOutput: {} - vpc_GetPropertyStatisticsOutput: - schema: - properties: - vpc: - $ref: '#/definitions/StatusStatistic' - type: object - vpc_GetPropertyTagValuePairsOutput: {} - vpc_GetPropertyTagValueTreeOutput: {} - vpc_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 - vpcs: - items: - $ref: '#/definitions/VpcDetails' - type: array - x-go-name: Output - type: object - vpc_PerformChangeOwnerOutput: {} - vpc_PerformClassMetadataOutput: {} - vpc_PerformDisableOutput: {} - vpc_PerformEnableOutput: {} - vpc_PerformPrivateOutput: {} - vpc_PerformPublicOutput: {} - vpc_PerformPurgeOutput: {} - vpc_PerformPurgeSplitableOutput: {} - vpc_PerformSetClassMetadataOutput: {} - vpc_PerformSetUserMetadataOutput: {} - vpc_PerformStatusOutput: {} - vpc_PerformSyncOutput: {} - vpc_PerformSyncstatusOutput: {} - vpc_ValidateCreateDataOutput: - schema: - properties: - vpc: - $ref: '#/definitions/VpcDetails' - type: object - vpc_ValidateUpdateDataOutput: - schema: - properties: - vpc: - $ref: '#/definitions/VpcDetails' - type: object - vpc_peering_connection_CustomizeDeleteOutput: - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/VpcPeeringConnectionDetails' - type: object - vpc_peering_connection_FetchCustomizeColumnsOutput: - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/VpcPeeringConnectionDetails' - type: object - vpc_peering_connection_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - vpc_peering_connection_GetDetailsClassMetadataOutput: - schema: - properties: - vpc_peering_connection: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - vpc_peering_connection_GetDetailsMetadataOutput: - schema: - properties: - vpc_peering_connection: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - vpc_peering_connection_GetDetailsStatusOutput: - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - vpc_peering_connection_GetPropertyDistinctFieldOutput: {} - vpc_peering_connection_GetPropertyDomainTagValuePairsOutput: {} - vpc_peering_connection_GetPropertyDomainTagValueTreeOutput: {} - vpc_peering_connection_GetPropertySplitableExportOutput: {} - vpc_peering_connection_GetPropertySplitableOutput: {} - vpc_peering_connection_GetPropertyStatisticsOutput: - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/StatusStatistic' - type: object - vpc_peering_connection_GetPropertyTagValuePairsOutput: {} - vpc_peering_connection_GetPropertyTagValueTreeOutput: {} - vpc_peering_connection_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 - vpc_peering_connections: - items: - $ref: '#/definitions/VpcPeeringConnectionDetails' - type: array - x-go-name: Output - type: object - vpc_peering_connection_PerformChangeOwnerOutput: {} - vpc_peering_connection_PerformClassMetadataOutput: {} - vpc_peering_connection_PerformDisableOutput: {} - vpc_peering_connection_PerformEnableOutput: {} - vpc_peering_connection_PerformPrivateOutput: {} - vpc_peering_connection_PerformPublicOutput: {} - vpc_peering_connection_PerformPurgeSplitableOutput: {} - vpc_peering_connection_PerformSetClassMetadataOutput: {} - vpc_peering_connection_PerformSetUserMetadataOutput: {} - vpc_peering_connection_PerformStatusOutput: {} - vpc_peering_connection_PerformSyncstatusOutput: {} - vpc_peering_connection_ValidateCreateDataOutput: - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/VpcPeeringConnectionDetails' - type: object - vpc_peering_connection_ValidateUpdateDataOutput: - schema: - properties: - vpc_peering_connection: - $ref: '#/definitions/VpcPeeringConnectionDetails' - type: object - waf_instance_CustomizeDeleteOutput: - schema: - properties: - waf_instance: - $ref: '#/definitions/WafInstanceDetails' - type: object - waf_instance_FetchCustomizeColumnsOutput: - schema: - properties: - waf_instance: - $ref: '#/definitions/WafInstanceDetails' - type: object - waf_instance_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - waf_instance: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - waf_instance_GetDetailsClassMetadataOutput: - schema: - properties: - waf_instance: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_instance_GetDetailsCloudResourcesOutput: - schema: - properties: - waf_instance: - $ref: '#/definitions/SCloudResources' - type: object - waf_instance_GetDetailsMetadataOutput: - schema: - properties: - waf_instance: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_instance_GetDetailsStatusOutput: - schema: - properties: - waf_instance: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - waf_instance_GetPropertyDistinctFieldOutput: {} - waf_instance_GetPropertyDomainTagValuePairsOutput: {} - waf_instance_GetPropertyDomainTagValueTreeOutput: {} - waf_instance_GetPropertySplitableExportOutput: {} - waf_instance_GetPropertySplitableOutput: {} - waf_instance_GetPropertyStatisticsOutput: - schema: - properties: - waf_instance: - $ref: '#/definitions/StatusStatistic' - type: object - waf_instance_GetPropertyTagValuePairsOutput: {} - waf_instance_GetPropertyTagValueTreeOutput: {} - waf_instance_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 - waf_instances: - items: - $ref: '#/definitions/WafInstanceDetails' - type: array - x-go-name: Output - type: object - waf_instance_PerformChangeOwnerOutput: {} - waf_instance_PerformClassMetadataOutput: {} - waf_instance_PerformDisableOutput: {} - waf_instance_PerformEnableOutput: {} - waf_instance_PerformPrivateOutput: {} - waf_instance_PerformPublicOutput: {} - waf_instance_PerformPurgeSplitableOutput: {} - waf_instance_PerformRemoteUpdateOutput: {} - waf_instance_PerformSetClassMetadataOutput: {} - waf_instance_PerformSetUserMetadataOutput: {} - waf_instance_PerformStatusOutput: {} - waf_instance_PerformSyncstatusOutput: {} - waf_instance_ValidateCreateDataOutput: - schema: - properties: - waf_instance: - $ref: '#/definitions/WafInstanceDetails' - type: object - waf_instance_ValidateUpdateDataOutput: - schema: - properties: - waf_instance: - $ref: '#/definitions/WafInstanceDetails' - type: object - waf_ip_set_CustomizeDeleteOutput: - schema: - properties: - waf_ip_set: - $ref: '#/definitions/WafIPSetDetails' - type: object - waf_ip_set_FetchCustomizeColumnsOutput: - schema: - properties: - waf_ip_set: - $ref: '#/definitions/WafIPSetDetails' - type: object - waf_ip_set_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - waf_ip_set: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - waf_ip_set_GetDetailsClassMetadataOutput: - schema: - properties: - waf_ip_set: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_ip_set_GetDetailsMetadataOutput: - schema: - properties: - waf_ip_set: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_ip_set_GetDetailsStatusOutput: - schema: - properties: - waf_ip_set: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - waf_ip_set_GetPropertyDistinctFieldOutput: {} - waf_ip_set_GetPropertyDomainTagValuePairsOutput: {} - waf_ip_set_GetPropertyDomainTagValueTreeOutput: {} - waf_ip_set_GetPropertySplitableExportOutput: {} - waf_ip_set_GetPropertySplitableOutput: {} - waf_ip_set_GetPropertyStatisticsOutput: - schema: - properties: - waf_ip_set: - $ref: '#/definitions/StatusStatistic' - type: object - waf_ip_set_GetPropertyTagValuePairsOutput: {} - waf_ip_set_GetPropertyTagValueTreeOutput: {} - waf_ip_set_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 - waf_ip_sets: - items: - $ref: '#/definitions/WafIPSetDetails' - type: array - x-go-name: Output - type: object - waf_ip_set_PerformChangeOwnerOutput: {} - waf_ip_set_PerformClassMetadataOutput: {} - waf_ip_set_PerformPrivateOutput: {} - waf_ip_set_PerformPublicOutput: {} - waf_ip_set_PerformPurgeSplitableOutput: {} - waf_ip_set_PerformSetClassMetadataOutput: {} - waf_ip_set_PerformSetUserMetadataOutput: {} - waf_ip_set_PerformStatusOutput: {} - waf_ip_set_ValidateCreateDataOutput: - schema: - properties: - waf_ip_set: - $ref: '#/definitions/WafIPSetDetails' - type: object - waf_ip_set_ValidateUpdateDataOutput: - schema: - properties: - waf_ip_set: - $ref: '#/definitions/WafIPSetDetails' - type: object - waf_ip_set_cache_CustomizeDeleteOutput: - schema: - properties: - waf_ip_set_cache: - $ref: '#/definitions/WafIPSetCacheDetails' - type: object - waf_ip_set_cache_FetchCustomizeColumnsOutput: - schema: - properties: - waf_ip_set_cache: - $ref: '#/definitions/WafIPSetCacheDetails' - type: object - waf_ip_set_cache_GetDetailsClassMetadataOutput: - schema: - properties: - waf_ip_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_ip_set_cache_GetDetailsMetadataOutput: - schema: - properties: - waf_ip_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_ip_set_cache_GetDetailsStatusOutput: - schema: - properties: - waf_ip_set_cache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - waf_ip_set_cache_GetPropertyDistinctFieldOutput: {} - waf_ip_set_cache_GetPropertySplitableExportOutput: {} - waf_ip_set_cache_GetPropertySplitableOutput: {} - waf_ip_set_cache_GetPropertyStatisticsOutput: - schema: - properties: - waf_ip_set_cache: - $ref: '#/definitions/StatusStatistic' - type: object - waf_ip_set_cache_GetPropertyTagValuePairsOutput: {} - waf_ip_set_cache_GetPropertyTagValueTreeOutput: {} - waf_ip_set_cache_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 - waf_ip_set_caches: - items: - $ref: '#/definitions/WafIPSetCacheDetails' - type: array - x-go-name: Output - type: object - waf_ip_set_cache_PerformClassMetadataOutput: {} - waf_ip_set_cache_PerformPurgeSplitableOutput: {} - waf_ip_set_cache_PerformSetClassMetadataOutput: {} - waf_ip_set_cache_PerformSetUserMetadataOutput: {} - waf_ip_set_cache_PerformStatusOutput: {} - waf_ip_set_cache_ValidateCreateDataOutput: - schema: - properties: - waf_ip_set_cache: - $ref: '#/definitions/WafIPSetCacheDetails' - type: object - waf_ip_set_cache_ValidateUpdateDataOutput: - schema: - properties: - waf_ip_set_cache: - $ref: '#/definitions/WafIPSetCacheDetails' - type: object - waf_regex_set_CustomizeDeleteOutput: - schema: - properties: - waf_regex_set: - $ref: '#/definitions/WafRegexSetDetails' - type: object - waf_regex_set_FetchCustomizeColumnsOutput: - schema: - properties: - waf_regex_set: - $ref: '#/definitions/WafRegexSetDetails' - type: object - waf_regex_set_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - waf_regex_set: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - waf_regex_set_GetDetailsClassMetadataOutput: - schema: - properties: - waf_regex_set: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_regex_set_GetDetailsMetadataOutput: - schema: - properties: - waf_regex_set: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_regex_set_GetDetailsStatusOutput: - schema: - properties: - waf_regex_set: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - waf_regex_set_GetPropertyDistinctFieldOutput: {} - waf_regex_set_GetPropertyDomainTagValuePairsOutput: {} - waf_regex_set_GetPropertyDomainTagValueTreeOutput: {} - waf_regex_set_GetPropertySplitableExportOutput: {} - waf_regex_set_GetPropertySplitableOutput: {} - waf_regex_set_GetPropertyStatisticsOutput: - schema: - properties: - waf_regex_set: - $ref: '#/definitions/StatusStatistic' - type: object - waf_regex_set_GetPropertyTagValuePairsOutput: {} - waf_regex_set_GetPropertyTagValueTreeOutput: {} - waf_regex_set_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 - waf_regex_sets: - items: - $ref: '#/definitions/WafRegexSetDetails' - type: array - x-go-name: Output - type: object - waf_regex_set_PerformChangeOwnerOutput: {} - waf_regex_set_PerformClassMetadataOutput: {} - waf_regex_set_PerformPrivateOutput: {} - waf_regex_set_PerformPublicOutput: {} - waf_regex_set_PerformPurgeSplitableOutput: {} - waf_regex_set_PerformSetClassMetadataOutput: {} - waf_regex_set_PerformSetUserMetadataOutput: {} - waf_regex_set_PerformStatusOutput: {} - waf_regex_set_ValidateCreateDataOutput: - schema: - properties: - waf_regex_set: - $ref: '#/definitions/WafRegexSetDetails' - type: object - waf_regex_set_ValidateUpdateDataOutput: - schema: - properties: - waf_regex_set: - $ref: '#/definitions/WafRegexSetDetails' - type: object - waf_regex_set_cache_CustomizeDeleteOutput: - schema: - properties: - waf_regex_set_cache: - $ref: '#/definitions/WafRegexSetCacheDetails' - type: object - waf_regex_set_cache_FetchCustomizeColumnsOutput: - schema: - properties: - waf_regex_set_cache: - $ref: '#/definitions/WafRegexSetCacheDetails' - type: object - waf_regex_set_cache_GetDetailsClassMetadataOutput: - schema: - properties: - waf_regex_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_regex_set_cache_GetDetailsMetadataOutput: - schema: - properties: - waf_regex_set_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_regex_set_cache_GetDetailsStatusOutput: - schema: - properties: - waf_regex_set_cache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - waf_regex_set_cache_GetPropertyDistinctFieldOutput: {} - waf_regex_set_cache_GetPropertySplitableExportOutput: {} - waf_regex_set_cache_GetPropertySplitableOutput: {} - waf_regex_set_cache_GetPropertyStatisticsOutput: - schema: - properties: - waf_regex_set_cache: - $ref: '#/definitions/StatusStatistic' - type: object - waf_regex_set_cache_GetPropertyTagValuePairsOutput: {} - waf_regex_set_cache_GetPropertyTagValueTreeOutput: {} - waf_regex_set_cache_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 - waf_regex_set_caches: - items: - $ref: '#/definitions/WafRegexSetCacheDetails' - type: array - x-go-name: Output - type: object - waf_regex_set_cache_PerformClassMetadataOutput: {} - waf_regex_set_cache_PerformPurgeSplitableOutput: {} - waf_regex_set_cache_PerformSetClassMetadataOutput: {} - waf_regex_set_cache_PerformSetUserMetadataOutput: {} - waf_regex_set_cache_PerformStatusOutput: {} - waf_regex_set_cache_ValidateCreateDataOutput: - schema: - properties: - waf_regex_set_cache: - $ref: '#/definitions/WafRegexSetCacheDetails' - type: object - waf_regex_set_cache_ValidateUpdateDataOutput: - schema: - properties: - waf_regex_set_cache: - $ref: '#/definitions/WafRegexSetCacheDetails' - type: object - waf_rule_CustomizeDeleteOutput: - schema: - properties: - waf_rule: - $ref: '#/definitions/WafRuleDetails' - type: object - waf_rule_FetchCustomizeColumnsOutput: - schema: - properties: - waf_rule: - $ref: '#/definitions/WafRuleDetails' - type: object - waf_rule_GetDetailsClassMetadataOutput: - schema: - properties: - waf_rule: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_rule_GetDetailsMetadataOutput: - schema: - properties: - waf_rule: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_rule_GetDetailsStatusOutput: - schema: - properties: - waf_rule: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - waf_rule_GetPropertyDistinctFieldOutput: {} - waf_rule_GetPropertySplitableExportOutput: {} - waf_rule_GetPropertySplitableOutput: {} - waf_rule_GetPropertyStatisticsOutput: - schema: - properties: - waf_rule: - $ref: '#/definitions/StatusStatistic' - type: object - waf_rule_GetPropertyTagValuePairsOutput: {} - waf_rule_GetPropertyTagValueTreeOutput: {} - waf_rule_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 - waf_rules: - items: - $ref: '#/definitions/WafRuleDetails' - type: array - x-go-name: Output - type: object - waf_rule_PerformClassMetadataOutput: {} - waf_rule_PerformPurgeSplitableOutput: {} - waf_rule_PerformSetClassMetadataOutput: {} - waf_rule_PerformSetUserMetadataOutput: {} - waf_rule_PerformStatusOutput: {} - waf_rule_PerformSyncstatusOutput: {} - waf_rule_ValidateCreateDataOutput: - schema: - properties: - waf_rule: - $ref: '#/definitions/WafRuleDetails' - type: object - waf_rule_ValidateUpdateDataOutput: - schema: - properties: - waf_rule: - $ref: '#/definitions/WafRuleDetails' - type: object - waf_rule_group_CustomizeDeleteOutput: - schema: - properties: - waf_rule_group: - $ref: '#/definitions/WafRuleGroupDetails' - type: object - waf_rule_group_FetchCustomizeColumnsOutput: - schema: - properties: - waf_rule_group: - $ref: '#/definitions/WafRuleGroupDetails' - type: object - waf_rule_group_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - waf_rule_group: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - waf_rule_group_GetDetailsClassMetadataOutput: - schema: - properties: - waf_rule_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_rule_group_GetDetailsMetadataOutput: - schema: - properties: - waf_rule_group: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_rule_group_GetDetailsStatusOutput: - schema: - properties: - waf_rule_group: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - waf_rule_group_GetPropertyDistinctFieldOutput: {} - waf_rule_group_GetPropertyDomainTagValuePairsOutput: {} - waf_rule_group_GetPropertyDomainTagValueTreeOutput: {} - waf_rule_group_GetPropertySplitableExportOutput: {} - waf_rule_group_GetPropertySplitableOutput: {} - waf_rule_group_GetPropertyStatisticsOutput: - schema: - properties: - waf_rule_group: - $ref: '#/definitions/StatusStatistic' - type: object - waf_rule_group_GetPropertyTagValuePairsOutput: {} - waf_rule_group_GetPropertyTagValueTreeOutput: {} - waf_rule_group_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 - waf_rule_groups: - items: - $ref: '#/definitions/WafRuleGroupDetails' - type: array - x-go-name: Output - type: object - waf_rule_group_PerformChangeOwnerOutput: {} - waf_rule_group_PerformClassMetadataOutput: {} - waf_rule_group_PerformPrivateOutput: {} - waf_rule_group_PerformPublicOutput: {} - waf_rule_group_PerformPurgeSplitableOutput: {} - waf_rule_group_PerformSetClassMetadataOutput: {} - waf_rule_group_PerformSetUserMetadataOutput: {} - waf_rule_group_PerformStatusOutput: {} - waf_rule_group_ValidateCreateDataOutput: - schema: - properties: - waf_rule_group: - $ref: '#/definitions/WafRuleGroupDetails' - type: object - waf_rule_group_ValidateUpdateDataOutput: - schema: - properties: - waf_rule_group: - $ref: '#/definitions/WafRuleGroupDetails' - type: object - waf_rule_group_cache_CustomizeDeleteOutput: - schema: - properties: - waf_rule_group_cache: - $ref: '#/definitions/WafRuleGroupCacheDetails' - type: object - waf_rule_group_cache_FetchCustomizeColumnsOutput: - schema: - properties: - waf_rule_group_cache: - $ref: '#/definitions/WafRuleGroupCacheDetails' - type: object - waf_rule_group_cache_GetDetailsClassMetadataOutput: - schema: - properties: - waf_rule_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_rule_group_cache_GetDetailsMetadataOutput: - schema: - properties: - waf_rule_group_cache: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - waf_rule_group_cache_GetDetailsStatusOutput: - schema: - properties: - waf_rule_group_cache: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - waf_rule_group_cache_GetPropertyDistinctFieldOutput: {} - waf_rule_group_cache_GetPropertySplitableExportOutput: {} - waf_rule_group_cache_GetPropertySplitableOutput: {} - waf_rule_group_cache_GetPropertyStatisticsOutput: - schema: - properties: - waf_rule_group_cache: - $ref: '#/definitions/StatusStatistic' - type: object - waf_rule_group_cache_GetPropertyTagValuePairsOutput: {} - waf_rule_group_cache_GetPropertyTagValueTreeOutput: {} - waf_rule_group_cache_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 - waf_rule_group_caches: - items: - $ref: '#/definitions/WafRuleGroupCacheDetails' - type: array - x-go-name: Output - type: object - waf_rule_group_cache_PerformClassMetadataOutput: {} - waf_rule_group_cache_PerformPurgeSplitableOutput: {} - waf_rule_group_cache_PerformSetClassMetadataOutput: {} - waf_rule_group_cache_PerformSetUserMetadataOutput: {} - waf_rule_group_cache_PerformStatusOutput: {} - waf_rule_group_cache_ValidateCreateDataOutput: - schema: - properties: - waf_rule_group_cache: - $ref: '#/definitions/WafRuleGroupCacheDetails' - type: object - waf_rule_group_cache_ValidateUpdateDataOutput: - schema: - properties: - waf_rule_group_cache: - $ref: '#/definitions/WafRuleGroupCacheDetails' - type: object - waf_rule_statement_CustomizeDeleteOutput: - schema: - properties: - waf_rule_statement: - $ref: '#/definitions/ResourceBaseDetails' - type: object - waf_rule_statement_FetchCustomizeColumnsOutput: - schema: - properties: - waf_rule_statement: - $ref: '#/definitions/ResourceBaseDetails' - type: object - waf_rule_statement_GetPropertyDistinctFieldOutput: {} - waf_rule_statement_GetPropertySplitableExportOutput: {} - waf_rule_statement_GetPropertySplitableOutput: {} - waf_rule_statement_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 - waf_rule_statements: - items: - $ref: '#/definitions/ResourceBaseDetails' - type: array - x-go-name: Output - type: object - waf_rule_statement_PerformPurgeSplitableOutput: {} - waf_rule_statement_ValidateCreateDataOutput: - schema: - properties: - waf_rule_statement: - $ref: '#/definitions/ResourceBaseDetails' - type: object - waf_rule_statement_ValidateUpdateDataOutput: - schema: - properties: - waf_rule_statement: - $ref: '#/definitions/ResourceBaseDetails' - type: object - wire_CustomizeDeleteOutput: - schema: - properties: - wire: - $ref: '#/definitions/WireDetails' - type: object - wire_FetchCustomizeColumnsOutput: - schema: - properties: - wire: - $ref: '#/definitions/WireDetails' - type: object - wire_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - wire: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - wire_GetDetailsClassMetadataOutput: - schema: - properties: - wire: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - wire_GetDetailsMetadataOutput: - schema: - properties: - wire: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - wire_GetDetailsStatusOutput: - schema: - properties: - wire: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - wire_GetDetailsTopologyOutput: - schema: - properties: - wire: - $ref: '#/definitions/WireTopologyOutput' - type: object - wire_GetPropertyDistinctFieldOutput: {} - wire_GetPropertyDomainTagValuePairsOutput: {} - wire_GetPropertyDomainTagValueTreeOutput: {} - wire_GetPropertySplitableExportOutput: {} - wire_GetPropertySplitableOutput: {} - wire_GetPropertyStatisticsOutput: - schema: - properties: - wire: - $ref: '#/definitions/StatusStatistic' - type: object - wire_GetPropertyTagValuePairsOutput: {} - wire_GetPropertyTagValueTreeOutput: {} - wire_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 - wires: - items: - $ref: '#/definitions/WireDetails' - type: array - x-go-name: Output - type: object - wire_PerformChangeOwnerOutput: {} - wire_PerformClassMetadataOutput: {} - wire_PerformMergeFromOutput: {} - wire_PerformMergeNetworkOutput: {} - wire_PerformMergeToOutput: {} - wire_PerformPrivateOutput: {} - wire_PerformPublicOutput: {} - wire_PerformPurgeSplitableOutput: {} - wire_PerformSetClassMetadataOutput: {} - wire_PerformSetUserMetadataOutput: {} - wire_PerformStatusOutput: {} - wire_ValidateCreateDataOutput: - schema: - properties: - wire: - $ref: '#/definitions/WireDetails' - type: object - wire_ValidateUpdateDataOutput: - schema: - properties: - wire: - $ref: '#/definitions/WireDetails' - type: object - zone_CustomizeDeleteOutput: - schema: - properties: - zone: - $ref: '#/definitions/ZoneDetails' - type: object - zone_FetchCustomizeColumnsOutput: - schema: - properties: - zone: - $ref: '#/definitions/ZoneDetails' - type: object - zone_GetDetailsCapabilityOutput: {} - zone_GetDetailsClassMetadataOutput: - schema: - properties: - zone: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - zone_GetDetailsDiskCapabilityOutput: {} - zone_GetDetailsMetadataOutput: - schema: - properties: - zone: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - zone_GetDetailsStatusOutput: - schema: - properties: - zone: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - zone_GetPropertyDistinctFieldOutput: {} - zone_GetPropertySplitableExportOutput: {} - zone_GetPropertySplitableOutput: {} - zone_GetPropertyStatisticsOutput: - schema: - properties: - zone: - $ref: '#/definitions/StatusStatistic' - type: object - zone_GetPropertyTagValuePairsOutput: {} - zone_GetPropertyTagValueTreeOutput: {} - zone_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 - zones: - items: - $ref: '#/definitions/ZoneDetails' - type: array - x-go-name: Output - type: object - zone_PerformClassMetadataOutput: {} - zone_PerformPurgeSplitableOutput: {} - zone_PerformSetClassMetadataOutput: {} - zone_PerformSetSchedtagOutput: {} - zone_PerformSetUserMetadataOutput: {} - zone_PerformStatusOutput: {} - zone_ValidateCreateDataOutput: - schema: - properties: - zone: - $ref: '#/definitions/ZoneDetails' - type: object - zone_ValidateUpdateDataOutput: - schema: - properties: - zone: - $ref: '#/definitions/ZoneDetails' - type: object + access_group_CustomizeDeleteOutput: + description: "" + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupDetails' + type: object + access_group_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupDetails' + type: object + access_group_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + access_group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + access_group_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_GetDetailsMetadataOutput: + description: "" + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_GetDetailsStatusOutput: + description: "" + schema: + properties: + access_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + access_group_GetPropertyDistinctFieldOutput: + description: "" + access_group_GetPropertyDomainTagValuePairsOutput: + description: "" + access_group_GetPropertyDomainTagValueTreeOutput: + description: "" + access_group_GetPropertySplitableExportOutput: + description: "" + access_group_GetPropertySplitableOutput: + description: "" + access_group_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + access_group: + $ref: '#/definitions/StatusStatistic' + type: object + access_group_GetPropertyTagValuePairsOutput: + description: "" + access_group_GetPropertyTagValueTreeOutput: + description: "" + access_group_ListItemFilterOutput: + description: "" + schema: + properties: + access_groups: + items: + $ref: '#/definitions/AccessGroupDetails' + 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 + access_group_PerformChangeOwnerOutput: + description: "" + access_group_PerformClassMetadataOutput: + description: "" + access_group_PerformPrivateOutput: + description: "" + access_group_PerformPublicOutput: + description: "" + access_group_PerformPurgeSplitableOutput: + description: "" + access_group_PerformSetClassMetadataOutput: + description: "" + access_group_PerformSetOrgMetadataOutput: + description: "" + access_group_PerformSetUserMetadataOutput: + description: "" + access_group_PerformStatusOutput: + description: "" + access_group_PerformSyncstatusOutput: + description: "" + access_group_ValidateCreateDataOutput: + description: "" + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupDetails' + type: object + access_group_ValidateUpdateDataOutput: + description: "" + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupDetails' + type: object + access_group_rule_CustomizeDeleteOutput: + description: "" + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleDetails' + type: object + access_group_rule_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleDetails' + type: object + access_group_rule_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + access_group_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_rule_GetDetailsMetadataOutput: + description: "" + schema: + properties: + access_group_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_rule_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + access_group_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_rule_GetDetailsStatusOutput: + description: "" + schema: + properties: + access_group_rule: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + access_group_rule_GetPropertyDistinctFieldOutput: + description: "" + access_group_rule_GetPropertySplitableExportOutput: + description: "" + access_group_rule_GetPropertySplitableOutput: + description: "" + access_group_rule_GetPropertyTagValuePairsOutput: + description: "" + access_group_rule_GetPropertyTagValueTreeOutput: + description: "" + access_group_rule_ListItemFilterOutput: + description: "" + schema: + properties: + access_group_rules: + items: + $ref: '#/definitions/AccessGroupRuleDetails' + 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 + access_group_rule_PerformClassMetadataOutput: + description: "" + access_group_rule_PerformPurgeSplitableOutput: + description: "" + access_group_rule_PerformSetClassMetadataOutput: + description: "" + access_group_rule_PerformSetOrgMetadataOutput: + description: "" + access_group_rule_PerformSetUserMetadataOutput: + description: "" + access_group_rule_ValidateCreateDataOutput: + description: "" + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleDetails' + type: object + access_group_rule_ValidateUpdateDataOutput: + description: "" + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleDetails' + type: object + app_CustomizeDeleteOutput: + description: "" + schema: + properties: + app: + $ref: '#/definitions/AppDetails' + type: object + app_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + app: + $ref: '#/definitions/AppDetails' + type: object + app_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + app: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + app_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_GetDetailsMetadataOutput: + description: "" + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_GetDetailsStatusOutput: + description: "" + schema: + properties: + app: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + app_GetPropertyDistinctFieldOutput: + description: "" + app_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + app: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + app_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + app: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + app_GetPropertyProjectTagValuePairsOutput: + description: "" + app_GetPropertyProjectTagValueTreeOutput: + description: "" + app_GetPropertySplitableExportOutput: + description: "" + app_GetPropertySplitableOutput: + description: "" + app_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + app: + $ref: '#/definitions/StatusStatistic' + type: object + app_GetPropertyTagValuePairsOutput: + description: "" + app_GetPropertyTagValueTreeOutput: + description: "" + app_ListItemFilterOutput: + description: "" + schema: + properties: + apps: + items: + $ref: '#/definitions/AppDetails' + 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 + app_PerformCancelDeleteOutput: + description: "" + app_PerformChangeOwnerOutput: + description: "" + app_PerformClassMetadataOutput: + description: "" + app_PerformFreezeOutput: + description: "" + app_PerformPurgeSplitableOutput: + description: "" + app_PerformRemoteUpdateOutput: + description: "" + app_PerformSetClassMetadataOutput: + description: "" + app_PerformSetOrgMetadataOutput: + description: "" + app_PerformSetUserMetadataOutput: + description: "" + app_PerformStatusOutput: + description: "" + app_PerformSyncstatusOutput: + description: "" + app_PerformUnfreezeOutput: + description: "" + app_ValidateCreateDataOutput: + description: "" + schema: + properties: + app: + $ref: '#/definitions/AppDetails' + type: object + app_ValidateUpdateDataOutput: + description: "" + schema: + properties: + app: + $ref: '#/definitions/AppDetails' + type: object + app_environment_CustomizeDeleteOutput: + description: "" + schema: + properties: + app_environment: + $ref: '#/definitions/AppEnvironmentDetails' + type: object + app_environment_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + app_environment: + $ref: '#/definitions/AppEnvironmentDetails' + type: object + app_environment_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + app_environment: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + app_environment_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_environment_GetDetailsMetadataOutput: + description: "" + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_environment_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_environment_GetDetailsStatusOutput: + description: "" + schema: + properties: + app_environment: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + app_environment_GetPropertyDistinctFieldOutput: + description: "" + app_environment_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + app_environment: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + app_environment_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + app_environment: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + app_environment_GetPropertyProjectTagValuePairsOutput: + description: "" + app_environment_GetPropertyProjectTagValueTreeOutput: + description: "" + app_environment_GetPropertySplitableExportOutput: + description: "" + app_environment_GetPropertySplitableOutput: + description: "" + app_environment_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + app_environment: + $ref: '#/definitions/StatusStatistic' + type: object + app_environment_GetPropertyTagValuePairsOutput: + description: "" + app_environment_GetPropertyTagValueTreeOutput: + description: "" + app_environment_ListItemFilterOutput: + description: "" + schema: + properties: + app_environments: + items: + $ref: '#/definitions/AppEnvironmentDetails' + 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 + app_environment_PerformCancelDeleteOutput: + description: "" + app_environment_PerformChangeOwnerOutput: + description: "" + app_environment_PerformClassMetadataOutput: + description: "" + app_environment_PerformFreezeOutput: + description: "" + app_environment_PerformPurgeSplitableOutput: + description: "" + app_environment_PerformSetClassMetadataOutput: + description: "" + app_environment_PerformSetOrgMetadataOutput: + description: "" + app_environment_PerformSetUserMetadataOutput: + description: "" + app_environment_PerformStatusOutput: + description: "" + app_environment_PerformUnfreezeOutput: + description: "" + app_environment_ValidateCreateDataOutput: + description: "" + schema: + properties: + app_environment: + $ref: '#/definitions/AppEnvironmentDetails' + type: object + app_environment_ValidateUpdateDataOutput: + description: "" + schema: + properties: + app_environment: + $ref: '#/definitions/AppEnvironmentDetails' + type: object + backup_storage_CustomizeDeleteOutput: + description: "" + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageDetails' + type: object + backup_storage_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageDetails' + type: object + backup_storage_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + backup_storage: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + backup_storage_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + backup_storage_GetDetailsMetadataOutput: + description: "" + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + backup_storage_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + backup_storage_GetDetailsStatusOutput: + description: "" + schema: + properties: + backup_storage: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + backup_storage_GetPropertyDistinctFieldOutput: + description: "" + backup_storage_GetPropertyDomainTagValuePairsOutput: + description: "" + backup_storage_GetPropertyDomainTagValueTreeOutput: + description: "" + backup_storage_GetPropertySplitableExportOutput: + description: "" + backup_storage_GetPropertySplitableOutput: + description: "" + backup_storage_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + backup_storage: + $ref: '#/definitions/StatusStatistic' + type: object + backup_storage_GetPropertyTagValuePairsOutput: + description: "" + backup_storage_GetPropertyTagValueTreeOutput: + description: "" + backup_storage_ListItemFilterOutput: + description: "" + schema: + properties: + backup_storages: + items: + $ref: '#/definitions/BackupStorageDetails' + 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 + backup_storage_PerformChangeOwnerOutput: + description: "" + backup_storage_PerformClassMetadataOutput: + description: "" + backup_storage_PerformDisableOutput: + description: "" + backup_storage_PerformEnableOutput: + description: "" + backup_storage_PerformPrivateOutput: + description: "" + backup_storage_PerformPublicOutput: + description: "" + backup_storage_PerformPurgeSplitableOutput: + description: "" + backup_storage_PerformSetClassMetadataOutput: + description: "" + backup_storage_PerformSetOrgMetadataOutput: + description: "" + backup_storage_PerformSetUserMetadataOutput: + description: "" + backup_storage_PerformStatusOutput: + description: "" + backup_storage_PerformSyncstatusOutput: + description: "" + backup_storage_ValidateCreateDataOutput: + description: "" + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageDetails' + type: object + backup_storage_ValidateUpdateDataOutput: + description: "" + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageDetails' + type: object + baremetalagent_CustomizeDeleteOutput: + description: "" + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentDetails' + type: object + baremetalagent_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentDetails' + type: object + baremetalagent_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + baremetalagent_GetDetailsMetadataOutput: + description: "" + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + baremetalagent_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + baremetalagent_GetPropertyDistinctFieldOutput: + description: "" + baremetalagent_GetPropertySplitableExportOutput: + description: "" + baremetalagent_GetPropertySplitableOutput: + description: "" + baremetalagent_GetPropertyTagValuePairsOutput: + description: "" + baremetalagent_GetPropertyTagValueTreeOutput: + description: "" + baremetalagent_ListItemFilterOutput: + description: "" + schema: + properties: + baremetalagents: + items: + $ref: '#/definitions/BaremetalagentDetails' + 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 + baremetalagent_PerformClassMetadataOutput: + description: "" + baremetalagent_PerformDisableImageCacheOutput: + description: "" + baremetalagent_PerformDisableOutput: + description: "" + baremetalagent_PerformEnableImageCacheOutput: + description: "" + baremetalagent_PerformEnableOutput: + description: "" + baremetalagent_PerformOfflineOutput: + description: "" + baremetalagent_PerformOnlineOutput: + description: "" + baremetalagent_PerformPurgeSplitableOutput: + description: "" + baremetalagent_PerformSetClassMetadataOutput: + description: "" + baremetalagent_PerformSetOrgMetadataOutput: + description: "" + baremetalagent_PerformSetUserMetadataOutput: + description: "" + baremetalagent_ValidateCreateDataOutput: + description: "" + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentDetails' + type: object + baremetalagent_ValidateUpdateDataOutput: + description: "" + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentDetails' + type: object + billing_resource_check_CustomizeDeleteOutput: + description: "" + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseDetails' + type: object + billing_resource_check_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseDetails' + type: object + billing_resource_check_GetPropertyDistinctFieldOutput: + description: "" + billing_resource_check_GetPropertySplitableExportOutput: + description: "" + billing_resource_check_GetPropertySplitableOutput: + description: "" + billing_resource_check_ListItemFilterOutput: + description: "" + schema: + properties: + billing_resource_checks: + items: + $ref: '#/definitions/ResourceBaseDetails' + 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 + billing_resource_check_PerformPurgeSplitableOutput: + description: "" + billing_resource_check_ValidateCreateDataOutput: + description: "" + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseDetails' + type: object + billing_resource_check_ValidateUpdateDataOutput: + description: "" + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseDetails' + type: object + bucket_CustomizeDeleteOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketDetails' + type: object + bucket_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketDetails' + type: object + bucket_GetDetailsAccessInfoOutput: + description: "" + bucket_GetDetailsAclOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketGetAclOutput' + type: object + bucket_GetDetailsCdnDomainOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/CdnDomains' + type: object + bucket_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + bucket_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + bucket_GetDetailsCorsOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketCORSRules' + type: object + bucket_GetDetailsMetadataOutput: + description: "" + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + bucket_GetDetailsObjectsOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketGetObjectsOutput' + type: object + bucket_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + bucket_GetDetailsPolicyOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketPolicy' + type: object + bucket_GetDetailsRefererOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketRefererConf' + type: object + bucket_GetDetailsStatusOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + bucket_GetDetailsWebsiteOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketWebsiteConf' + type: object + bucket_GetPropertyDistinctFieldOutput: + description: "" + bucket_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + bucket: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + bucket_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + bucket: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + bucket_GetPropertyProjectTagValuePairsOutput: + description: "" + bucket_GetPropertyProjectTagValueTreeOutput: + description: "" + bucket_GetPropertySplitableExportOutput: + description: "" + bucket_GetPropertySplitableOutput: + description: "" + bucket_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/StatusStatistic' + type: object + bucket_GetPropertyTagValuePairsOutput: + description: "" + bucket_GetPropertyTagValueTreeOutput: + description: "" + bucket_ListItemFilterOutput: + description: "" + schema: + properties: + buckets: + items: + $ref: '#/definitions/BucketDetails' + 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 + bucket_PerformAclOutput: + description: "" + bucket_PerformCancelDeleteOutput: + description: "" + bucket_PerformChangeOwnerOutput: + description: "" + bucket_PerformClassMetadataOutput: + description: "" + bucket_PerformDeleteCorsOutput: + description: "" + bucket_PerformDeleteOutput: + description: "" + bucket_PerformDeletePolicyOutput: + description: "" + bucket_PerformDeleteWebsiteOutput: + description: "" + bucket_PerformFreezeOutput: + description: "" + bucket_PerformLimitOutput: + description: "" + bucket_PerformMakedirOutput: + description: "" + bucket_PerformMetadataOutput: + description: "" + bucket_PerformPrivateOutput: + description: "" + bucket_PerformPublicOutput: + description: "" + bucket_PerformPurgeSplitableOutput: + description: "" + bucket_PerformSetClassMetadataOutput: + description: "" + bucket_PerformSetCorsOutput: + description: "" + bucket_PerformSetOrgMetadataOutput: + description: "" + bucket_PerformSetPolicyOutput: + description: "" + bucket_PerformSetRefererOutput: + description: "" + bucket_PerformSetUserMetadataOutput: + description: "" + bucket_PerformSetWebsiteOutput: + description: "" + bucket_PerformStatusOutput: + description: "" + bucket_PerformSyncOutput: + description: "" + bucket_PerformSyncstatusOutput: + description: "" + bucket_PerformTempUrlOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketPerformTempUrlOutput' + type: object + bucket_PerformUnfreezeOutput: + description: "" + bucket_PerformUploadOutput: + description: "" + bucket_ValidateCreateDataOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketDetails' + type: object + bucket_ValidateUpdateDataOutput: + description: "" + schema: + properties: + bucket: + $ref: '#/definitions/BucketDetails' + type: object + cachedimage_CustomizeDeleteOutput: + description: "" + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedimageDetails' + type: object + cachedimage_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedimageDetails' + type: object + cachedimage_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + cachedimage: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cachedimage_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cachedimage_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cachedimage_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cachedimage_GetDetailsStatusOutput: + description: "" + schema: + properties: + cachedimage: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cachedimage_GetPropertyDistinctFieldOutput: + description: "" + cachedimage_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + cachedimage: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + cachedimage_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + cachedimage: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + cachedimage_GetPropertyProjectTagValuePairsOutput: + description: "" + cachedimage_GetPropertyProjectTagValueTreeOutput: + description: "" + cachedimage_GetPropertySplitableExportOutput: + description: "" + cachedimage_GetPropertySplitableOutput: + description: "" + cachedimage_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + cachedimage: + $ref: '#/definitions/StatusStatistic' + type: object + cachedimage_GetPropertyTagValuePairsOutput: + description: "" + cachedimage_GetPropertyTagValueTreeOutput: + description: "" + cachedimage_ListItemFilterOutput: + description: "" + schema: + properties: + cachedimages: + items: + $ref: '#/definitions/CachedimageDetails' + 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 + cachedimage_PerformCacheImageOutput: + description: "" + cachedimage_PerformCancelDeleteOutput: + description: "" + cachedimage_PerformChangeOwnerOutput: + description: "" + cachedimage_PerformClassMetadataOutput: + description: "" + cachedimage_PerformFreezeOutput: + description: "" + cachedimage_PerformPrivateOutput: + description: "" + cachedimage_PerformPublicOutput: + description: "" + cachedimage_PerformPurgeSplitableOutput: + description: "" + cachedimage_PerformRefreshOutput: + description: "" + cachedimage_PerformSetClassMetadataOutput: + description: "" + cachedimage_PerformSetOrgMetadataOutput: + description: "" + cachedimage_PerformSetUserMetadataOutput: + description: "" + cachedimage_PerformStatusOutput: + description: "" + cachedimage_PerformUncacheImageOutput: + description: "" + cachedimage_PerformUnfreezeOutput: + description: "" + cachedimage_ValidateCreateDataOutput: + description: "" + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedimageDetails' + type: object + cachedimage_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedimageDetails' + type: object + cdn_domain_CustomizeDeleteOutput: + description: "" + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainDetails' + type: object + cdn_domain_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainDetails' + type: object + cdn_domain_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + cdn_domain: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cdn_domain_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cdn_domain_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cdn_domain_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cdn_domain_GetDetailsStatusOutput: + description: "" + schema: + properties: + cdn_domain: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cdn_domain_GetPropertyDistinctFieldOutput: + description: "" + cdn_domain_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + cdn_domain: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + cdn_domain_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + cdn_domain: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + cdn_domain_GetPropertyProjectTagValuePairsOutput: + description: "" + cdn_domain_GetPropertyProjectTagValueTreeOutput: + description: "" + cdn_domain_GetPropertySplitableExportOutput: + description: "" + cdn_domain_GetPropertySplitableOutput: + description: "" + cdn_domain_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + cdn_domain: + $ref: '#/definitions/StatusStatistic' + type: object + cdn_domain_GetPropertyTagValuePairsOutput: + description: "" + cdn_domain_GetPropertyTagValueTreeOutput: + description: "" + cdn_domain_ListItemFilterOutput: + description: "" + schema: + properties: + cdn_domains: + items: + $ref: '#/definitions/CDNDomainDetails' + 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 + cdn_domain_PerformCancelDeleteOutput: + description: "" + cdn_domain_PerformChangeOwnerOutput: + description: "" + cdn_domain_PerformClassMetadataOutput: + description: "" + cdn_domain_PerformDisableOutput: + description: "" + cdn_domain_PerformEnableOutput: + description: "" + cdn_domain_PerformFreezeOutput: + description: "" + cdn_domain_PerformPurgeSplitableOutput: + description: "" + cdn_domain_PerformRemoteUpdateOutput: + description: "" + cdn_domain_PerformSetClassMetadataOutput: + description: "" + cdn_domain_PerformSetOrgMetadataOutput: + description: "" + cdn_domain_PerformSetUserMetadataOutput: + description: "" + cdn_domain_PerformStatusOutput: + description: "" + cdn_domain_PerformSyncstatusOutput: + description: "" + cdn_domain_PerformUnfreezeOutput: + description: "" + cdn_domain_ValidateCreateDataOutput: + description: "" + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainDetails' + type: object + cdn_domain_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainDetails' + type: object + cloudaccount_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountDetail' + type: object + cloudaccount_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountDetail' + type: object + cloudaccount_GetDetailsBalanceOutput: + description: "" + cloudaccount_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + cloudaccount: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudaccount_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudaccount_GetDetailsEnrollmentAccountsOutput: + description: "" + schema: + properties: + cloudaccount: + items: + $ref: '#/definitions/SEnrollmentAccount' + type: array + x-go-name: Output + type: object + cloudaccount_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudaccount_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudaccount_GetDetailsSamlOutput: + description: "" + cloudaccount_GetDetailsStatusOutput: + description: "" + schema: + properties: + cloudaccount: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudaccount_GetPropertyDistinctFieldOutput: + description: "" + cloudaccount_GetPropertyDomainTagValuePairsOutput: + description: "" + cloudaccount_GetPropertyDomainTagValueTreeOutput: + description: "" + cloudaccount_GetPropertySplitableExportOutput: + description: "" + cloudaccount_GetPropertySplitableOutput: + description: "" + cloudaccount_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + cloudaccount: + $ref: '#/definitions/StatusStatistic' + type: object + cloudaccount_GetPropertyTagValuePairsOutput: + description: "" + cloudaccount_GetPropertyTagValueTreeOutput: + description: "" + cloudaccount_ListItemFilterOutput: + description: "" + schema: + properties: + cloudaccounts: + items: + $ref: '#/definitions/CloudaccountDetail' + 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 + cloudaccount_PerformChangeProjectOutput: + description: "" + cloudaccount_PerformClassMetadataOutput: + description: "" + cloudaccount_PerformCreateSubscriptionOutput: + description: "" + cloudaccount_PerformDisableOutput: + description: "" + cloudaccount_PerformEnableOutput: + description: "" + cloudaccount_PerformPrepareNetsOutput: + description: "" + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountPerformPrepareNetsOutput' + type: object + cloudaccount_PerformPrivateOutput: + description: "" + cloudaccount_PerformProjectMappingOutput: + description: "" + cloudaccount_PerformPublicOutput: + description: "" + cloudaccount_PerformPurgeSplitableOutput: + description: "" + cloudaccount_PerformSetClassMetadataOutput: + description: "" + cloudaccount_PerformSetOrgMetadataOutput: + description: "" + cloudaccount_PerformSetUserMetadataOutput: + description: "" + cloudaccount_PerformShareModeOutput: + description: "" + cloudaccount_PerformStatusOutput: + description: "" + cloudaccount_PerformSyncOutput: + description: "" + cloudaccount_PerformSyncSkusOutput: + description: "" + cloudaccount_PerformTestConnectivityOutput: + description: "" + cloudaccount_PerformUpdateCredentialOutput: + description: "" + cloudaccount_ValidateCreateDataOutput: + description: "" + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountDetail' + type: object + cloudaccount_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountDetail' + type: object + cloudimage_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + cloudimage_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + cloudimage_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudimage_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudimage_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudimage_GetPropertyDistinctFieldOutput: + description: "" + cloudimage_GetPropertySplitableExportOutput: + description: "" + cloudimage_GetPropertySplitableOutput: + description: "" + cloudimage_GetPropertyTagValuePairsOutput: + description: "" + cloudimage_GetPropertyTagValueTreeOutput: + description: "" + cloudimage_ListItemFilterOutput: + description: "" + schema: + properties: + cloudimages: + items: + $ref: '#/definitions/StandaloneResourceDetails' + 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 + cloudimage_PerformClassMetadataOutput: + description: "" + cloudimage_PerformPurgeSplitableOutput: + description: "" + cloudimage_PerformSetClassMetadataOutput: + description: "" + cloudimage_PerformSetOrgMetadataOutput: + description: "" + cloudimage_PerformSetUserMetadataOutput: + description: "" + cloudimage_ValidateCreateDataOutput: + description: "" + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + cloudimage_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + cloudprovider_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderDetails' + type: object + cloudprovider_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderDetails' + type: object + cloudprovider_GetDetailsCannedAclsOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderGetCannedAclOutput' + type: object + cloudprovider_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudprovider_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsClircOutput: + description: "" + cloudprovider_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsStatusOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudprovider_GetDetailsStorageClassesOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderGetStorageClassOutput' + type: object + cloudprovider_GetPropertyDistinctFieldOutput: + description: "" + cloudprovider_GetPropertySplitableExportOutput: + description: "" + cloudprovider_GetPropertySplitableOutput: + description: "" + cloudprovider_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/StatusStatistic' + type: object + cloudprovider_GetPropertyTagValuePairsOutput: + description: "" + cloudprovider_GetPropertyTagValueTreeOutput: + description: "" + cloudprovider_ListItemFilterOutput: + description: "" + schema: + properties: + cloudproviders: + items: + $ref: '#/definitions/CloudproviderDetails' + 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 + cloudprovider_PerformChangeProjectOutput: + description: "" + cloudprovider_PerformClassMetadataOutput: + description: "" + cloudprovider_PerformDisableOutput: + description: "" + cloudprovider_PerformEnableOutput: + description: "" + cloudprovider_PerformProjectMappingOutput: + description: "" + cloudprovider_PerformPurgeSplitableOutput: + description: "" + cloudprovider_PerformSetClassMetadataOutput: + description: "" + cloudprovider_PerformSetOrgMetadataOutput: + description: "" + cloudprovider_PerformSetSchedtagOutput: + description: "" + cloudprovider_PerformSetSyncingOutput: + description: "" + cloudprovider_PerformSetUserMetadataOutput: + description: "" + cloudprovider_PerformStatusOutput: + description: "" + cloudprovider_PerformSyncOutput: + description: "" + cloudprovider_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderDetails' + type: object + cloudproviderregion_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/CloudproviderregionDetails' + type: object + cloudproviderregion_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/CloudproviderregionDetails' + type: object + cloudproviderregion_GetPropertyDistinctFieldOutput: + description: "" + cloudproviderregion_GetPropertySplitableExportOutput: + description: "" + cloudproviderregion_GetPropertySplitableOutput: + description: "" + cloudproviderregion_ListItemFilterOutput: + description: "" + schema: + properties: + cloudproviderregions: + items: + $ref: '#/definitions/CloudproviderregionDetails' + 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 + cloudproviderregion_PerformPurgeSplitableOutput: + description: "" + cloudproviderregion_ValidateCreateDataOutput: + description: "" + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/CloudproviderregionDetails' + type: object + cloudproviderregion_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/CloudproviderregionDetails' + type: object + cloudregion_CustomizeDeleteOutput: + description: "" + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionDetails' + type: object + cloudregion_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionDetails' + type: object + cloudregion_GetDetailsCapabilityOutput: + description: "" + cloudregion_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudregion_GetDetailsDiskCapabilityOutput: + description: "" + cloudregion_GetDetailsMetadataOutput: + description: "" + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudregion_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudregion_GetDetailsStatusOutput: + description: "" + schema: + properties: + cloudregion: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudregion_GetPropertyDistinctFieldOutput: + description: "" + cloudregion_GetPropertySplitableExportOutput: + description: "" + cloudregion_GetPropertySplitableOutput: + description: "" + cloudregion_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + cloudregion: + $ref: '#/definitions/StatusStatistic' + type: object + cloudregion_GetPropertySyncTasksOutput: + description: "" + cloudregion_GetPropertyTagValuePairsOutput: + description: "" + cloudregion_GetPropertyTagValueTreeOutput: + description: "" + cloudregion_ListItemFilterOutput: + description: "" + schema: + properties: + cloudregions: + items: + $ref: '#/definitions/CloudregionDetails' + 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 + cloudregion_PerformClassMetadataOutput: + description: "" + cloudregion_PerformDefaultVpcOutput: + description: "" + cloudregion_PerformDisableOutput: + description: "" + cloudregion_PerformEnableOutput: + description: "" + cloudregion_PerformPurgeOutput: + description: "" + cloudregion_PerformPurgeSplitableOutput: + description: "" + cloudregion_PerformSetClassMetadataOutput: + description: "" + cloudregion_PerformSetOrgMetadataOutput: + description: "" + cloudregion_PerformSetSchedtagOutput: + description: "" + cloudregion_PerformSetUserMetadataOutput: + description: "" + cloudregion_PerformStatusOutput: + description: "" + cloudregion_PerformSyncImagesOutput: + description: "" + cloudregion_PerformSyncSkusOutput: + description: "" + cloudregion_ValidateCreateDataOutput: + description: "" + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionDetails' + type: object + cloudregion_ValidateUpdateDataOutput: + description: "" + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionDetails' + type: object + container_CustomizeDeleteOutput: + description: "" + schema: + properties: + container: + $ref: '#/definitions/VirtualResourceDetails' + type: object + container_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + container: + $ref: '#/definitions/VirtualResourceDetails' + type: object + container_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + container: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + container_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + container: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + container_GetDetailsExecInfoOutput: + description: "" + schema: + properties: + container: + $ref: '#/definitions/ContainerExecInfoOutput' + type: object + container_GetDetailsMetadataOutput: + description: "" + schema: + properties: + container: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + container_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + container: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + container_GetDetailsStatusOutput: + description: "" + schema: + properties: + container: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + container_GetPropertyDistinctFieldOutput: + description: "" + container_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + container: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + container_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + container: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + container_GetPropertyProjectTagValuePairsOutput: + description: "" + container_GetPropertyProjectTagValueTreeOutput: + description: "" + container_GetPropertySplitableExportOutput: + description: "" + container_GetPropertySplitableOutput: + description: "" + container_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + container: + $ref: '#/definitions/StatusStatistic' + type: object + container_GetPropertyTagValuePairsOutput: + description: "" + container_GetPropertyTagValueTreeOutput: + description: "" + container_ListItemFilterOutput: + description: "" + schema: + properties: + containers: + items: + $ref: '#/definitions/VirtualResourceDetails' + 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 + container_PerformCancelDeleteOutput: + description: "" + container_PerformChangeOwnerOutput: + description: "" + container_PerformClassMetadataOutput: + description: "" + container_PerformFreezeOutput: + description: "" + container_PerformPurgeSplitableOutput: + description: "" + container_PerformSaveVolumeMountImageOutput: + description: "" + schema: + properties: + container: + $ref: '#/definitions/ContainerSaveVolumeMountToImageInput' + type: object + container_PerformSetClassMetadataOutput: + description: "" + container_PerformSetOrgMetadataOutput: + description: "" + container_PerformSetUserMetadataOutput: + description: "" + container_PerformStartOutput: + description: "" + container_PerformStatusOutput: + description: "" + container_PerformStopOutput: + description: "" + container_PerformSyncstatusOutput: + description: "" + container_PerformUnfreezeOutput: + description: "" + container_ValidateCreateDataOutput: + description: "" + schema: + properties: + container: + $ref: '#/definitions/VirtualResourceDetails' + type: object + container_ValidateUpdateDataOutput: + description: "" + schema: + properties: + container: + $ref: '#/definitions/VirtualResourceDetails' + type: object + db_instance_CustomizeDeleteOutput: + description: "" + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceDetails' + type: object + db_instance_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceDetails' + type: object + db_instance_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + db_instance: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + db_instance_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_GetDetailsMetadataOutput: + description: "" + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_GetDetailsStatusOutput: + description: "" + schema: + properties: + db_instance: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_GetPropertyDistinctFieldOutput: + description: "" + db_instance_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + db_instance: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + db_instance_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + db_instance: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + db_instance_GetPropertyProjectTagValuePairsOutput: + description: "" + db_instance_GetPropertyProjectTagValueTreeOutput: + description: "" + db_instance_GetPropertySplitableExportOutput: + description: "" + db_instance_GetPropertySplitableOutput: + description: "" + db_instance_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + db_instance: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_GetPropertyTagValuePairsOutput: + description: "" + db_instance_GetPropertyTagValueTreeOutput: + description: "" + db_instance_ListItemFilterOutput: + description: "" + schema: + properties: + db_instances: + items: + $ref: '#/definitions/DBInstanceDetails' + 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 + db_instance_PerformCancelDeleteOutput: + description: "" + db_instance_PerformCancelExpireOutput: + description: "" + db_instance_PerformChangeConfigOutput: + description: "" + db_instance_PerformChangeOwnerOutput: + description: "" + db_instance_PerformClassMetadataOutput: + description: "" + db_instance_PerformFreezeOutput: + description: "" + db_instance_PerformPostpaidExpireOutput: + description: "" + db_instance_PerformPublicConnectionOutput: + description: "" + db_instance_PerformPurgeOutput: + description: "" + db_instance_PerformPurgeSplitableOutput: + description: "" + db_instance_PerformRebootOutput: + description: "" + db_instance_PerformRecoveryOutput: + description: "" + db_instance_PerformRemoteUpdateOutput: + description: "" + db_instance_PerformRenewOutput: + description: "" + db_instance_PerformSetAutoRenewOutput: + description: "" + db_instance_PerformSetClassMetadataOutput: + description: "" + db_instance_PerformSetOrgMetadataOutput: + description: "" + db_instance_PerformSetSecgroupOutput: + description: "" + db_instance_PerformSetUserMetadataOutput: + description: "" + db_instance_PerformStatusOutput: + description: "" + db_instance_PerformSyncOutput: + description: "" + db_instance_PerformSyncStatusOutput: + description: "" + db_instance_PerformSyncstatusOutput: + description: "" + db_instance_PerformUnfreezeOutput: + description: "" + db_instance_ValidateCreateDataOutput: + description: "" + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceDetails' + type: object + db_instance_ValidateUpdateDataOutput: + description: "" + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceDetails' + type: object + db_instance_account_CustomizeDeleteOutput: + description: "" + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountDetails' + type: object + db_instance_account_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountDetails' + type: object + db_instance_account_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_account_GetDetailsMetadataOutput: + description: "" + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_account_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_account_GetDetailsStatusOutput: + description: "" + schema: + properties: + db_instance_account: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_account_GetPropertyDistinctFieldOutput: + description: "" + db_instance_account_GetPropertySplitableExportOutput: + description: "" + db_instance_account_GetPropertySplitableOutput: + description: "" + db_instance_account_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + db_instance_account: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_account_GetPropertyTagValuePairsOutput: + description: "" + db_instance_account_GetPropertyTagValueTreeOutput: + description: "" + db_instance_account_ListItemFilterOutput: + description: "" + schema: + properties: + db_instance_accounts: + items: + $ref: '#/definitions/DBInstanceAccountDetails' + 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 + db_instance_account_PerformClassMetadataOutput: + description: "" + db_instance_account_PerformGrantPrivilegeOutput: + description: "" + db_instance_account_PerformPurgeSplitableOutput: + description: "" + db_instance_account_PerformResetPasswordOutput: + description: "" + db_instance_account_PerformRevokePrivilegeOutput: + description: "" + db_instance_account_PerformSetClassMetadataOutput: + description: "" + db_instance_account_PerformSetOrgMetadataOutput: + description: "" + db_instance_account_PerformSetPrivilegesOutput: + description: "" + db_instance_account_PerformSetUserMetadataOutput: + description: "" + db_instance_account_PerformStatusOutput: + description: "" + db_instance_account_ValidateCreateDataOutput: + description: "" + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountDetails' + type: object + db_instance_account_ValidateUpdateDataOutput: + description: "" + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountDetails' + type: object + db_instance_backup_CustomizeDeleteOutput: + description: "" + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupDetails' + type: object + db_instance_backup_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupDetails' + type: object + db_instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + db_instance_backup: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + db_instance_backup_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_backup_GetDetailsMetadataOutput: + description: "" + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_backup_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_backup_GetDetailsStatusOutput: + description: "" + schema: + properties: + db_instance_backup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_backup_GetPropertyDistinctFieldOutput: + description: "" + db_instance_backup_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + db_instance_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + db_instance_backup_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + db_instance_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + db_instance_backup_GetPropertyProjectTagValuePairsOutput: + description: "" + db_instance_backup_GetPropertyProjectTagValueTreeOutput: + description: "" + db_instance_backup_GetPropertySplitableExportOutput: + description: "" + db_instance_backup_GetPropertySplitableOutput: + description: "" + db_instance_backup_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + db_instance_backup: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_backup_GetPropertyTagValuePairsOutput: + description: "" + db_instance_backup_GetPropertyTagValueTreeOutput: + description: "" + db_instance_backup_ListItemFilterOutput: + description: "" + schema: + properties: + db_instance_backups: + items: + $ref: '#/definitions/DBInstanceBackupDetails' + 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 + db_instance_backup_PerformCancelDeleteOutput: + description: "" + db_instance_backup_PerformChangeOwnerOutput: + description: "" + db_instance_backup_PerformClassMetadataOutput: + description: "" + db_instance_backup_PerformFreezeOutput: + description: "" + db_instance_backup_PerformPurgeSplitableOutput: + description: "" + db_instance_backup_PerformSetClassMetadataOutput: + description: "" + db_instance_backup_PerformSetOrgMetadataOutput: + description: "" + db_instance_backup_PerformSetUserMetadataOutput: + description: "" + db_instance_backup_PerformStatusOutput: + description: "" + db_instance_backup_PerformSyncstatusOutput: + description: "" + db_instance_backup_PerformUnfreezeOutput: + description: "" + db_instance_backup_ValidateCreateDataOutput: + description: "" + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupDetails' + type: object + db_instance_backup_ValidateUpdateDataOutput: + description: "" + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupDetails' + type: object + db_instance_database_CustomizeDeleteOutput: + description: "" + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstancedatabaseDetails' + type: object + db_instance_database_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstancedatabaseDetails' + type: object + db_instance_database_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_database_GetDetailsMetadataOutput: + description: "" + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_database_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_database_GetDetailsStatusOutput: + description: "" + schema: + properties: + db_instance_database: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_database_GetPropertyDistinctFieldOutput: + description: "" + db_instance_database_GetPropertySplitableExportOutput: + description: "" + db_instance_database_GetPropertySplitableOutput: + description: "" + db_instance_database_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + db_instance_database: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_database_GetPropertyTagValuePairsOutput: + description: "" + db_instance_database_GetPropertyTagValueTreeOutput: + description: "" + db_instance_database_ListItemFilterOutput: + description: "" + schema: + properties: + db_instance_databases: + items: + $ref: '#/definitions/DBInstancedatabaseDetails' + 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 + db_instance_database_PerformClassMetadataOutput: + description: "" + db_instance_database_PerformPurgeSplitableOutput: + description: "" + db_instance_database_PerformSetClassMetadataOutput: + description: "" + db_instance_database_PerformSetOrgMetadataOutput: + description: "" + db_instance_database_PerformSetUserMetadataOutput: + description: "" + db_instance_database_PerformStatusOutput: + description: "" + db_instance_database_ValidateCreateDataOutput: + description: "" + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstancedatabaseDetails' + type: object + db_instance_database_ValidateUpdateDataOutput: + description: "" + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstancedatabaseDetails' + type: object + db_instance_network_CustomizeDeleteOutput: + description: "" + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + db_instance_network_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + db_instance_network_GetPropertyDistinctFieldOutput: + description: "" + db_instance_network_GetPropertySplitableExportOutput: + description: "" + db_instance_network_GetPropertySplitableOutput: + description: "" + db_instance_network_ListItemFilterOutput: + description: "" + schema: + properties: + db_instance_networks: + items: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + 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 + db_instance_network_PerformPurgeSplitableOutput: + description: "" + db_instance_network_ValidateCreateDataOutput: + description: "" + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + db_instance_network_ValidateUpdateDataOutput: + description: "" + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + db_instance_parameter_CustomizeDeleteOutput: + description: "" + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/DBInstanceparameterDetails' + type: object + db_instance_parameter_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/DBInstanceparameterDetails' + type: object + db_instance_parameter_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_parameter_GetDetailsMetadataOutput: + description: "" + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_parameter_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_parameter_GetPropertyDistinctFieldOutput: + description: "" + db_instance_parameter_GetPropertySplitableExportOutput: + description: "" + db_instance_parameter_GetPropertySplitableOutput: + description: "" + db_instance_parameter_GetPropertyTagValuePairsOutput: + description: "" + db_instance_parameter_GetPropertyTagValueTreeOutput: + description: "" + db_instance_parameter_ListItemFilterOutput: + description: "" + schema: + properties: + db_instance_parameters: + items: + $ref: '#/definitions/DBInstanceparameterDetails' + 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 + db_instance_parameter_PerformClassMetadataOutput: + description: "" + db_instance_parameter_PerformPurgeSplitableOutput: + description: "" + db_instance_parameter_PerformSetClassMetadataOutput: + description: "" + db_instance_parameter_PerformSetOrgMetadataOutput: + description: "" + db_instance_parameter_PerformSetUserMetadataOutput: + description: "" + db_instance_parameter_ValidateCreateDataOutput: + description: "" + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/DBInstanceparameterDetails' + type: object + db_instance_parameter_ValidateUpdateDataOutput: + description: "" + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/DBInstanceparameterDetails' + type: object + db_instance_privilege_CustomizeDeleteOutput: + description: "" + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseDetails' + type: object + db_instance_privilege_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseDetails' + type: object + db_instance_privilege_GetPropertyDistinctFieldOutput: + description: "" + db_instance_privilege_GetPropertySplitableExportOutput: + description: "" + db_instance_privilege_GetPropertySplitableOutput: + description: "" + db_instance_privilege_ListItemFilterOutput: + description: "" + schema: + properties: + db_instance_privileges: + items: + $ref: '#/definitions/ResourceBaseDetails' + 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 + db_instance_privilege_PerformPurgeSplitableOutput: + description: "" + db_instance_privilege_ValidateCreateDataOutput: + description: "" + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseDetails' + type: object + db_instance_privilege_ValidateUpdateDataOutput: + description: "" + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseDetails' + type: object + db_instance_secgroup_CustomizeDeleteOutput: + description: "" + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/DBInstanceSecgroupDetails' + type: object + db_instance_secgroup_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/DBInstanceSecgroupDetails' + type: object + db_instance_secgroup_GetPropertyDistinctFieldOutput: + description: "" + db_instance_secgroup_GetPropertySplitableExportOutput: + description: "" + db_instance_secgroup_GetPropertySplitableOutput: + description: "" + db_instance_secgroup_ListItemFilterOutput: + description: "" + schema: + properties: + db_instance_secgroups: + items: + $ref: '#/definitions/DBInstanceSecgroupDetails' + 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 + db_instance_secgroup_PerformPurgeSplitableOutput: + description: "" + db_instance_secgroup_ValidateCreateDataOutput: + description: "" + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/DBInstanceSecgroupDetails' + type: object + db_instance_secgroup_ValidateUpdateDataOutput: + description: "" + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/DBInstanceSecgroupDetails' + type: object + db_instance_sku_CustomizeDeleteOutput: + description: "" + schema: + properties: + db_instance_sku: + $ref: '#/definitions/DBInstanceSkuDetails' + type: object + db_instance_sku_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + db_instance_sku: + $ref: '#/definitions/DBInstanceSkuDetails' + type: object + db_instance_sku_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_sku_GetDetailsMetadataOutput: + description: "" + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_sku_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_sku_GetDetailsStatusOutput: + description: "" + schema: + properties: + db_instance_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_sku_GetPropertyDistinctFieldOutput: + description: "" + db_instance_sku_GetPropertyInstanceSpecsOutput: + description: "" + db_instance_sku_GetPropertySplitableExportOutput: + description: "" + db_instance_sku_GetPropertySplitableOutput: + description: "" + db_instance_sku_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + db_instance_sku: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_sku_GetPropertySyncTasksOutput: + description: "" + db_instance_sku_GetPropertyTagValuePairsOutput: + description: "" + db_instance_sku_GetPropertyTagValueTreeOutput: + description: "" + db_instance_sku_ListItemFilterOutput: + description: "" + schema: + properties: + db_instance_skus: + items: + $ref: '#/definitions/DBInstanceSkuDetails' + 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 + db_instance_sku_PerformClassMetadataOutput: + description: "" + db_instance_sku_PerformDisableOutput: + description: "" + db_instance_sku_PerformEnableOutput: + description: "" + db_instance_sku_PerformPurgeSplitableOutput: + description: "" + db_instance_sku_PerformSetClassMetadataOutput: + description: "" + db_instance_sku_PerformSetOrgMetadataOutput: + description: "" + db_instance_sku_PerformSetUserMetadataOutput: + description: "" + db_instance_sku_PerformStatusOutput: + description: "" + db_instance_sku_PerformSyncSkusOutput: + description: "" + db_instance_sku_ValidateCreateDataOutput: + description: "" + schema: + properties: + db_instance_sku: + $ref: '#/definitions/DBInstanceSkuDetails' + type: object + db_instance_sku_ValidateUpdateDataOutput: + description: "" + schema: + properties: + db_instance_sku: + $ref: '#/definitions/DBInstanceSkuDetails' + type: object + disk_CustomizeDeleteOutput: + description: "" + schema: + properties: + disk: + $ref: '#/definitions/DiskDetails' + type: object + disk_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + disk: + $ref: '#/definitions/DiskDetails' + type: object + disk_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + disk: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + disk_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_GetDetailsMetadataOutput: + description: "" + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_GetDetailsStatusOutput: + description: "" + schema: + properties: + disk: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + disk_GetPropertyDistinctFieldOutput: + description: "" + disk_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + disk: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + disk_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + disk: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + disk_GetPropertyProjectTagValuePairsOutput: + description: "" + disk_GetPropertyProjectTagValueTreeOutput: + description: "" + disk_GetPropertySplitableExportOutput: + description: "" + disk_GetPropertySplitableOutput: + description: "" + disk_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + disk: + $ref: '#/definitions/StatusStatistic' + type: object + disk_GetPropertyTagValuePairsOutput: + description: "" + disk_GetPropertyTagValueTreeOutput: + description: "" + disk_ListItemFilterOutput: + description: "" + schema: + properties: + disks: + items: + $ref: '#/definitions/DiskDetails' + 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 + disk_PerformBindSnapshotpolicyOutput: + description: "" + disk_PerformCancelDeleteOutput: + description: "" + disk_PerformChangeOwnerOutput: + description: "" + disk_PerformClassMetadataOutput: + description: "" + disk_PerformDiskResetOutput: + description: "" + disk_PerformFreezeOutput: + description: "" + disk_PerformMigrateOutput: + description: "" + disk_PerformPurgeOutput: + description: "" + disk_PerformPurgeSplitableOutput: + description: "" + disk_PerformRebuildOutput: + description: "" + disk_PerformResizeOutput: + description: "" + disk_PerformSaveOutput: + description: "" + disk_PerformSetClassMetadataOutput: + description: "" + disk_PerformSetOrgMetadataOutput: + description: "" + disk_PerformSetUserMetadataOutput: + description: "" + disk_PerformStatusOutput: + description: "" + disk_PerformSyncstatusOutput: + description: "" + disk_PerformUnbindSnapshotpolicyOutput: + description: "" + disk_PerformUnfreezeOutput: + description: "" + disk_ValidateCreateDataOutput: + description: "" + schema: + properties: + disk: + $ref: '#/definitions/DiskDetails' + type: object + disk_ValidateUpdateDataOutput: + description: "" + schema: + properties: + disk: + $ref: '#/definitions/DiskDetails' + type: object + disk_backup_CustomizeDeleteOutput: + description: "" + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupDetails' + type: object + disk_backup_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupDetails' + type: object + disk_backup_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + disk_backup: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + disk_backup_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_backup_GetDetailsMetadataOutput: + description: "" + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_backup_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_backup_GetDetailsStatusOutput: + description: "" + schema: + properties: + disk_backup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + disk_backup_GetPropertyDistinctFieldOutput: + description: "" + disk_backup_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + disk_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + disk_backup_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + disk_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + disk_backup_GetPropertyProjectTagValuePairsOutput: + description: "" + disk_backup_GetPropertyProjectTagValueTreeOutput: + description: "" + disk_backup_GetPropertySplitableExportOutput: + description: "" + disk_backup_GetPropertySplitableOutput: + description: "" + disk_backup_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + disk_backup: + $ref: '#/definitions/StatusStatistic' + type: object + disk_backup_GetPropertyTagValuePairsOutput: + description: "" + disk_backup_GetPropertyTagValueTreeOutput: + description: "" + disk_backup_ListItemFilterOutput: + description: "" + schema: + properties: + disk_backups: + items: + $ref: '#/definitions/DiskBackupDetails' + 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 + disk_backup_PerformCancelDeleteOutput: + description: "" + disk_backup_PerformChangeOwnerOutput: + description: "" + disk_backup_PerformClassMetadataOutput: + description: "" + disk_backup_PerformFreezeOutput: + description: "" + disk_backup_PerformPurgeSplitableOutput: + description: "" + disk_backup_PerformRecoveryOutput: + description: "" + disk_backup_PerformSetClassMetadataOutput: + description: "" + disk_backup_PerformSetOrgMetadataOutput: + description: "" + disk_backup_PerformSetUserMetadataOutput: + description: "" + disk_backup_PerformStatusOutput: + description: "" + disk_backup_PerformSyncstatusOutput: + description: "" + disk_backup_PerformUnfreezeOutput: + description: "" + disk_backup_ValidateCreateDataOutput: + description: "" + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupDetails' + type: object + disk_backup_ValidateUpdateDataOutput: + description: "" + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupDetails' + type: object + dns_record_CustomizeDeleteOutput: + description: "" + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordDetails' + type: object + dns_record_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordDetails' + type: object + dns_record_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_record_GetDetailsMetadataOutput: + description: "" + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_record_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_record_GetDetailsStatusOutput: + description: "" + schema: + properties: + dns_record: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + dns_record_GetPropertyDistinctFieldOutput: + description: "" + dns_record_GetPropertySplitableExportOutput: + description: "" + dns_record_GetPropertySplitableOutput: + description: "" + dns_record_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + dns_record: + $ref: '#/definitions/StatusStatistic' + type: object + dns_record_GetPropertyTagValuePairsOutput: + description: "" + dns_record_GetPropertyTagValueTreeOutput: + description: "" + dns_record_ListItemFilterOutput: + description: "" + schema: + properties: + dns_records: + items: + $ref: '#/definitions/DnsRecordDetails' + 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 + dns_record_PerformClassMetadataOutput: + description: "" + dns_record_PerformDisableOutput: + description: "" + dns_record_PerformEnableOutput: + description: "" + dns_record_PerformPurgeSplitableOutput: + description: "" + dns_record_PerformSetClassMetadataOutput: + description: "" + dns_record_PerformSetOrgMetadataOutput: + description: "" + dns_record_PerformSetUserMetadataOutput: + description: "" + dns_record_PerformStatusOutput: + description: "" + dns_record_ValidateCreateDataOutput: + description: "" + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordDetails' + type: object + dns_record_ValidateUpdateDataOutput: + description: "" + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordDetails' + type: object + dns_zone_CustomizeDeleteOutput: + description: "" + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneDetails' + type: object + dns_zone_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneDetails' + type: object + dns_zone_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + dns_zone: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + dns_zone_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_zone_GetDetailsExportsOutput: + description: "" + dns_zone_GetDetailsMetadataOutput: + description: "" + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_zone_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_zone_GetDetailsStatusOutput: + description: "" + schema: + properties: + dns_zone: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + dns_zone_GetPropertyCapabilityOutput: + description: "" + dns_zone_GetPropertyDistinctFieldOutput: + description: "" + dns_zone_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + dns_zone: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + dns_zone_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + dns_zone: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + dns_zone_GetPropertyProjectTagValuePairsOutput: + description: "" + dns_zone_GetPropertyProjectTagValueTreeOutput: + description: "" + dns_zone_GetPropertySplitableExportOutput: + description: "" + dns_zone_GetPropertySplitableOutput: + description: "" + dns_zone_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + dns_zone: + $ref: '#/definitions/StatusStatistic' + type: object + dns_zone_GetPropertyTagValuePairsOutput: + description: "" + dns_zone_GetPropertyTagValueTreeOutput: + description: "" + dns_zone_ListItemFilterOutput: + description: "" + schema: + properties: + dns_zones: + items: + $ref: '#/definitions/DnsZoneDetails' + 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 + dns_zone_PerformAddVpcsOutput: + description: "" + dns_zone_PerformCancelDeleteOutput: + description: "" + dns_zone_PerformChangeOwnerOutput: + description: "" + dns_zone_PerformClassMetadataOutput: + description: "" + dns_zone_PerformFreezeOutput: + description: "" + dns_zone_PerformPrivateOutput: + description: "" + dns_zone_PerformPublicOutput: + description: "" + dns_zone_PerformPurgeOutput: + description: "" + dns_zone_PerformPurgeSplitableOutput: + description: "" + dns_zone_PerformRemoveVpcsOutput: + description: "" + dns_zone_PerformSetClassMetadataOutput: + description: "" + dns_zone_PerformSetOrgMetadataOutput: + description: "" + dns_zone_PerformSetUserMetadataOutput: + description: "" + dns_zone_PerformStatusOutput: + description: "" + dns_zone_PerformSyncstatusOutput: + description: "" + dns_zone_PerformUnfreezeOutput: + description: "" + dns_zone_ValidateCreateDataOutput: + description: "" + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneDetails' + type: object + dns_zone_ValidateUpdateDataOutput: + description: "" + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneDetails' + type: object + dns_zone_vpc_CustomizeDeleteOutput: + description: "" + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_zone_vpc_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_zone_vpc_GetPropertyDistinctFieldOutput: + description: "" + dns_zone_vpc_GetPropertySplitableExportOutput: + description: "" + dns_zone_vpc_GetPropertySplitableOutput: + description: "" + dns_zone_vpc_ListItemFilterOutput: + description: "" + schema: + properties: + dns_zone_vpcs: + items: + $ref: '#/definitions/JointResourceBaseDetails' + 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 + dns_zone_vpc_PerformPurgeSplitableOutput: + description: "" + dns_zone_vpc_ValidateCreateDataOutput: + description: "" + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_zone_vpc_ValidateUpdateDataOutput: + description: "" + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dynamicschedtag_CustomizeDeleteOutput: + description: "" + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/DynamicschedtagDetails' + type: object + dynamicschedtag_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/DynamicschedtagDetails' + type: object + dynamicschedtag_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dynamicschedtag_GetDetailsMetadataOutput: + description: "" + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dynamicschedtag_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dynamicschedtag_GetPropertyDistinctFieldOutput: + description: "" + dynamicschedtag_GetPropertySplitableExportOutput: + description: "" + dynamicschedtag_GetPropertySplitableOutput: + description: "" + dynamicschedtag_GetPropertyTagValuePairsOutput: + description: "" + dynamicschedtag_GetPropertyTagValueTreeOutput: + description: "" + dynamicschedtag_ListItemFilterOutput: + description: "" + schema: + properties: + dynamicschedtags: + items: + $ref: '#/definitions/DynamicschedtagDetails' + 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 + dynamicschedtag_PerformClassMetadataOutput: + description: "" + dynamicschedtag_PerformEvaluateOutput: + description: "" + dynamicschedtag_PerformPurgeSplitableOutput: + description: "" + dynamicschedtag_PerformSetClassMetadataOutput: + description: "" + dynamicschedtag_PerformSetOrgMetadataOutput: + description: "" + dynamicschedtag_PerformSetUserMetadataOutput: + description: "" + dynamicschedtag_ValidateCreateDataOutput: + description: "" + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/DynamicschedtagDetails' + type: object + dynamicschedtag_ValidateUpdateDataOutput: + description: "" + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/DynamicschedtagDetails' + type: object + elastic_search_CustomizeDeleteOutput: + description: "" + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchDetails' + type: object + elastic_search_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchDetails' + type: object + elastic_search_GetDetailsAccessInfoOutput: + description: "" + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchAccessInfo' + type: object + elastic_search_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + elastic_search: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + elastic_search_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elastic_search_GetDetailsMetadataOutput: + description: "" + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elastic_search_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elastic_search_GetDetailsStatusOutput: + description: "" + schema: + properties: + elastic_search: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elastic_search_GetPropertyDistinctFieldOutput: + description: "" + elastic_search_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + elastic_search: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elastic_search_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + elastic_search: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elastic_search_GetPropertyProjectTagValuePairsOutput: + description: "" + elastic_search_GetPropertyProjectTagValueTreeOutput: + description: "" + elastic_search_GetPropertySplitableExportOutput: + description: "" + elastic_search_GetPropertySplitableOutput: + description: "" + elastic_search_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + elastic_search: + $ref: '#/definitions/StatusStatistic' + type: object + elastic_search_GetPropertyTagValuePairsOutput: + description: "" + elastic_search_GetPropertyTagValueTreeOutput: + description: "" + elastic_search_ListItemFilterOutput: + description: "" + schema: + properties: + elastic_searches: + items: + $ref: '#/definitions/ElasticSearchDetails' + 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 + elastic_search_PerformCancelDeleteOutput: + description: "" + elastic_search_PerformChangeOwnerOutput: + description: "" + elastic_search_PerformClassMetadataOutput: + description: "" + elastic_search_PerformFreezeOutput: + description: "" + elastic_search_PerformPurgeSplitableOutput: + description: "" + elastic_search_PerformSetClassMetadataOutput: + description: "" + elastic_search_PerformSetOrgMetadataOutput: + description: "" + elastic_search_PerformSetUserMetadataOutput: + description: "" + elastic_search_PerformStatusOutput: + description: "" + elastic_search_PerformSyncstatusOutput: + description: "" + elastic_search_PerformUnfreezeOutput: + description: "" + elastic_search_ValidateCreateDataOutput: + description: "" + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchDetails' + type: object + elastic_search_ValidateUpdateDataOutput: + description: "" + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchDetails' + type: object + elasticcache_CustomizeDeleteOutput: + description: "" + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheDetails' + type: object + elasticcache_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheDetails' + type: object + elasticcache_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + elasticcache: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + elasticcache_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_GetDetailsLoginInfoOutput: + description: "" + elasticcache_GetDetailsMetadataOutput: + description: "" + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_GetDetailsStatusOutput: + description: "" + schema: + properties: + elasticcache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_GetPropertyDistinctFieldOutput: + description: "" + elasticcache_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + elasticcache: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elasticcache_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + elasticcache: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elasticcache_GetPropertyProjectTagValuePairsOutput: + description: "" + elasticcache_GetPropertyProjectTagValueTreeOutput: + description: "" + elasticcache_GetPropertySplitableExportOutput: + description: "" + elasticcache_GetPropertySplitableOutput: + description: "" + elasticcache_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + elasticcache: + $ref: '#/definitions/StatusStatistic' + type: object + elasticcache_GetPropertyTagValuePairsOutput: + description: "" + elasticcache_GetPropertyTagValueTreeOutput: + description: "" + elasticcache_ListItemFilterOutput: + description: "" + schema: + properties: + elasticcaches: + items: + $ref: '#/definitions/ElasticcacheDetails' + 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 + elasticcache_PerformAddSecgroupOutput: + description: "" + elasticcache_PerformAllocatePublicConnectionOutput: + description: "" + elasticcache_PerformCancelDeleteOutput: + description: "" + elasticcache_PerformCancelExpireOutput: + description: "" + elasticcache_PerformChangeOwnerOutput: + description: "" + elasticcache_PerformChangeSpecOutput: + description: "" + elasticcache_PerformClassMetadataOutput: + description: "" + elasticcache_PerformFlushInstanceOutput: + description: "" + elasticcache_PerformFreezeOutput: + description: "" + elasticcache_PerformPostpaidExpireOutput: + description: "" + elasticcache_PerformPurgeSplitableOutput: + description: "" + elasticcache_PerformReleasePublicConnectionOutput: + description: "" + elasticcache_PerformRemoteUpdateOutput: + description: "" + elasticcache_PerformRenewOutput: + description: "" + elasticcache_PerformResetPasswordOutput: + description: "" + elasticcache_PerformRestartOutput: + description: "" + elasticcache_PerformRevokeSecgroupOutput: + description: "" + elasticcache_PerformSetAutoRenewOutput: + description: "" + elasticcache_PerformSetClassMetadataOutput: + description: "" + elasticcache_PerformSetMaintainTimeOutput: + description: "" + elasticcache_PerformSetOrgMetadataOutput: + description: "" + elasticcache_PerformSetSecgroupOutput: + description: "" + elasticcache_PerformSetUserMetadataOutput: + description: "" + elasticcache_PerformStatusOutput: + description: "" + elasticcache_PerformSyncOutput: + description: "" + elasticcache_PerformSyncstatusOutput: + description: "" + elasticcache_PerformUnfreezeOutput: + description: "" + elasticcache_PerformUpdateAuthModeOutput: + description: "" + elasticcache_PerformUpdateBackupPolicyOutput: + description: "" + elasticcache_PerformUpdateInstanceParametersOutput: + description: "" + elasticcache_ValidateCreateDataOutput: + description: "" + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheDetails' + type: object + elasticcache_ValidateUpdateDataOutput: + description: "" + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheDetails' + type: object + elasticcache_account_CustomizeDeleteOutput: + description: "" + schema: + properties: + elasticcache_account: + $ref: '#/definitions/ElasticcacheAccountDetails' + type: object + elasticcache_account_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + elasticcache_account: + $ref: '#/definitions/ElasticcacheAccountDetails' + type: object + elasticcache_account_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_account_GetDetailsLoginInfoOutput: + description: "" + elasticcache_account_GetDetailsMetadataOutput: + description: "" + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_account_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_account_GetDetailsStatusOutput: + description: "" + schema: + properties: + elasticcache_account: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_account_GetPropertyDistinctFieldOutput: + description: "" + elasticcache_account_GetPropertySplitableExportOutput: + description: "" + elasticcache_account_GetPropertySplitableOutput: + description: "" + elasticcache_account_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + elasticcache_account: + $ref: '#/definitions/StatusStatistic' + type: object + elasticcache_account_GetPropertyTagValuePairsOutput: + description: "" + elasticcache_account_GetPropertyTagValueTreeOutput: + description: "" + elasticcache_account_ListItemFilterOutput: + description: "" + schema: + properties: + elasticcache_accounts: + items: + $ref: '#/definitions/ElasticcacheAccountDetails' + 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 + elasticcache_account_PerformClassMetadataOutput: + description: "" + elasticcache_account_PerformPurgeSplitableOutput: + description: "" + elasticcache_account_PerformResetPasswordOutput: + description: "" + elasticcache_account_PerformSetClassMetadataOutput: + description: "" + elasticcache_account_PerformSetOrgMetadataOutput: + description: "" + elasticcache_account_PerformSetUserMetadataOutput: + description: "" + elasticcache_account_PerformStatusOutput: + description: "" + elasticcache_account_ValidateCreateDataOutput: + description: "" + schema: + properties: + elasticcache_account: + $ref: '#/definitions/ElasticcacheAccountDetails' + type: object + elasticcache_account_ValidateUpdateDataOutput: + description: "" + schema: + properties: + elasticcache_account: + $ref: '#/definitions/ElasticcacheAccountDetails' + type: object + elasticcache_acl_CustomizeDeleteOutput: + description: "" + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/ElasticcacheAclDetails' + type: object + elasticcache_acl_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/ElasticcacheAclDetails' + type: object + elasticcache_acl_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_acl_GetDetailsMetadataOutput: + description: "" + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_acl_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_acl_GetDetailsStatusOutput: + description: "" + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_acl_GetPropertyDistinctFieldOutput: + description: "" + elasticcache_acl_GetPropertySplitableExportOutput: + description: "" + elasticcache_acl_GetPropertySplitableOutput: + description: "" + elasticcache_acl_GetPropertyTagValuePairsOutput: + description: "" + elasticcache_acl_GetPropertyTagValueTreeOutput: + description: "" + elasticcache_acl_ListItemFilterOutput: + description: "" + schema: + properties: + elasticcache_acls: + items: + $ref: '#/definitions/ElasticcacheAclDetails' + 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 + elasticcache_acl_PerformClassMetadataOutput: + description: "" + elasticcache_acl_PerformPurgeSplitableOutput: + description: "" + elasticcache_acl_PerformSetClassMetadataOutput: + description: "" + elasticcache_acl_PerformSetOrgMetadataOutput: + description: "" + elasticcache_acl_PerformSetUserMetadataOutput: + description: "" + elasticcache_acl_PerformStatusOutput: + description: "" + elasticcache_acl_ValidateCreateDataOutput: + description: "" + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/ElasticcacheAclDetails' + type: object + elasticcache_acl_ValidateUpdateDataOutput: + description: "" + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/ElasticcacheAclDetails' + type: object + elasticcache_backup_CustomizeDeleteOutput: + description: "" + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/ElasticcacheBackupDetails' + type: object + elasticcache_backup_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/ElasticcacheBackupDetails' + type: object + elasticcache_backup_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_backup_GetDetailsMetadataOutput: + description: "" + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_backup_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_backup_GetDetailsStatusOutput: + description: "" + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_backup_GetPropertyDistinctFieldOutput: + description: "" + elasticcache_backup_GetPropertySplitableExportOutput: + description: "" + elasticcache_backup_GetPropertySplitableOutput: + description: "" + elasticcache_backup_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/StatusStatistic' + type: object + elasticcache_backup_GetPropertyTagValuePairsOutput: + description: "" + elasticcache_backup_GetPropertyTagValueTreeOutput: + description: "" + elasticcache_backup_ListItemFilterOutput: + description: "" + schema: + properties: + elasticcache_backups: + items: + $ref: '#/definitions/ElasticcacheBackupDetails' + 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 + elasticcache_backup_PerformClassMetadataOutput: + description: "" + elasticcache_backup_PerformPurgeSplitableOutput: + description: "" + elasticcache_backup_PerformRestoreInstanceOutput: + description: "" + elasticcache_backup_PerformSetClassMetadataOutput: + description: "" + elasticcache_backup_PerformSetOrgMetadataOutput: + description: "" + elasticcache_backup_PerformSetUserMetadataOutput: + description: "" + elasticcache_backup_PerformStatusOutput: + description: "" + elasticcache_backup_ValidateCreateDataOutput: + description: "" + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/ElasticcacheBackupDetails' + type: object + elasticcache_backup_ValidateUpdateDataOutput: + description: "" + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/ElasticcacheBackupDetails' + type: object + elasticcache_parameter_CustomizeDeleteOutput: + description: "" + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/ElasticcacheParameterDetails' + type: object + elasticcache_parameter_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/ElasticcacheParameterDetails' + type: object + elasticcache_parameter_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_parameter_GetDetailsMetadataOutput: + description: "" + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_parameter_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_parameter_GetDetailsStatusOutput: + description: "" + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_parameter_GetPropertyDistinctFieldOutput: + description: "" + elasticcache_parameter_GetPropertySplitableExportOutput: + description: "" + elasticcache_parameter_GetPropertySplitableOutput: + description: "" + elasticcache_parameter_GetPropertyTagValuePairsOutput: + description: "" + elasticcache_parameter_GetPropertyTagValueTreeOutput: + description: "" + elasticcache_parameter_ListItemFilterOutput: + description: "" + schema: + properties: + elasticcache_parameters: + items: + $ref: '#/definitions/ElasticcacheParameterDetails' + 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 + elasticcache_parameter_PerformClassMetadataOutput: + description: "" + elasticcache_parameter_PerformPurgeSplitableOutput: + description: "" + elasticcache_parameter_PerformSetClassMetadataOutput: + description: "" + elasticcache_parameter_PerformSetOrgMetadataOutput: + description: "" + elasticcache_parameter_PerformSetUserMetadataOutput: + description: "" + elasticcache_parameter_PerformStatusOutput: + description: "" + elasticcache_parameter_ValidateCreateDataOutput: + description: "" + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/ElasticcacheParameterDetails' + type: object + elasticcache_parameter_ValidateUpdateDataOutput: + description: "" + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/ElasticcacheParameterDetails' + type: object + elasticcache_sku_CustomizeDeleteOutput: + description: "" + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/ElasticcacheSkuDetails' + type: object + elasticcache_sku_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/ElasticcacheSkuDetails' + type: object + elasticcache_sku_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_sku_GetDetailsMetadataOutput: + description: "" + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_sku_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_sku_GetDetailsStatusOutput: + description: "" + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_sku_GetPropertyCapabilityOutput: + description: "" + elasticcache_sku_GetPropertyDistinctFieldOutput: + description: "" + elasticcache_sku_GetPropertyInstanceSpecsOutput: + description: "" + elasticcache_sku_GetPropertySplitableExportOutput: + description: "" + elasticcache_sku_GetPropertySplitableOutput: + description: "" + elasticcache_sku_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/StatusStatistic' + type: object + elasticcache_sku_GetPropertySyncTasksOutput: + description: "" + elasticcache_sku_GetPropertyTagValuePairsOutput: + description: "" + elasticcache_sku_GetPropertyTagValueTreeOutput: + description: "" + elasticcache_sku_ListItemFilterOutput: + description: "" + schema: + properties: + elasticcache_skus: + items: + $ref: '#/definitions/ElasticcacheSkuDetails' + 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 + elasticcache_sku_PerformClassMetadataOutput: + description: "" + elasticcache_sku_PerformPurgeSplitableOutput: + description: "" + elasticcache_sku_PerformSetClassMetadataOutput: + description: "" + elasticcache_sku_PerformSetOrgMetadataOutput: + description: "" + elasticcache_sku_PerformSetUserMetadataOutput: + description: "" + elasticcache_sku_PerformStatusOutput: + description: "" + elasticcache_sku_PerformSyncSkusOutput: + description: "" + elasticcache_sku_ValidateCreateDataOutput: + description: "" + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/ElasticcacheSkuDetails' + type: object + elasticcache_sku_ValidateUpdateDataOutput: + description: "" + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/ElasticcacheSkuDetails' + type: object + elasticcachesecgroup_CustomizeDeleteOutput: + description: "" + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcachesecgroupDetails' + type: object + elasticcachesecgroup_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcachesecgroupDetails' + type: object + elasticcachesecgroup_GetPropertyDistinctFieldOutput: + description: "" + elasticcachesecgroup_GetPropertySplitableExportOutput: + description: "" + elasticcachesecgroup_GetPropertySplitableOutput: + description: "" + elasticcachesecgroup_ListItemFilterOutput: + description: "" + schema: + properties: + elasticcachesecgroups: + items: + $ref: '#/definitions/ElasticcachesecgroupDetails' + 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 + elasticcachesecgroup_PerformPurgeSplitableOutput: + description: "" + elasticcachesecgroup_ValidateCreateDataOutput: + description: "" + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcachesecgroupDetails' + type: object + elasticcachesecgroup_ValidateUpdateDataOutput: + description: "" + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcachesecgroupDetails' + type: object + elasticip_CustomizeDeleteOutput: + description: "" + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipDetails' + type: object + elasticip_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipDetails' + type: object + elasticip_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + elasticip: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + elasticip_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticip_GetDetailsMetadataOutput: + description: "" + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticip_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticip_GetDetailsStatusOutput: + description: "" + schema: + properties: + elasticip: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticip_GetPropertyDistinctFieldOutput: + description: "" + elasticip_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + elasticip: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elasticip_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + elasticip: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elasticip_GetPropertyProjectTagValuePairsOutput: + description: "" + elasticip_GetPropertyProjectTagValueTreeOutput: + description: "" + elasticip_GetPropertySplitableExportOutput: + description: "" + elasticip_GetPropertySplitableOutput: + description: "" + elasticip_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + elasticip: + $ref: '#/definitions/StatusStatistic' + type: object + elasticip_GetPropertyTagValuePairsOutput: + description: "" + elasticip_GetPropertyTagValueTreeOutput: + description: "" + elasticip_ListItemFilterOutput: + description: "" + schema: + properties: + elasticips: + items: + $ref: '#/definitions/ElasticipDetails' + 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 + elasticip_PerformAssociateOutput: + description: "" + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipAssociateInput' + type: object + elasticip_PerformCancelDeleteOutput: + description: "" + elasticip_PerformChangeBandwidthOutput: + description: "" + elasticip_PerformChangeOwnerOutput: + description: "" + elasticip_PerformClassMetadataOutput: + description: "" + elasticip_PerformDissociateOutput: + description: "" + elasticip_PerformFreezeOutput: + description: "" + elasticip_PerformPurgeOutput: + description: "" + elasticip_PerformPurgeSplitableOutput: + description: "" + elasticip_PerformRemoteUpdateOutput: + description: "" + elasticip_PerformSetClassMetadataOutput: + description: "" + elasticip_PerformSetOrgMetadataOutput: + description: "" + elasticip_PerformSetUserMetadataOutput: + description: "" + elasticip_PerformStatusOutput: + description: "" + elasticip_PerformSyncOutput: + description: "" + elasticip_PerformSyncstatusOutput: + description: "" + elasticip_PerformUnfreezeOutput: + description: "" + elasticip_ValidateCreateDataOutput: + description: "" + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipDetails' + type: object + elasticip_ValidateUpdateDataOutput: + description: "" + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipDetails' + type: object + external_project_CustomizeDeleteOutput: + description: "" + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectDetails' + type: object + external_project_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectDetails' + type: object + external_project_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + external_project: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + external_project_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + external_project_GetDetailsMetadataOutput: + description: "" + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + external_project_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + external_project_GetDetailsStatusOutput: + description: "" + schema: + properties: + external_project: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + external_project_GetPropertyDistinctFieldOutput: + description: "" + external_project_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + external_project: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + external_project_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + external_project: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + external_project_GetPropertyProjectTagValuePairsOutput: + description: "" + external_project_GetPropertyProjectTagValueTreeOutput: + description: "" + external_project_GetPropertySplitableExportOutput: + description: "" + external_project_GetPropertySplitableOutput: + description: "" + external_project_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + external_project: + $ref: '#/definitions/StatusStatistic' + type: object + external_project_GetPropertyTagValuePairsOutput: + description: "" + external_project_GetPropertyTagValueTreeOutput: + description: "" + external_project_ListItemFilterOutput: + description: "" + schema: + properties: + external_projects: + items: + $ref: '#/definitions/ExternalProjectDetails' + 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 + external_project_PerformCancelDeleteOutput: + description: "" + external_project_PerformChangeOwnerOutput: + description: "" + external_project_PerformChangeProjectOutput: + description: "" + external_project_PerformClassMetadataOutput: + description: "" + external_project_PerformFreezeOutput: + description: "" + external_project_PerformPurgeSplitableOutput: + description: "" + external_project_PerformSetClassMetadataOutput: + description: "" + external_project_PerformSetOrgMetadataOutput: + description: "" + external_project_PerformSetUserMetadataOutput: + description: "" + external_project_PerformStatusOutput: + description: "" + external_project_PerformUnfreezeOutput: + description: "" + external_project_ValidateCreateDataOutput: + description: "" + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectDetails' + type: object + external_project_ValidateUpdateDataOutput: + description: "" + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectDetails' + type: object + file_system_CustomizeDeleteOutput: + description: "" + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemDetails' + type: object + file_system_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemDetails' + type: object + file_system_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + file_system: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + file_system_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + file_system_GetDetailsMetadataOutput: + description: "" + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + file_system_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + file_system_GetDetailsStatusOutput: + description: "" + schema: + properties: + file_system: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + file_system_GetPropertyDistinctFieldOutput: + description: "" + file_system_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + file_system: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + file_system_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + file_system: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + file_system_GetPropertyProjectTagValuePairsOutput: + description: "" + file_system_GetPropertyProjectTagValueTreeOutput: + description: "" + file_system_GetPropertySplitableExportOutput: + description: "" + file_system_GetPropertySplitableOutput: + description: "" + file_system_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + file_system: + $ref: '#/definitions/StatusStatistic' + type: object + file_system_GetPropertyTagValuePairsOutput: + description: "" + file_system_GetPropertyTagValueTreeOutput: + description: "" + file_system_ListItemFilterOutput: + description: "" + schema: + properties: + file_systems: + items: + $ref: '#/definitions/FileSystemDetails' + 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 + file_system_PerformCancelDeleteOutput: + description: "" + file_system_PerformChangeOwnerOutput: + description: "" + file_system_PerformClassMetadataOutput: + description: "" + file_system_PerformFreezeOutput: + description: "" + file_system_PerformPurgeSplitableOutput: + description: "" + file_system_PerformRemoteUpdateOutput: + description: "" + file_system_PerformSetClassMetadataOutput: + description: "" + file_system_PerformSetOrgMetadataOutput: + description: "" + file_system_PerformSetUserMetadataOutput: + description: "" + file_system_PerformStatusOutput: + description: "" + file_system_PerformSyncstatusOutput: + description: "" + file_system_PerformUnfreezeOutput: + description: "" + file_system_ValidateCreateDataOutput: + description: "" + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemDetails' + type: object + file_system_ValidateUpdateDataOutput: + description: "" + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemDetails' + type: object + global_vpc_CustomizeDeleteOutput: + description: "" + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalVpcDetails' + type: object + global_vpc_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalVpcDetails' + type: object + global_vpc_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + global_vpc: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + global_vpc_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + global_vpc_GetDetailsMetadataOutput: + description: "" + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + global_vpc_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + global_vpc_GetDetailsStatusOutput: + description: "" + schema: + properties: + global_vpc: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + global_vpc_GetPropertyDistinctFieldOutput: + description: "" + global_vpc_GetPropertyDomainTagValuePairsOutput: + description: "" + global_vpc_GetPropertyDomainTagValueTreeOutput: + description: "" + global_vpc_GetPropertySplitableExportOutput: + description: "" + global_vpc_GetPropertySplitableOutput: + description: "" + global_vpc_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + global_vpc: + $ref: '#/definitions/StatusStatistic' + type: object + global_vpc_GetPropertyTagValuePairsOutput: + description: "" + global_vpc_GetPropertyTagValueTreeOutput: + description: "" + global_vpc_ListItemFilterOutput: + description: "" + schema: + properties: + global_vpcs: + items: + $ref: '#/definitions/GlobalVpcDetails' + 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 + global_vpc_PerformChangeOwnerOutput: + description: "" + global_vpc_PerformClassMetadataOutput: + description: "" + global_vpc_PerformDisableOutput: + description: "" + global_vpc_PerformEnableOutput: + description: "" + global_vpc_PerformPrivateOutput: + description: "" + global_vpc_PerformPublicOutput: + description: "" + global_vpc_PerformPurgeSplitableOutput: + description: "" + global_vpc_PerformSetClassMetadataOutput: + description: "" + global_vpc_PerformSetOrgMetadataOutput: + description: "" + global_vpc_PerformSetUserMetadataOutput: + description: "" + global_vpc_PerformStatusOutput: + description: "" + global_vpc_PerformSyncstatusOutput: + description: "" + global_vpc_ValidateCreateDataOutput: + description: "" + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalVpcDetails' + type: object + global_vpc_ValidateUpdateDataOutput: + description: "" + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalVpcDetails' + type: object + group_CustomizeDeleteOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/InstanceGroupDetail' + type: object + group_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/InstanceGroupDetail' + type: object + group_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + group_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetDetailsMetadataOutput: + description: "" + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetDetailsStatusOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + group_GetPropertyDistinctFieldOutput: + description: "" + group_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + group_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + group_GetPropertyProjectTagValuePairsOutput: + description: "" + group_GetPropertyProjectTagValueTreeOutput: + description: "" + group_GetPropertySplitableExportOutput: + description: "" + group_GetPropertySplitableOutput: + description: "" + group_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/StatusStatistic' + type: object + group_GetPropertyTagValuePairsOutput: + description: "" + group_GetPropertyTagValueTreeOutput: + description: "" + group_ListItemFilterOutput: + description: "" + schema: + properties: + groups: + items: + $ref: '#/definitions/InstanceGroupDetail' + 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_PerformAssociateEipOutput: + description: "" + group_PerformAttachnetworkOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/SGroup' + type: object + group_PerformBindGuestsOutput: + description: "" + group_PerformCancelDeleteOutput: + description: "" + group_PerformChangeOwnerOutput: + description: "" + group_PerformClassMetadataOutput: + description: "" + group_PerformCreateEipOutput: + description: "" + group_PerformDetachnetworkOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/SGroup' + type: object + group_PerformDisableOutput: + description: "" + group_PerformDissociateEipOutput: + description: "" + group_PerformEnableOutput: + description: "" + group_PerformFreezeOutput: + description: "" + group_PerformPurgeSplitableOutput: + description: "" + group_PerformSetClassMetadataOutput: + description: "" + group_PerformSetOrgMetadataOutput: + description: "" + group_PerformSetUserMetadataOutput: + description: "" + group_PerformStatusOutput: + description: "" + group_PerformUnbindGuestsOutput: + description: "" + group_PerformUnfreezeOutput: + description: "" + group_ValidateCreateDataOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/InstanceGroupDetail' + type: object + group_ValidateUpdateDataOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/InstanceGroupDetail' + type: object + groupguest_CustomizeDeleteOutput: + description: "" + schema: + properties: + groupguest: + $ref: '#/definitions/GroupguestDetails' + type: object + groupguest_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + groupguest: + $ref: '#/definitions/GroupguestDetails' + type: object + groupguest_GetPropertyDistinctFieldOutput: + description: "" + groupguest_GetPropertySplitableExportOutput: + description: "" + groupguest_GetPropertySplitableOutput: + description: "" + groupguest_ListItemFilterOutput: + description: "" + schema: + properties: + groupguests: + items: + $ref: '#/definitions/GroupguestDetails' + 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 + groupguest_PerformPurgeSplitableOutput: + description: "" + groupguest_ValidateCreateDataOutput: + description: "" + schema: + properties: + groupguest: + $ref: '#/definitions/GroupguestDetails' + type: object + groupguest_ValidateUpdateDataOutput: + description: "" + schema: + properties: + groupguest: + $ref: '#/definitions/GroupguestDetails' + type: object + groupnetwork_CustomizeDeleteOutput: + description: "" + schema: + properties: + groupnetwork: + $ref: '#/definitions/GroupnetworkDetails' + type: object + groupnetwork_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + groupnetwork: + $ref: '#/definitions/GroupnetworkDetails' + type: object + groupnetwork_GetPropertyDistinctFieldOutput: + description: "" + groupnetwork_GetPropertySplitableExportOutput: + description: "" + groupnetwork_GetPropertySplitableOutput: + description: "" + groupnetwork_ListItemFilterOutput: + description: "" + schema: + properties: + groupnetworks: + items: + $ref: '#/definitions/GroupnetworkDetails' + 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 + groupnetwork_PerformPurgeSplitableOutput: + description: "" + groupnetwork_ValidateCreateDataOutput: + description: "" + schema: + properties: + groupnetwork: + $ref: '#/definitions/GroupnetworkDetails' + type: object + groupnetwork_ValidateUpdateDataOutput: + description: "" + schema: + properties: + groupnetwork: + $ref: '#/definitions/GroupnetworkDetails' + type: object + guest_template_CustomizeDeleteOutput: + description: "" + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateDetails' + type: object + guest_template_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateDetails' + type: object + guest_template_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + guest_template: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + guest_template_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_template_GetDetailsMetadataOutput: + description: "" + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_template_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_template_GetDetailsStatusOutput: + description: "" + schema: + properties: + guest_template: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + guest_template_GetPropertyDistinctFieldOutput: + description: "" + guest_template_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + guest_template: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + guest_template_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + guest_template: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + guest_template_GetPropertyProjectTagValuePairsOutput: + description: "" + guest_template_GetPropertyProjectTagValueTreeOutput: + description: "" + guest_template_GetPropertySplitableExportOutput: + description: "" + guest_template_GetPropertySplitableOutput: + description: "" + guest_template_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + guest_template: + $ref: '#/definitions/StatusStatistic' + type: object + guest_template_GetPropertyTagValuePairsOutput: + description: "" + guest_template_GetPropertyTagValueTreeOutput: + description: "" + guest_template_ListItemFilterOutput: + description: "" + schema: + properties: + guest_templates: + items: + $ref: '#/definitions/GuestTemplateDetails' + 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 + guest_template_PerformCancelDeleteOutput: + description: "" + guest_template_PerformChangeOwnerOutput: + description: "" + guest_template_PerformClassMetadataOutput: + description: "" + guest_template_PerformFreezeOutput: + description: "" + guest_template_PerformInspectOutput: + description: "" + guest_template_PerformPrivateOutput: + description: "" + guest_template_PerformPublicOutput: + description: "" + guest_template_PerformPurgeSplitableOutput: + description: "" + guest_template_PerformSetClassMetadataOutput: + description: "" + guest_template_PerformSetOrgMetadataOutput: + description: "" + guest_template_PerformSetUserMetadataOutput: + description: "" + guest_template_PerformStatusOutput: + description: "" + guest_template_PerformUnfreezeOutput: + description: "" + guest_template_ValidateCreateDataOutput: + description: "" + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateDetails' + type: object + guest_template_ValidateUpdateDataOutput: + description: "" + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateDetails' + type: object + guestdisk_CustomizeDeleteOutput: + description: "" + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestDiskDetails' + type: object + guestdisk_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestDiskDetails' + type: object + guestdisk_GetPropertyDistinctFieldOutput: + description: "" + guestdisk_GetPropertySplitableExportOutput: + description: "" + guestdisk_GetPropertySplitableOutput: + description: "" + guestdisk_ListItemFilterOutput: + description: "" + schema: + properties: + guestdisks: + items: + $ref: '#/definitions/GuestDiskDetails' + 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 + guestdisk_PerformPurgeSplitableOutput: + description: "" + guestdisk_ValidateCreateDataOutput: + description: "" + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestDiskDetails' + type: object + guestdisk_ValidateUpdateDataOutput: + description: "" + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestDiskDetails' + type: object + guestnetwork_CustomizeDeleteOutput: + description: "" + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + type: object + guestnetwork_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + type: object + guestnetwork_GetPropertyDistinctFieldOutput: + description: "" + guestnetwork_GetPropertySplitableExportOutput: + description: "" + guestnetwork_GetPropertySplitableOutput: + description: "" + guestnetwork_ListItemFilterOutput: + description: "" + schema: + properties: + guestnetworks: + items: + $ref: '#/definitions/GuestnetworkDetails' + 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 + guestnetwork_PerformPurgeSplitableOutput: + description: "" + guestnetwork_ValidateCreateDataOutput: + description: "" + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + type: object + guestnetwork_ValidateUpdateDataOutput: + description: "" + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + type: object + guestsecgroup_CustomizeDeleteOutput: + description: "" + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestsecgroupDetails' + type: object + guestsecgroup_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestsecgroupDetails' + type: object + guestsecgroup_GetPropertyDistinctFieldOutput: + description: "" + guestsecgroup_GetPropertySplitableExportOutput: + description: "" + guestsecgroup_GetPropertySplitableOutput: + description: "" + guestsecgroup_ListItemFilterOutput: + description: "" + schema: + properties: + guestsecgroups: + items: + $ref: '#/definitions/GuestsecgroupDetails' + 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 + guestsecgroup_PerformPurgeSplitableOutput: + description: "" + guestsecgroup_ValidateCreateDataOutput: + description: "" + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestsecgroupDetails' + type: object + guestsecgroup_ValidateUpdateDataOutput: + description: "" + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestsecgroupDetails' + type: object + host_CustomizeDeleteOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/HostDetails' + type: object + host_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/HostDetails' + type: object + host_GetDetailsAppOptionsOutput: + description: "" + host_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + host_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + host_GetDetailsIpmiOutput: + description: "" + host_GetDetailsJnlpOutput: + description: "" + host_GetDetailsMetadataOutput: + description: "" + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + host_GetDetailsNicsOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/ListResult' + type: object + host_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + host_GetDetailsSpecOutput: + description: "" + host_GetDetailsStatusOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + host_GetDetailsTapConfigOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/SHostTapConfig' + type: object + host_GetDetailsVncOutput: + description: "" + host_GetPropertyBmStartRegisterScriptOutput: + description: "" + host_GetPropertyDistinctFieldOutput: + description: "" + host_GetPropertyDomainTagValuePairsOutput: + description: "" + host_GetPropertyDomainTagValueTreeOutput: + description: "" + host_GetPropertyHostTypeCountOutput: + description: "" + host_GetPropertyK8sMasterNodeIpsOutput: + description: "" + host_GetPropertyNodeCountOutput: + description: "" + host_GetPropertySplitableExportOutput: + description: "" + host_GetPropertySplitableOutput: + description: "" + host_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/StatusStatistic' + type: object + host_GetPropertyTagValuePairsOutput: + description: "" + host_GetPropertyTagValueTreeOutput: + description: "" + host_ListItemFilterOutput: + description: "" + schema: + properties: + hosts: + items: + $ref: '#/definitions/HostDetails' + 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 + host_PerformAddNetifOutput: + description: "" + host_PerformAutoMigrateOnHostDownOutput: + description: "" + host_PerformCacheImageOutput: + description: "" + host_PerformChangeOwnerOutput: + description: "" + host_PerformClassMetadataOutput: + description: "" + host_PerformConvertHypervisorOutput: + description: "" + host_PerformDisableNetifOutput: + description: "" + host_PerformDisableOutput: + description: "" + host_PerformEjectIsoOutput: + description: "" + host_PerformEnableNetifOutput: + description: "" + host_PerformEnableOutput: + description: "" + host_PerformHostExitMaintenanceOutput: + description: "" + host_PerformHostMaintenanceOutput: + description: "" + host_PerformInitializeOutput: + description: "" + host_PerformInsertIsoOutput: + description: "" + host_PerformIpmiProbeOutput: + description: "" + host_PerformLoginInfoOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/HostLoginInfoOutput' + type: object + host_PerformMaintenanceOutput: + description: "" + host_PerformOfflineOutput: + description: "" + host_PerformOnlineOutput: + description: "" + host_PerformPingOutput: + description: "" + host_PerformPrepareOutput: + description: "" + host_PerformPrivateOutput: + description: "" + host_PerformProbeIsolatedDevicesOutput: + description: "" + host_PerformPublicOutput: + description: "" + host_PerformPurgeOutput: + description: "" + host_PerformPurgeSplitableOutput: + description: "" + host_PerformRemoveAllNetifsOutput: + description: "" + host_PerformRemoveNetifOutput: + description: "" + host_PerformRenewPrepaidRecycleOutput: + description: "" + host_PerformReserveCpusOutput: + description: "" + host_PerformResetOutput: + description: "" + host_PerformRestartHostAgentOutput: + description: "" + host_PerformSetClassMetadataOutput: + description: "" + host_PerformSetOrgMetadataOutput: + description: "" + host_PerformSetReservedResourceForIsolatedDeviceOutput: + description: "" + host_PerformSetSchedtagOutput: + description: "" + host_PerformSetUserMetadataOutput: + description: "" + host_PerformStartOutput: + description: "" + host_PerformStatusOutput: + description: "" + host_PerformStopOutput: + description: "" + host_PerformSyncConfigOutput: + description: "" + host_PerformSyncGuestNicTrafficsOutput: + description: "" + host_PerformSyncstatusOutput: + description: "" + host_PerformUndoConvertOutput: + description: "" + host_PerformUndoPrepaidRecycleOutput: + description: "" + host_PerformUnmaintenanceOutput: + description: "" + host_PerformUnreserveCpusOutput: + description: "" + host_PerformUpdateStorageOutput: + description: "" + host_ValidateCreateDataOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/HostDetails' + type: object + host_ValidateUpdateDataOutput: + description: "" + schema: + properties: + host: + $ref: '#/definitions/HostDetails' + type: object + host_backupstorage_CustomizeDeleteOutput: + description: "" + schema: + properties: + host_backupstorage: + $ref: '#/definitions/HostBackupstorageDetails' + type: object + host_backupstorage_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + host_backupstorage: + $ref: '#/definitions/HostBackupstorageDetails' + type: object + host_backupstorage_GetPropertyDistinctFieldOutput: + description: "" + host_backupstorage_GetPropertySplitableExportOutput: + description: "" + host_backupstorage_GetPropertySplitableOutput: + description: "" + host_backupstorage_ListItemFilterOutput: + description: "" + schema: + properties: + host_backupstorages: + items: + $ref: '#/definitions/HostBackupstorageDetails' + 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 + host_backupstorage_PerformPurgeSplitableOutput: + description: "" + host_backupstorage_ValidateCreateDataOutput: + description: "" + schema: + properties: + host_backupstorage: + $ref: '#/definitions/HostBackupstorageDetails' + type: object + host_backupstorage_ValidateUpdateDataOutput: + description: "" + schema: + properties: + host_backupstorage: + $ref: '#/definitions/HostBackupstorageDetails' + type: object + host_isolated_device_model_CustomizeDeleteOutput: + description: "" + schema: + properties: + host_isolated_device_model: + $ref: '#/definitions/HostIsolatedDeviceModelDetails' + type: object + host_isolated_device_model_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + host_isolated_device_model: + $ref: '#/definitions/HostIsolatedDeviceModelDetails' + type: object + host_isolated_device_model_GetPropertyDistinctFieldOutput: + description: "" + host_isolated_device_model_GetPropertySplitableExportOutput: + description: "" + host_isolated_device_model_GetPropertySplitableOutput: + description: "" + host_isolated_device_model_ListItemFilterOutput: + description: "" + schema: + properties: + host_isolated_device_models: + items: + $ref: '#/definitions/HostIsolatedDeviceModelDetails' + 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 + host_isolated_device_model_PerformPurgeSplitableOutput: + description: "" + host_isolated_device_model_ValidateCreateDataOutput: + description: "" + schema: + properties: + host_isolated_device_model: + $ref: '#/definitions/HostIsolatedDeviceModelDetails' + type: object + host_isolated_device_model_ValidateUpdateDataOutput: + description: "" + schema: + properties: + host_isolated_device_model: + $ref: '#/definitions/HostIsolatedDeviceModelDetails' + type: object + hostnetwork_CustomizeDeleteOutput: + description: "" + schema: + properties: + hostnetwork: + $ref: '#/definitions/HostnetworkDetails' + type: object + hostnetwork_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + hostnetwork: + $ref: '#/definitions/HostnetworkDetails' + type: object + hostnetwork_GetPropertyDistinctFieldOutput: + description: "" + hostnetwork_GetPropertySplitableExportOutput: + description: "" + hostnetwork_GetPropertySplitableOutput: + description: "" + hostnetwork_ListItemFilterOutput: + description: "" + schema: + properties: + hostnetworks: + items: + $ref: '#/definitions/HostnetworkDetails' + 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 + hostnetwork_PerformPurgeSplitableOutput: + description: "" + hostnetwork_ValidateCreateDataOutput: + description: "" + schema: + properties: + hostnetwork: + $ref: '#/definitions/HostnetworkDetails' + type: object + hostnetwork_ValidateUpdateDataOutput: + description: "" + schema: + properties: + hostnetwork: + $ref: '#/definitions/HostnetworkDetails' + type: object + hoststorage_CustomizeDeleteOutput: + description: "" + schema: + properties: + hoststorage: + $ref: '#/definitions/HoststorageDetails' + type: object + hoststorage_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + hoststorage: + $ref: '#/definitions/HoststorageDetails' + type: object + hoststorage_GetPropertyDistinctFieldOutput: + description: "" + hoststorage_GetPropertySplitableExportOutput: + description: "" + hoststorage_GetPropertySplitableOutput: + description: "" + hoststorage_ListItemFilterOutput: + description: "" + schema: + properties: + hoststorages: + items: + $ref: '#/definitions/HoststorageDetails' + 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 + hoststorage_PerformPurgeSplitableOutput: + description: "" + hoststorage_ValidateCreateDataOutput: + description: "" + schema: + properties: + hoststorage: + $ref: '#/definitions/HoststorageDetails' + type: object + hoststorage_ValidateUpdateDataOutput: + description: "" + schema: + properties: + hoststorage: + $ref: '#/definitions/HoststorageDetails' + type: object + instance_backup_CustomizeDeleteOutput: + description: "" + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupDetails' + type: object + instance_backup_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupDetails' + type: object + instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + instance_backup: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + instance_backup_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_backup_GetDetailsMetadataOutput: + description: "" + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_backup_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_backup_GetDetailsStatusOutput: + description: "" + schema: + properties: + instance_backup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + instance_backup_GetPropertyDistinctFieldOutput: + description: "" + instance_backup_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + instance_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + instance_backup_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + instance_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + instance_backup_GetPropertyProjectTagValuePairsOutput: + description: "" + instance_backup_GetPropertyProjectTagValueTreeOutput: + description: "" + instance_backup_GetPropertySplitableExportOutput: + description: "" + instance_backup_GetPropertySplitableOutput: + description: "" + instance_backup_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + instance_backup: + $ref: '#/definitions/StatusStatistic' + type: object + instance_backup_GetPropertyTagValuePairsOutput: + description: "" + instance_backup_GetPropertyTagValueTreeOutput: + description: "" + instance_backup_ListItemFilterOutput: + description: "" + schema: + properties: + instance_backups: + items: + $ref: '#/definitions/InstanceBackupDetails' + 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 + instance_backup_PerformCancelDeleteOutput: + description: "" + instance_backup_PerformChangeOwnerOutput: + description: "" + instance_backup_PerformClassMetadataOutput: + description: "" + instance_backup_PerformFreezeOutput: + description: "" + instance_backup_PerformPackOutput: + description: "" + instance_backup_PerformPurgeSplitableOutput: + description: "" + instance_backup_PerformRecoveryOutput: + description: "" + instance_backup_PerformSetClassMetadataOutput: + description: "" + instance_backup_PerformSetOrgMetadataOutput: + description: "" + instance_backup_PerformSetUserMetadataOutput: + description: "" + instance_backup_PerformStatusOutput: + description: "" + instance_backup_PerformSyncstatusOutput: + description: "" + instance_backup_PerformUnfreezeOutput: + description: "" + instance_backup_ValidateCreateDataOutput: + description: "" + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupDetails' + type: object + instance_backup_ValidateUpdateDataOutput: + description: "" + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupDetails' + type: object + instance_snapshot_CustomizeDeleteOutput: + description: "" + schema: + properties: + instance_snapshot: + $ref: '#/definitions/InstanceSnapshotDetails' + type: object + instance_snapshot_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + instance_snapshot: + $ref: '#/definitions/InstanceSnapshotDetails' + type: object + instance_snapshot_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + instance_snapshot: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + instance_snapshot_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_snapshot_GetDetailsMetadataOutput: + description: "" + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_snapshot_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_snapshot_GetDetailsStatusOutput: + description: "" + schema: + properties: + instance_snapshot: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + instance_snapshot_GetPropertyDistinctFieldOutput: + description: "" + instance_snapshot_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + instance_snapshot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + instance_snapshot_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + instance_snapshot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + instance_snapshot_GetPropertyProjectTagValuePairsOutput: + description: "" + instance_snapshot_GetPropertyProjectTagValueTreeOutput: + description: "" + instance_snapshot_GetPropertySplitableExportOutput: + description: "" + instance_snapshot_GetPropertySplitableOutput: + description: "" + instance_snapshot_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + instance_snapshot: + $ref: '#/definitions/StatusStatistic' + type: object + instance_snapshot_GetPropertyTagValuePairsOutput: + description: "" + instance_snapshot_GetPropertyTagValueTreeOutput: + description: "" + instance_snapshot_ListItemFilterOutput: + description: "" + schema: + properties: + instance_snapshots: + items: + $ref: '#/definitions/InstanceSnapshotDetails' + 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 + instance_snapshot_PerformCancelDeleteOutput: + description: "" + instance_snapshot_PerformChangeOwnerOutput: + description: "" + instance_snapshot_PerformClassMetadataOutput: + description: "" + instance_snapshot_PerformFreezeOutput: + description: "" + instance_snapshot_PerformPurgeSplitableOutput: + description: "" + instance_snapshot_PerformSetClassMetadataOutput: + description: "" + instance_snapshot_PerformSetOrgMetadataOutput: + description: "" + instance_snapshot_PerformSetUserMetadataOutput: + description: "" + instance_snapshot_PerformStatusOutput: + description: "" + instance_snapshot_PerformUnfreezeOutput: + description: "" + instance_snapshot_ValidateCreateDataOutput: + description: "" + schema: + properties: + instance_snapshot: + $ref: '#/definitions/InstanceSnapshotDetails' + type: object + instance_snapshot_ValidateUpdateDataOutput: + description: "" + schema: + properties: + instance_snapshot: + $ref: '#/definitions/InstanceSnapshotDetails' + type: object + inter_vpc_network_CustomizeDeleteOutput: + description: "" + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkDetails' + type: object + inter_vpc_network_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkDetails' + type: object + inter_vpc_network_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + inter_vpc_network_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_GetDetailsMetadataOutput: + description: "" + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_GetDetailsStatusOutput: + description: "" + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + inter_vpc_network_GetPropertyDistinctFieldOutput: + description: "" + inter_vpc_network_GetPropertyDomainTagValuePairsOutput: + description: "" + inter_vpc_network_GetPropertyDomainTagValueTreeOutput: + description: "" + inter_vpc_network_GetPropertySplitableExportOutput: + description: "" + inter_vpc_network_GetPropertySplitableOutput: + description: "" + inter_vpc_network_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/StatusStatistic' + type: object + inter_vpc_network_GetPropertyTagValuePairsOutput: + description: "" + inter_vpc_network_GetPropertyTagValueTreeOutput: + description: "" + inter_vpc_network_ListItemFilterOutput: + description: "" + schema: + properties: + inter_vpc_networks: + items: + $ref: '#/definitions/InterVpcNetworkDetails' + 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 + inter_vpc_network_PerformAddvpcOutput: + description: "" + inter_vpc_network_PerformChangeOwnerOutput: + description: "" + inter_vpc_network_PerformClassMetadataOutput: + description: "" + inter_vpc_network_PerformDisableOutput: + description: "" + inter_vpc_network_PerformEnableOutput: + description: "" + inter_vpc_network_PerformPrivateOutput: + description: "" + inter_vpc_network_PerformPublicOutput: + description: "" + inter_vpc_network_PerformPurgeSplitableOutput: + description: "" + inter_vpc_network_PerformRemovevpcOutput: + description: "" + inter_vpc_network_PerformSetClassMetadataOutput: + description: "" + inter_vpc_network_PerformSetOrgMetadataOutput: + description: "" + inter_vpc_network_PerformSetUserMetadataOutput: + description: "" + inter_vpc_network_PerformStatusOutput: + description: "" + inter_vpc_network_PerformSyncstatusOutput: + description: "" + inter_vpc_network_ValidateCreateDataOutput: + description: "" + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkDetails' + type: object + inter_vpc_network_ValidateUpdateDataOutput: + description: "" + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkDetails' + type: object + inter_vpc_network_route_set_CustomizeDeleteOutput: + description: "" + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + type: object + inter_vpc_network_route_set_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + type: object + inter_vpc_network_route_set_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_route_set_GetDetailsMetadataOutput: + description: "" + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_route_set_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_route_set_GetDetailsStatusOutput: + description: "" + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + inter_vpc_network_route_set_GetPropertyDistinctFieldOutput: + description: "" + inter_vpc_network_route_set_GetPropertySplitableExportOutput: + description: "" + inter_vpc_network_route_set_GetPropertySplitableOutput: + description: "" + inter_vpc_network_route_set_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/StatusStatistic' + type: object + inter_vpc_network_route_set_GetPropertyTagValuePairsOutput: + description: "" + inter_vpc_network_route_set_GetPropertyTagValueTreeOutput: + description: "" + inter_vpc_network_route_set_ListItemFilterOutput: + description: "" + schema: + properties: + inter_vpc_network_route_sets: + items: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + 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 + inter_vpc_network_route_set_PerformClassMetadataOutput: + description: "" + inter_vpc_network_route_set_PerformDisableOutput: + description: "" + inter_vpc_network_route_set_PerformEnableOutput: + description: "" + inter_vpc_network_route_set_PerformPurgeSplitableOutput: + description: "" + inter_vpc_network_route_set_PerformSetClassMetadataOutput: + description: "" + inter_vpc_network_route_set_PerformSetOrgMetadataOutput: + description: "" + inter_vpc_network_route_set_PerformSetUserMetadataOutput: + description: "" + inter_vpc_network_route_set_PerformStatusOutput: + description: "" + inter_vpc_network_route_set_ValidateCreateDataOutput: + description: "" + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + type: object + inter_vpc_network_route_set_ValidateUpdateDataOutput: + description: "" + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + type: object + inter_vpc_network_vpc_CustomizeDeleteOutput: + description: "" + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + inter_vpc_network_vpc_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + inter_vpc_network_vpc_GetPropertyDistinctFieldOutput: + description: "" + inter_vpc_network_vpc_GetPropertySplitableExportOutput: + description: "" + inter_vpc_network_vpc_GetPropertySplitableOutput: + description: "" + inter_vpc_network_vpc_ListItemFilterOutput: + description: "" + schema: + properties: + inter_vpc_network_vpcs: + items: + $ref: '#/definitions/JointResourceBaseDetails' + 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 + inter_vpc_network_vpc_PerformPurgeSplitableOutput: + description: "" + inter_vpc_network_vpc_ValidateCreateDataOutput: + description: "" + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + inter_vpc_network_vpc_ValidateUpdateDataOutput: + description: "" + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + ipv6_gateway_CustomizeDeleteOutput: + description: "" + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayDetails' + type: object + ipv6_gateway_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayDetails' + type: object + ipv6_gateway_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + ipv6_gateway_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + ipv6_gateway_GetDetailsMetadataOutput: + description: "" + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + ipv6_gateway_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + ipv6_gateway_GetDetailsStatusOutput: + description: "" + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + ipv6_gateway_GetPropertyDistinctFieldOutput: + description: "" + ipv6_gateway_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + ipv6_gateway: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + ipv6_gateway_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + ipv6_gateway: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + ipv6_gateway_GetPropertyProjectTagValuePairsOutput: + description: "" + ipv6_gateway_GetPropertyProjectTagValueTreeOutput: + description: "" + ipv6_gateway_GetPropertySplitableExportOutput: + description: "" + ipv6_gateway_GetPropertySplitableOutput: + description: "" + ipv6_gateway_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/StatusStatistic' + type: object + ipv6_gateway_GetPropertyTagValuePairsOutput: + description: "" + ipv6_gateway_GetPropertyTagValueTreeOutput: + description: "" + ipv6_gateway_ListItemFilterOutput: + description: "" + schema: + properties: + ipv6_gateways: + items: + $ref: '#/definitions/IPv6GatewayDetails' + 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 + ipv6_gateway_PerformCancelDeleteOutput: + description: "" + ipv6_gateway_PerformChangeOwnerOutput: + description: "" + ipv6_gateway_PerformClassMetadataOutput: + description: "" + ipv6_gateway_PerformFreezeOutput: + description: "" + ipv6_gateway_PerformPrivateOutput: + description: "" + ipv6_gateway_PerformPublicOutput: + description: "" + ipv6_gateway_PerformPurgeSplitableOutput: + description: "" + ipv6_gateway_PerformSetClassMetadataOutput: + description: "" + ipv6_gateway_PerformSetOrgMetadataOutput: + description: "" + ipv6_gateway_PerformSetUserMetadataOutput: + description: "" + ipv6_gateway_PerformStatusOutput: + description: "" + ipv6_gateway_PerformUnfreezeOutput: + description: "" + ipv6_gateway_ValidateCreateDataOutput: + description: "" + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayDetails' + type: object + ipv6_gateway_ValidateUpdateDataOutput: + description: "" + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayDetails' + type: object + isolated_device_CustomizeDeleteOutput: + description: "" + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolateDeviceDetails' + type: object + isolated_device_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolateDeviceDetails' + type: object + isolated_device_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_GetDetailsMetadataOutput: + description: "" + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_GetPropertyDistinctFieldOutput: + description: "" + isolated_device_GetPropertySplitableExportOutput: + description: "" + isolated_device_GetPropertySplitableOutput: + description: "" + isolated_device_GetPropertyTagValuePairsOutput: + description: "" + isolated_device_GetPropertyTagValueTreeOutput: + description: "" + isolated_device_ListItemFilterOutput: + description: "" + schema: + properties: + isolated_devices: + items: + $ref: '#/definitions/IsolateDeviceDetails' + 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 + isolated_device_PerformClassMetadataOutput: + description: "" + isolated_device_PerformPurgeOutput: + description: "" + isolated_device_PerformPurgeSplitableOutput: + description: "" + isolated_device_PerformSetClassMetadataOutput: + description: "" + isolated_device_PerformSetOrgMetadataOutput: + description: "" + isolated_device_PerformSetUserMetadataOutput: + description: "" + isolated_device_ValidateCreateDataOutput: + description: "" + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolateDeviceDetails' + type: object + isolated_device_ValidateUpdateDataOutput: + description: "" + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolateDeviceDetails' + type: object + isolated_device_model_CustomizeDeleteOutput: + description: "" + schema: + properties: + isolated_device_model: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + isolated_device_model_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + isolated_device_model: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + isolated_device_model_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_model_GetDetailsHardwareInfoOutput: + description: "" + schema: + properties: + isolated_device_model: + $ref: '#/definitions/IsolatedDeviceModelHardwareInfo' + type: object + isolated_device_model_GetDetailsMetadataOutput: + description: "" + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_model_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_model_GetPropertyDistinctFieldOutput: + description: "" + isolated_device_model_GetPropertySplitableExportOutput: + description: "" + isolated_device_model_GetPropertySplitableOutput: + description: "" + isolated_device_model_GetPropertyTagValuePairsOutput: + description: "" + isolated_device_model_GetPropertyTagValueTreeOutput: + description: "" + isolated_device_model_ListItemFilterOutput: + description: "" + schema: + properties: + isolated_device_models: + items: + $ref: '#/definitions/StandaloneAnonResourceDetails' + 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 + isolated_device_model_PerformClassMetadataOutput: + description: "" + isolated_device_model_PerformPurgeSplitableOutput: + description: "" + isolated_device_model_PerformSetClassMetadataOutput: + description: "" + isolated_device_model_PerformSetHardwareInfoOutput: + description: "" + schema: + properties: + isolated_device_model: + $ref: '#/definitions/IsolatedDeviceModelHardwareInfo' + type: object + isolated_device_model_PerformSetOrgMetadataOutput: + description: "" + isolated_device_model_PerformSetUserMetadataOutput: + description: "" + isolated_device_model_ValidateCreateDataOutput: + description: "" + schema: + properties: + isolated_device_model: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + isolated_device_model_ValidateUpdateDataOutput: + description: "" + schema: + properties: + isolated_device_model: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + kafka_CustomizeDeleteOutput: + description: "" + schema: + properties: + kafka: + $ref: '#/definitions/KafkaDetails' + type: object + kafka_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + kafka: + $ref: '#/definitions/KafkaDetails' + type: object + kafka_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + kafka: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + kafka_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kafka_GetDetailsMetadataOutput: + description: "" + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kafka_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kafka_GetDetailsStatusOutput: + description: "" + schema: + properties: + kafka: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + kafka_GetDetailsTopicsOutput: + description: "" + schema: + properties: + kafka: + items: + $ref: '#/definitions/SKafkaTopic' + type: array + x-go-name: Output + type: object + kafka_GetPropertyDistinctFieldOutput: + description: "" + kafka_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + kafka: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + kafka_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + kafka: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + kafka_GetPropertyProjectTagValuePairsOutput: + description: "" + kafka_GetPropertyProjectTagValueTreeOutput: + description: "" + kafka_GetPropertySplitableExportOutput: + description: "" + kafka_GetPropertySplitableOutput: + description: "" + kafka_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + kafka: + $ref: '#/definitions/StatusStatistic' + type: object + kafka_GetPropertyTagValuePairsOutput: + description: "" + kafka_GetPropertyTagValueTreeOutput: + description: "" + kafka_ListItemFilterOutput: + description: "" + schema: + properties: + kafkas: + items: + $ref: '#/definitions/KafkaDetails' + 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 + kafka_PerformCancelDeleteOutput: + description: "" + kafka_PerformChangeOwnerOutput: + description: "" + kafka_PerformClassMetadataOutput: + description: "" + kafka_PerformFreezeOutput: + description: "" + kafka_PerformPurgeSplitableOutput: + description: "" + kafka_PerformSetClassMetadataOutput: + description: "" + kafka_PerformSetOrgMetadataOutput: + description: "" + kafka_PerformSetUserMetadataOutput: + description: "" + kafka_PerformStatusOutput: + description: "" + kafka_PerformSyncstatusOutput: + description: "" + kafka_PerformUnfreezeOutput: + description: "" + kafka_ValidateCreateDataOutput: + description: "" + schema: + properties: + kafka: + $ref: '#/definitions/KafkaDetails' + type: object + kafka_ValidateUpdateDataOutput: + description: "" + schema: + properties: + kafka: + $ref: '#/definitions/KafkaDetails' + type: object + keypair_CustomizeDeleteOutput: + description: "" + schema: + properties: + keypair: + $ref: '#/definitions/KeypairDetails' + type: object + keypair_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + keypair: + $ref: '#/definitions/KeypairDetails' + type: object + keypair_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + keypair: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + keypair_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + keypair_GetDetailsMetadataOutput: + description: "" + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + keypair_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + keypair_GetDetailsPrivatekeyOutput: + description: "" + keypair_GetPropertyDistinctFieldOutput: + description: "" + keypair_GetPropertySplitableExportOutput: + description: "" + keypair_GetPropertySplitableOutput: + description: "" + keypair_GetPropertyTagValuePairsOutput: + description: "" + keypair_GetPropertyTagValueTreeOutput: + description: "" + keypair_ListItemFilterOutput: + description: "" + schema: + properties: + keypairs: + items: + $ref: '#/definitions/KeypairDetails' + 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 + keypair_PerformClassMetadataOutput: + description: "" + keypair_PerformPrivateOutput: + description: "" + keypair_PerformPublicOutput: + description: "" + keypair_PerformPurgeSplitableOutput: + description: "" + keypair_PerformSetClassMetadataOutput: + description: "" + keypair_PerformSetOrgMetadataOutput: + description: "" + keypair_PerformSetUserMetadataOutput: + description: "" + keypair_ValidateCreateDataOutput: + description: "" + schema: + properties: + keypair: + $ref: '#/definitions/KeypairDetails' + type: object + keypair_ValidateUpdateDataOutput: + description: "" + schema: + properties: + keypair: + $ref: '#/definitions/KeypairDetails' + type: object + kube_cluster_CustomizeDeleteOutput: + description: "" + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDetails' + type: object + kube_cluster_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDetails' + type: object + kube_cluster_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + kube_cluster: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + kube_cluster_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_cluster_GetDetailsKubeconfigOutput: + description: "" + schema: + properties: + kube_cluster: + $ref: '#/definitions/SKubeconfig' + type: object + kube_cluster_GetDetailsMetadataOutput: + description: "" + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_cluster_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_cluster_GetDetailsStatusOutput: + description: "" + schema: + properties: + kube_cluster: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + kube_cluster_GetPropertyDistinctFieldOutput: + description: "" + kube_cluster_GetPropertyDomainTagValuePairsOutput: + description: "" + kube_cluster_GetPropertyDomainTagValueTreeOutput: + description: "" + kube_cluster_GetPropertySplitableExportOutput: + description: "" + kube_cluster_GetPropertySplitableOutput: + description: "" + kube_cluster_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + kube_cluster: + $ref: '#/definitions/StatusStatistic' + type: object + kube_cluster_GetPropertyTagValuePairsOutput: + description: "" + kube_cluster_GetPropertyTagValueTreeOutput: + description: "" + kube_cluster_ListItemFilterOutput: + description: "" + schema: + properties: + kube_clusters: + items: + $ref: '#/definitions/KubeClusterDetails' + 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 + kube_cluster_PerformChangeOwnerOutput: + description: "" + kube_cluster_PerformClassMetadataOutput: + description: "" + kube_cluster_PerformDisableOutput: + description: "" + kube_cluster_PerformEnableOutput: + description: "" + kube_cluster_PerformPrivateOutput: + description: "" + kube_cluster_PerformPublicOutput: + description: "" + kube_cluster_PerformPurgeSplitableOutput: + description: "" + kube_cluster_PerformSetClassMetadataOutput: + description: "" + kube_cluster_PerformSetOrgMetadataOutput: + description: "" + kube_cluster_PerformSetUserMetadataOutput: + description: "" + kube_cluster_PerformStatusOutput: + description: "" + kube_cluster_PerformSyncstatusOutput: + description: "" + kube_cluster_ValidateCreateDataOutput: + description: "" + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDetails' + type: object + kube_cluster_ValidateUpdateDataOutput: + description: "" + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDetails' + type: object + kube_node_CustomizeDeleteOutput: + description: "" + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeDetails' + type: object + kube_node_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeDetails' + type: object + kube_node_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_GetDetailsMetadataOutput: + description: "" + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_GetDetailsStatusOutput: + description: "" + schema: + properties: + kube_node: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + kube_node_GetPropertyDistinctFieldOutput: + description: "" + kube_node_GetPropertySplitableExportOutput: + description: "" + kube_node_GetPropertySplitableOutput: + description: "" + kube_node_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + kube_node: + $ref: '#/definitions/StatusStatistic' + type: object + kube_node_GetPropertyTagValuePairsOutput: + description: "" + kube_node_GetPropertyTagValueTreeOutput: + description: "" + kube_node_ListItemFilterOutput: + description: "" + schema: + properties: + kube_nodes: + items: + $ref: '#/definitions/KubeNodeDetails' + 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 + kube_node_PerformClassMetadataOutput: + description: "" + kube_node_PerformPurgeSplitableOutput: + description: "" + kube_node_PerformSetClassMetadataOutput: + description: "" + kube_node_PerformSetOrgMetadataOutput: + description: "" + kube_node_PerformSetUserMetadataOutput: + description: "" + kube_node_PerformStatusOutput: + description: "" + kube_node_ValidateCreateDataOutput: + description: "" + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeDetails' + type: object + kube_node_ValidateUpdateDataOutput: + description: "" + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeDetails' + type: object + kube_node_pool_CustomizeDeleteOutput: + description: "" + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolDetails' + type: object + kube_node_pool_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolDetails' + type: object + kube_node_pool_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_pool_GetDetailsMetadataOutput: + description: "" + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_pool_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_pool_GetDetailsStatusOutput: + description: "" + schema: + properties: + kube_node_pool: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + kube_node_pool_GetPropertyDistinctFieldOutput: + description: "" + kube_node_pool_GetPropertySplitableExportOutput: + description: "" + kube_node_pool_GetPropertySplitableOutput: + description: "" + kube_node_pool_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + kube_node_pool: + $ref: '#/definitions/StatusStatistic' + type: object + kube_node_pool_GetPropertyTagValuePairsOutput: + description: "" + kube_node_pool_GetPropertyTagValueTreeOutput: + description: "" + kube_node_pool_ListItemFilterOutput: + description: "" + schema: + properties: + kube_node_pools: + items: + $ref: '#/definitions/KubeNodePoolDetails' + 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 + kube_node_pool_PerformClassMetadataOutput: + description: "" + kube_node_pool_PerformPurgeSplitableOutput: + description: "" + kube_node_pool_PerformSetClassMetadataOutput: + description: "" + kube_node_pool_PerformSetOrgMetadataOutput: + description: "" + kube_node_pool_PerformSetUserMetadataOutput: + description: "" + kube_node_pool_PerformStatusOutput: + description: "" + kube_node_pool_PerformSyncstatusOutput: + description: "" + kube_node_pool_ValidateCreateDataOutput: + description: "" + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolDetails' + type: object + kube_node_pool_ValidateUpdateDataOutput: + description: "" + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolDetails' + type: object + loadbalancer_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDetails' + type: object + loadbalancer_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDetails' + type: object + loadbalancer_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + loadbalancer: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + loadbalancer_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_GetDetailsMetadataOutput: + description: "" + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_GetDetailsStatusOutput: + description: "" + schema: + properties: + loadbalancer: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + loadbalancer: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + loadbalancer: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_GetPropertyProjectTagValuePairsOutput: + description: "" + loadbalancer_GetPropertyProjectTagValueTreeOutput: + description: "" + loadbalancer_GetPropertySplitableExportOutput: + description: "" + loadbalancer_GetPropertySplitableOutput: + description: "" + loadbalancer_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + loadbalancer: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_GetPropertyTagValuePairsOutput: + description: "" + loadbalancer_GetPropertyTagValueTreeOutput: + description: "" + loadbalancer_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancers: + items: + $ref: '#/definitions/LoadbalancerDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_PerformAssociateEipOutput: + description: "" + loadbalancer_PerformCancelDeleteOutput: + description: "" + loadbalancer_PerformChangeOwnerOutput: + description: "" + loadbalancer_PerformClassMetadataOutput: + description: "" + loadbalancer_PerformCreateEipOutput: + description: "" + loadbalancer_PerformDissociateEipOutput: + description: "" + loadbalancer_PerformFreezeOutput: + description: "" + loadbalancer_PerformPurgeOutput: + description: "" + loadbalancer_PerformPurgeSplitableOutput: + description: "" + loadbalancer_PerformRemoteUpdateOutput: + description: "" + loadbalancer_PerformSetClassMetadataOutput: + description: "" + loadbalancer_PerformSetOrgMetadataOutput: + description: "" + loadbalancer_PerformSetUserMetadataOutput: + description: "" + loadbalancer_PerformStatusOutput: + description: "" + loadbalancer_PerformSyncstatusOutput: + description: "" + loadbalancer_PerformUnfreezeOutput: + description: "" + loadbalancer_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDetails' + type: object + loadbalancer_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDetails' + type: object + loadbalancer_acl_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclDetails' + type: object + loadbalancer_acl_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclDetails' + type: object + loadbalancer_acl_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + loadbalancer_acl_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_acl_GetDetailsMetadataOutput: + description: "" + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_acl_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_acl_GetDetailsStatusOutput: + description: "" + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_acl_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_acl_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_acl: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_acl_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_acl: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_acl_GetPropertyProjectTagValuePairsOutput: + description: "" + loadbalancer_acl_GetPropertyProjectTagValueTreeOutput: + description: "" + loadbalancer_acl_GetPropertySplitableExportOutput: + description: "" + loadbalancer_acl_GetPropertySplitableOutput: + description: "" + loadbalancer_acl_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_acl_GetPropertyTagValuePairsOutput: + description: "" + loadbalancer_acl_GetPropertyTagValueTreeOutput: + description: "" + loadbalancer_acl_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_acls: + items: + $ref: '#/definitions/LoadbalancerAclDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_acl_PerformCancelDeleteOutput: + description: "" + loadbalancer_acl_PerformChangeOwnerOutput: + description: "" + loadbalancer_acl_PerformClassMetadataOutput: + description: "" + loadbalancer_acl_PerformFreezeOutput: + description: "" + loadbalancer_acl_PerformPatchOutput: + description: "" + loadbalancer_acl_PerformPrivateOutput: + description: "" + loadbalancer_acl_PerformPublicOutput: + description: "" + loadbalancer_acl_PerformPurgeOutput: + description: "" + loadbalancer_acl_PerformPurgeSplitableOutput: + description: "" + loadbalancer_acl_PerformSetClassMetadataOutput: + description: "" + loadbalancer_acl_PerformSetOrgMetadataOutput: + description: "" + loadbalancer_acl_PerformSetUserMetadataOutput: + description: "" + loadbalancer_acl_PerformStatusOutput: + description: "" + loadbalancer_acl_PerformSyncstatusOutput: + description: "" + loadbalancer_acl_PerformUnfreezeOutput: + description: "" + loadbalancer_acl_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclDetails' + type: object + loadbalancer_acl_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclDetails' + type: object + loadbalancer_agent_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: object + loadbalancer_agent_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: object + loadbalancer_agent_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_agent_GetDetailsMetadataOutput: + description: "" + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_agent_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_agent_GetPropertyDefaultParamsOutput: + description: "" + loadbalancer_agent_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_agent_GetPropertySplitableExportOutput: + description: "" + loadbalancer_agent_GetPropertySplitableOutput: + description: "" + loadbalancer_agent_GetPropertyTagValuePairsOutput: + description: "" + loadbalancer_agent_GetPropertyTagValueTreeOutput: + description: "" + loadbalancer_agent_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_agents: + items: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_agent_PerformClassMetadataOutput: + description: "" + loadbalancer_agent_PerformDeployOutput: + description: "" + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDeployInput' + type: object + loadbalancer_agent_PerformHbOutput: + description: "" + loadbalancer_agent_PerformJoinClusterOutput: + description: "" + loadbalancer_agent_PerformLeaveClusterOutput: + description: "" + loadbalancer_agent_PerformParamsPatchOutput: + description: "" + loadbalancer_agent_PerformPurgeSplitableOutput: + description: "" + loadbalancer_agent_PerformSetClassMetadataOutput: + description: "" + loadbalancer_agent_PerformSetOrgMetadataOutput: + description: "" + loadbalancer_agent_PerformSetUserMetadataOutput: + description: "" + loadbalancer_agent_PerformUndeployOutput: + description: "" + loadbalancer_agent_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: object + loadbalancer_agent_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: object + loadbalancer_backend_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: object + loadbalancer_backend_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: object + loadbalancer_backend_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_GetDetailsMetadataOutput: + description: "" + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_GetDetailsStatusOutput: + description: "" + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_backend_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_backend_GetPropertySplitableExportOutput: + description: "" + loadbalancer_backend_GetPropertySplitableOutput: + description: "" + loadbalancer_backend_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_backend_GetPropertyTagValuePairsOutput: + description: "" + loadbalancer_backend_GetPropertyTagValueTreeOutput: + description: "" + loadbalancer_backend_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_backends: + items: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_backend_PerformClassMetadataOutput: + description: "" + loadbalancer_backend_PerformPurgeOutput: + description: "" + loadbalancer_backend_PerformPurgeSplitableOutput: + description: "" + loadbalancer_backend_PerformSetClassMetadataOutput: + description: "" + loadbalancer_backend_PerformSetOrgMetadataOutput: + description: "" + loadbalancer_backend_PerformSetUserMetadataOutput: + description: "" + loadbalancer_backend_PerformStatusOutput: + description: "" + loadbalancer_backend_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: object + loadbalancer_backend_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: object + loadbalancer_backend_group_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: object + loadbalancer_backend_group_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: object + loadbalancer_backend_group_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_group_GetDetailsMetadataOutput: + description: "" + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_group_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_group_GetDetailsStatusOutput: + description: "" + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_backend_group_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_backend_group_GetPropertySplitableExportOutput: + description: "" + loadbalancer_backend_group_GetPropertySplitableOutput: + description: "" + loadbalancer_backend_group_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_backend_group_GetPropertyTagValuePairsOutput: + description: "" + loadbalancer_backend_group_GetPropertyTagValueTreeOutput: + description: "" + loadbalancer_backend_group_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_backend_groups: + items: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_backend_group_PerformClassMetadataOutput: + description: "" + loadbalancer_backend_group_PerformPurgeOutput: + description: "" + loadbalancer_backend_group_PerformPurgeSplitableOutput: + description: "" + loadbalancer_backend_group_PerformSetClassMetadataOutput: + description: "" + loadbalancer_backend_group_PerformSetOrgMetadataOutput: + description: "" + loadbalancer_backend_group_PerformSetUserMetadataOutput: + description: "" + loadbalancer_backend_group_PerformStatusOutput: + description: "" + loadbalancer_backend_group_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: object + loadbalancer_backend_group_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: object + loadbalancer_certificate_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: object + loadbalancer_certificate_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: object + loadbalancer_certificate_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + loadbalancer_certificate_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_certificate_GetDetailsMetadataOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_certificate_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_certificate_GetDetailsStatusOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_certificate_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_certificate_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_certificate_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_certificate_GetPropertyProjectTagValuePairsOutput: + description: "" + loadbalancer_certificate_GetPropertyProjectTagValueTreeOutput: + description: "" + loadbalancer_certificate_GetPropertySplitableExportOutput: + description: "" + loadbalancer_certificate_GetPropertySplitableOutput: + description: "" + loadbalancer_certificate_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_certificate_GetPropertyTagValuePairsOutput: + description: "" + loadbalancer_certificate_GetPropertyTagValueTreeOutput: + description: "" + loadbalancer_certificate_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_certificates: + items: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_certificate_PerformCancelDeleteOutput: + description: "" + loadbalancer_certificate_PerformChangeOwnerOutput: + description: "" + loadbalancer_certificate_PerformClassMetadataOutput: + description: "" + loadbalancer_certificate_PerformFreezeOutput: + description: "" + loadbalancer_certificate_PerformPrivateOutput: + description: "" + loadbalancer_certificate_PerformPublicOutput: + description: "" + loadbalancer_certificate_PerformPurgeSplitableOutput: + description: "" + loadbalancer_certificate_PerformSetClassMetadataOutput: + description: "" + loadbalancer_certificate_PerformSetOrgMetadataOutput: + description: "" + loadbalancer_certificate_PerformSetUserMetadataOutput: + description: "" + loadbalancer_certificate_PerformStatusOutput: + description: "" + loadbalancer_certificate_PerformSyncstatusOutput: + description: "" + loadbalancer_certificate_PerformUnfreezeOutput: + description: "" + loadbalancer_certificate_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: object + loadbalancer_certificate_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: object + loadbalancer_cluster_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: object + loadbalancer_cluster_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: object + loadbalancer_cluster_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_cluster_GetDetailsMetadataOutput: + description: "" + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_cluster_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_cluster_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_cluster_GetPropertySplitableExportOutput: + description: "" + loadbalancer_cluster_GetPropertySplitableOutput: + description: "" + loadbalancer_cluster_GetPropertyTagValuePairsOutput: + description: "" + loadbalancer_cluster_GetPropertyTagValueTreeOutput: + description: "" + loadbalancer_cluster_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_clusters: + items: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_cluster_PerformClassMetadataOutput: + description: "" + loadbalancer_cluster_PerformParamsPatchOutput: + description: "" + loadbalancer_cluster_PerformPurgeSplitableOutput: + description: "" + loadbalancer_cluster_PerformSetClassMetadataOutput: + description: "" + loadbalancer_cluster_PerformSetOrgMetadataOutput: + description: "" + loadbalancer_cluster_PerformSetUserMetadataOutput: + description: "" + loadbalancer_cluster_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: object + loadbalancer_cluster_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: object + loadbalancer_listener_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: object + loadbalancer_listener_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: object + loadbalancer_listener_GetDetailsBackendStatusOutput: + description: "" + loadbalancer_listener_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_GetDetailsMetadataOutput: + description: "" + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_GetDetailsStatusOutput: + description: "" + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_listener_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_listener_GetPropertySplitableExportOutput: + description: "" + loadbalancer_listener_GetPropertySplitableOutput: + description: "" + loadbalancer_listener_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_listener_GetPropertyTagValuePairsOutput: + description: "" + loadbalancer_listener_GetPropertyTagValueTreeOutput: + description: "" + loadbalancer_listener_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_listeners: + items: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_listener_PerformClassMetadataOutput: + description: "" + loadbalancer_listener_PerformPurgeOutput: + description: "" + loadbalancer_listener_PerformPurgeSplitableOutput: + description: "" + loadbalancer_listener_PerformSetClassMetadataOutput: + description: "" + loadbalancer_listener_PerformSetOrgMetadataOutput: + description: "" + loadbalancer_listener_PerformSetUserMetadataOutput: + description: "" + loadbalancer_listener_PerformStatusOutput: + description: "" + loadbalancer_listener_PerformSyncOutput: + description: "" + loadbalancer_listener_PerformSyncstatusOutput: + description: "" + loadbalancer_listener_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: object + loadbalancer_listener_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: object + loadbalancer_listener_rule_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: object + loadbalancer_listener_rule_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: object + loadbalancer_listener_rule_GetDetailsBackendStatusOutput: + description: "" + loadbalancer_listener_rule_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_rule_GetDetailsMetadataOutput: + description: "" + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_rule_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_rule_GetDetailsStatusOutput: + description: "" + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_listener_rule_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_listener_rule_GetPropertySplitableExportOutput: + description: "" + loadbalancer_listener_rule_GetPropertySplitableOutput: + description: "" + loadbalancer_listener_rule_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_listener_rule_GetPropertyTagValuePairsOutput: + description: "" + loadbalancer_listener_rule_GetPropertyTagValueTreeOutput: + description: "" + loadbalancer_listener_rule_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_listener_rules: + items: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_listener_rule_PerformClassMetadataOutput: + description: "" + loadbalancer_listener_rule_PerformPurgeOutput: + description: "" + loadbalancer_listener_rule_PerformPurgeSplitableOutput: + description: "" + loadbalancer_listener_rule_PerformSetClassMetadataOutput: + description: "" + loadbalancer_listener_rule_PerformSetOrgMetadataOutput: + description: "" + loadbalancer_listener_rule_PerformSetUserMetadataOutput: + description: "" + loadbalancer_listener_rule_PerformStatusOutput: + description: "" + loadbalancer_listener_rule_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: object + loadbalancer_listener_rule_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: object + loadbalancer_security_group_CustomizeDeleteOutput: + description: "" + schema: + properties: + loadbalancer_security_group: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + loadbalancer_security_group_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + loadbalancer_security_group: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + loadbalancer_security_group_GetPropertyDistinctFieldOutput: + description: "" + loadbalancer_security_group_GetPropertySplitableExportOutput: + description: "" + loadbalancer_security_group_GetPropertySplitableOutput: + description: "" + loadbalancer_security_group_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_security_groups: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_security_group_PerformPurgeSplitableOutput: + description: "" + loadbalancer_security_group_ValidateCreateDataOutput: + description: "" + schema: + properties: + loadbalancer_security_group: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + loadbalancer_security_group_ValidateUpdateDataOutput: + description: "" + schema: + properties: + loadbalancer_security_group: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + misc_resource_CustomizeDeleteOutput: + description: "" + schema: + properties: + misc_resource: + $ref: '#/definitions/MiscResourceDetails' + type: object + misc_resource_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + misc_resource: + $ref: '#/definitions/MiscResourceDetails' + type: object + misc_resource_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + misc_resource: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + misc_resource_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + misc_resource_GetDetailsMetadataOutput: + description: "" + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + misc_resource_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + misc_resource_GetDetailsStatusOutput: + description: "" + schema: + properties: + misc_resource: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + misc_resource_GetPropertyDistinctFieldOutput: + description: "" + misc_resource_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + misc_resource: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + misc_resource_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + misc_resource: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + misc_resource_GetPropertyProjectTagValuePairsOutput: + description: "" + misc_resource_GetPropertyProjectTagValueTreeOutput: + description: "" + misc_resource_GetPropertySplitableExportOutput: + description: "" + misc_resource_GetPropertySplitableOutput: + description: "" + misc_resource_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + misc_resource: + $ref: '#/definitions/StatusStatistic' + type: object + misc_resource_GetPropertyTagValuePairsOutput: + description: "" + misc_resource_GetPropertyTagValueTreeOutput: + description: "" + misc_resource_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + misc_resources: + items: + $ref: '#/definitions/MiscResourceDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + misc_resource_PerformCancelDeleteOutput: + description: "" + misc_resource_PerformChangeOwnerOutput: + description: "" + misc_resource_PerformClassMetadataOutput: + description: "" + misc_resource_PerformFreezeOutput: + description: "" + misc_resource_PerformPurgeSplitableOutput: + description: "" + misc_resource_PerformSetClassMetadataOutput: + description: "" + misc_resource_PerformSetOrgMetadataOutput: + description: "" + misc_resource_PerformSetUserMetadataOutput: + description: "" + misc_resource_PerformStatusOutput: + description: "" + misc_resource_PerformUnfreezeOutput: + description: "" + misc_resource_ValidateCreateDataOutput: + description: "" + schema: + properties: + misc_resource: + $ref: '#/definitions/MiscResourceDetails' + type: object + misc_resource_ValidateUpdateDataOutput: + description: "" + schema: + properties: + misc_resource: + $ref: '#/definitions/MiscResourceDetails' + type: object + modelarts_pool_CustomizeDeleteOutput: + description: "" + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolDetails' + type: object + modelarts_pool_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolDetails' + type: object + modelarts_pool_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + modelarts_pool_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_GetDetailsMetadataOutput: + description: "" + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_GetDetailsStatusOutput: + description: "" + schema: + properties: + modelarts_pool: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + modelarts_pool_GetPropertyDistinctFieldOutput: + description: "" + modelarts_pool_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + modelarts_pool: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + modelarts_pool_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + modelarts_pool: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + modelarts_pool_GetPropertyProjectTagValuePairsOutput: + description: "" + modelarts_pool_GetPropertyProjectTagValueTreeOutput: + description: "" + modelarts_pool_GetPropertySplitableExportOutput: + description: "" + modelarts_pool_GetPropertySplitableOutput: + description: "" + modelarts_pool_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + modelarts_pool: + $ref: '#/definitions/StatusStatistic' + type: object + modelarts_pool_GetPropertyTagValuePairsOutput: + description: "" + modelarts_pool_GetPropertyTagValueTreeOutput: + description: "" + modelarts_pool_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + modelarts_pools: + items: + $ref: '#/definitions/ModelartsPoolDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + modelarts_pool_PerformCancelDeleteOutput: + description: "" + modelarts_pool_PerformChangeConfigOutput: + description: "" + modelarts_pool_PerformChangeOwnerOutput: + description: "" + modelarts_pool_PerformClassMetadataOutput: + description: "" + modelarts_pool_PerformFreezeOutput: + description: "" + modelarts_pool_PerformPurgeSplitableOutput: + description: "" + modelarts_pool_PerformSetClassMetadataOutput: + description: "" + modelarts_pool_PerformSetOrgMetadataOutput: + description: "" + modelarts_pool_PerformSetUserMetadataOutput: + description: "" + modelarts_pool_PerformStatusOutput: + description: "" + modelarts_pool_PerformSyncstatusOutput: + description: "" + modelarts_pool_PerformUnfreezeOutput: + description: "" + modelarts_pool_ValidateCreateDataOutput: + description: "" + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolDetails' + type: object + modelarts_pool_ValidateUpdateDataOutput: + description: "" + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolDetails' + type: object + modelarts_pool_sku_CustomizeDeleteOutput: + description: "" + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: object + modelarts_pool_sku_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: object + modelarts_pool_sku_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_sku_GetDetailsMetadataOutput: + description: "" + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_sku_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_sku_GetDetailsStatusOutput: + description: "" + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + modelarts_pool_sku_GetPropertyDistinctFieldOutput: + description: "" + modelarts_pool_sku_GetPropertySplitableExportOutput: + description: "" + modelarts_pool_sku_GetPropertySplitableOutput: + description: "" + modelarts_pool_sku_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/StatusStatistic' + type: object + modelarts_pool_sku_GetPropertyTagValuePairsOutput: + description: "" + modelarts_pool_sku_GetPropertyTagValueTreeOutput: + description: "" + modelarts_pool_sku_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + modelarts_pool_skus: + items: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + modelarts_pool_sku_PerformClassMetadataOutput: + description: "" + modelarts_pool_sku_PerformDisableOutput: + description: "" + modelarts_pool_sku_PerformEnableOutput: + description: "" + modelarts_pool_sku_PerformPurgeSplitableOutput: + description: "" + modelarts_pool_sku_PerformSetClassMetadataOutput: + description: "" + modelarts_pool_sku_PerformSetOrgMetadataOutput: + description: "" + modelarts_pool_sku_PerformSetUserMetadataOutput: + description: "" + modelarts_pool_sku_PerformStatusOutput: + description: "" + modelarts_pool_sku_ValidateCreateDataOutput: + description: "" + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: object + modelarts_pool_sku_ValidateUpdateDataOutput: + description: "" + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: object + models_GetDomainQuotaOutput: + description: "" + schema: + properties: + domain_quotas: + items: + $ref: '#/definitions/SDomainQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetInfrasQuotaOutput: + description: "" + schema: + properties: + infras_quotas: + items: + $ref: '#/definitions/SInfrasQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetProjectQuotaOutput: + description: "" + schema: + properties: + project_quotas: + items: + $ref: '#/definitions/SProjectQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetQuotaOutput: + description: "" + schema: + properties: + quotas: + items: + $ref: '#/definitions/SQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetRegionQuotaOutput: + description: "" + schema: + properties: + region_quotas: + items: + $ref: '#/definitions/SRegionQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetZoneQuotaOutput: + description: "" + schema: + properties: + zone_quotas: + items: + $ref: '#/definitions/SZoneQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListDomainQuotasOutput: + description: "" + schema: + properties: + domain_quotas: + items: + $ref: '#/definitions/SDomainQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListInfrasQuotasOutput: + description: "" + schema: + properties: + infras_quotas: + items: + $ref: '#/definitions/SInfrasQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListProjectQuotasOutput: + description: "" + schema: + properties: + project_quotas: + items: + $ref: '#/definitions/SProjectQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListQuotasOutput: + description: "" + schema: + properties: + quotas: + items: + $ref: '#/definitions/SQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListRegionQuotasOutput: + description: "" + schema: + properties: + region_quotas: + items: + $ref: '#/definitions/SRegionQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListZoneQuotasOutput: + description: "" + schema: + properties: + zone_quotas: + items: + $ref: '#/definitions/SZoneQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetDomainQuotasOutput: + description: "" + schema: + properties: + domain_quotas: + items: + $ref: '#/definitions/SDomainQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetInfrasQuotasOutput: + description: "" + schema: + properties: + infras_quotas: + items: + $ref: '#/definitions/SInfrasQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetProjectQuotasOutput: + description: "" + schema: + properties: + project_quotas: + items: + $ref: '#/definitions/SProjectQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetQuotasOutput: + description: "" + schema: + properties: + quotas: + items: + $ref: '#/definitions/SQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetRegionQuotasOutput: + description: "" + schema: + properties: + region_quotas: + items: + $ref: '#/definitions/SRegionQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetZoneQuotasOutput: + description: "" + schema: + properties: + zone_quotas: + items: + $ref: '#/definitions/SZoneQuotaDetail' + type: array + x-go-name: Output + type: object + mongo_db_CustomizeDeleteOutput: + description: "" + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBDetails' + type: object + mongo_db_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBDetails' + type: object + mongo_db_GetDetailsBackupsOutput: + description: "" + schema: + properties: + mongo_db: + $ref: '#/definitions/SMongoDBBackups' + type: object + mongo_db_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + mongo_db: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + mongo_db_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mongo_db_GetDetailsMetadataOutput: + description: "" + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mongo_db_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mongo_db_GetDetailsStatusOutput: + description: "" + schema: + properties: + mongo_db: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + mongo_db_GetPropertyDistinctFieldOutput: + description: "" + mongo_db_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + mongo_db: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + mongo_db_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + mongo_db: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + mongo_db_GetPropertyProjectTagValuePairsOutput: + description: "" + mongo_db_GetPropertyProjectTagValueTreeOutput: + description: "" + mongo_db_GetPropertySplitableExportOutput: + description: "" + mongo_db_GetPropertySplitableOutput: + description: "" + mongo_db_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + mongo_db: + $ref: '#/definitions/StatusStatistic' + type: object + mongo_db_GetPropertyTagValuePairsOutput: + description: "" + mongo_db_GetPropertyTagValueTreeOutput: + description: "" + mongo_db_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + mongo_dbs: + items: + $ref: '#/definitions/MongoDBDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + mongo_db_PerformCancelDeleteOutput: + description: "" + mongo_db_PerformCancelExpireOutput: + description: "" + mongo_db_PerformChangeOwnerOutput: + description: "" + mongo_db_PerformClassMetadataOutput: + description: "" + mongo_db_PerformFreezeOutput: + description: "" + mongo_db_PerformPostpaidExpireOutput: + description: "" + mongo_db_PerformPurgeSplitableOutput: + description: "" + mongo_db_PerformRemoteUpdateOutput: + description: "" + mongo_db_PerformSetClassMetadataOutput: + description: "" + mongo_db_PerformSetOrgMetadataOutput: + description: "" + mongo_db_PerformSetUserMetadataOutput: + description: "" + mongo_db_PerformStatusOutput: + description: "" + mongo_db_PerformSyncstatusOutput: + description: "" + mongo_db_PerformUnfreezeOutput: + description: "" + mongo_db_ValidateCreateDataOutput: + description: "" + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBDetails' + type: object + mongo_db_ValidateUpdateDataOutput: + description: "" + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBDetails' + type: object + mount_target_CustomizeDeleteOutput: + description: "" + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetDetails' + type: object + mount_target_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetDetails' + type: object + mount_target_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mount_target_GetDetailsMetadataOutput: + description: "" + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mount_target_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mount_target_GetDetailsStatusOutput: + description: "" + schema: + properties: + mount_target: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + mount_target_GetPropertyDistinctFieldOutput: + description: "" + mount_target_GetPropertySplitableExportOutput: + description: "" + mount_target_GetPropertySplitableOutput: + description: "" + mount_target_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + mount_target: + $ref: '#/definitions/StatusStatistic' + type: object + mount_target_GetPropertyTagValuePairsOutput: + description: "" + mount_target_GetPropertyTagValueTreeOutput: + description: "" + mount_target_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + mount_targets: + items: + $ref: '#/definitions/MountTargetDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + mount_target_PerformClassMetadataOutput: + description: "" + mount_target_PerformPurgeSplitableOutput: + description: "" + mount_target_PerformSetClassMetadataOutput: + description: "" + mount_target_PerformSetOrgMetadataOutput: + description: "" + mount_target_PerformSetUserMetadataOutput: + description: "" + mount_target_PerformStatusOutput: + description: "" + mount_target_PerformSyncstatusOutput: + description: "" + mount_target_ValidateCreateDataOutput: + description: "" + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetDetails' + type: object + mount_target_ValidateUpdateDataOutput: + description: "" + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetDetails' + type: object + nas_sku_CustomizeDeleteOutput: + description: "" + schema: + properties: + nas_sku: + $ref: '#/definitions/NasSkuDetails' + type: object + nas_sku_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + nas_sku: + $ref: '#/definitions/NasSkuDetails' + type: object + nas_sku_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nas_sku_GetDetailsMetadataOutput: + description: "" + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nas_sku_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nas_sku_GetDetailsStatusOutput: + description: "" + schema: + properties: + nas_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nas_sku_GetPropertyDistinctFieldOutput: + description: "" + nas_sku_GetPropertySplitableExportOutput: + description: "" + nas_sku_GetPropertySplitableOutput: + description: "" + nas_sku_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + nas_sku: + $ref: '#/definitions/StatusStatistic' + type: object + nas_sku_GetPropertySyncTasksOutput: + description: "" + nas_sku_GetPropertyTagValuePairsOutput: + description: "" + nas_sku_GetPropertyTagValueTreeOutput: + description: "" + nas_sku_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nas_skus: + items: + $ref: '#/definitions/NasSkuDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nas_sku_PerformClassMetadataOutput: + description: "" + nas_sku_PerformDisableOutput: + description: "" + nas_sku_PerformEnableOutput: + description: "" + nas_sku_PerformPurgeSplitableOutput: + description: "" + nas_sku_PerformSetClassMetadataOutput: + description: "" + nas_sku_PerformSetOrgMetadataOutput: + description: "" + nas_sku_PerformSetUserMetadataOutput: + description: "" + nas_sku_PerformStatusOutput: + description: "" + nas_sku_PerformSyncSkusOutput: + description: "" + nas_sku_ValidateCreateDataOutput: + description: "" + schema: + properties: + nas_sku: + $ref: '#/definitions/NasSkuDetails' + type: object + nas_sku_ValidateUpdateDataOutput: + description: "" + schema: + properties: + nas_sku: + $ref: '#/definitions/NasSkuDetails' + type: object + nat_dentry_CustomizeDeleteOutput: + description: "" + schema: + properties: + nat_dentry: + $ref: '#/definitions/NatDEntryDetails' + type: object + nat_dentry_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + nat_dentry: + $ref: '#/definitions/NatDEntryDetails' + type: object + nat_dentry_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + nat_dentry: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + nat_dentry_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_dentry_GetDetailsMetadataOutput: + description: "" + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_dentry_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_dentry_GetDetailsStatusOutput: + description: "" + schema: + properties: + nat_dentry: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_dentry_GetPropertyDistinctFieldOutput: + description: "" + nat_dentry_GetPropertyDomainTagValuePairsOutput: + description: "" + nat_dentry_GetPropertyDomainTagValueTreeOutput: + description: "" + nat_dentry_GetPropertySplitableExportOutput: + description: "" + nat_dentry_GetPropertySplitableOutput: + description: "" + nat_dentry_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + nat_dentry: + $ref: '#/definitions/StatusStatistic' + type: object + nat_dentry_GetPropertyTagValuePairsOutput: + description: "" + nat_dentry_GetPropertyTagValueTreeOutput: + description: "" + nat_dentry_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_dentries: + items: + $ref: '#/definitions/NatDEntryDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_dentry_PerformChangeOwnerOutput: + description: "" + nat_dentry_PerformClassMetadataOutput: + description: "" + nat_dentry_PerformPrivateOutput: + description: "" + nat_dentry_PerformPublicOutput: + description: "" + nat_dentry_PerformPurgeSplitableOutput: + description: "" + nat_dentry_PerformSetClassMetadataOutput: + description: "" + nat_dentry_PerformSetOrgMetadataOutput: + description: "" + nat_dentry_PerformSetUserMetadataOutput: + description: "" + nat_dentry_PerformStatusOutput: + description: "" + nat_dentry_ValidateCreateDataOutput: + description: "" + schema: + properties: + nat_dentry: + $ref: '#/definitions/NatDEntryDetails' + type: object + nat_dentry_ValidateUpdateDataOutput: + description: "" + schema: + properties: + nat_dentry: + $ref: '#/definitions/NatDEntryDetails' + type: object + nat_entry_CustomizeDeleteOutput: + description: "" + schema: + properties: + nat_entry: + $ref: '#/definitions/NatEntryDetails' + type: object + nat_entry_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + nat_entry: + $ref: '#/definitions/NatEntryDetails' + type: object + nat_entry_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + nat_entry: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + nat_entry_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_entry_GetDetailsMetadataOutput: + description: "" + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_entry_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_entry_GetDetailsStatusOutput: + description: "" + schema: + properties: + nat_entry: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_entry_GetPropertyDistinctFieldOutput: + description: "" + nat_entry_GetPropertyDomainTagValuePairsOutput: + description: "" + nat_entry_GetPropertyDomainTagValueTreeOutput: + description: "" + nat_entry_GetPropertySplitableExportOutput: + description: "" + nat_entry_GetPropertySplitableOutput: + description: "" + nat_entry_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + nat_entry: + $ref: '#/definitions/StatusStatistic' + type: object + nat_entry_GetPropertyTagValuePairsOutput: + description: "" + nat_entry_GetPropertyTagValueTreeOutput: + description: "" + nat_entry_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_entries: + items: + $ref: '#/definitions/NatEntryDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_entry_PerformChangeOwnerOutput: + description: "" + nat_entry_PerformClassMetadataOutput: + description: "" + nat_entry_PerformPrivateOutput: + description: "" + nat_entry_PerformPublicOutput: + description: "" + nat_entry_PerformPurgeSplitableOutput: + description: "" + nat_entry_PerformSetClassMetadataOutput: + description: "" + nat_entry_PerformSetOrgMetadataOutput: + description: "" + nat_entry_PerformSetUserMetadataOutput: + description: "" + nat_entry_PerformStatusOutput: + description: "" + nat_entry_ValidateCreateDataOutput: + description: "" + schema: + properties: + nat_entry: + $ref: '#/definitions/NatEntryDetails' + type: object + nat_entry_ValidateUpdateDataOutput: + description: "" + schema: + properties: + nat_entry: + $ref: '#/definitions/NatEntryDetails' + type: object + nat_gateway_CustomizeDeleteOutput: + description: "" + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDetails' + type: object + nat_gateway_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDetails' + type: object + nat_gateway_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + nat_gateway: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + nat_gateway_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_gateway_GetDetailsMetadataOutput: + description: "" + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_gateway_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_gateway_GetDetailsStatusOutput: + description: "" + schema: + properties: + nat_gateway: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_gateway_GetPropertyDistinctFieldOutput: + description: "" + nat_gateway_GetPropertyDomainTagValuePairsOutput: + description: "" + nat_gateway_GetPropertyDomainTagValueTreeOutput: + description: "" + nat_gateway_GetPropertySplitableExportOutput: + description: "" + nat_gateway_GetPropertySplitableOutput: + description: "" + nat_gateway_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + nat_gateway: + $ref: '#/definitions/StatusStatistic' + type: object + nat_gateway_GetPropertyTagValuePairsOutput: + description: "" + nat_gateway_GetPropertyTagValueTreeOutput: + description: "" + nat_gateway_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_gateways: + items: + $ref: '#/definitions/NatgatewayDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_gateway_PerformCancelExpireOutput: + description: "" + nat_gateway_PerformChangeOwnerOutput: + description: "" + nat_gateway_PerformClassMetadataOutput: + description: "" + nat_gateway_PerformDnatResourcesOutput: + description: "" + nat_gateway_PerformPostpaidExpireOutput: + description: "" + nat_gateway_PerformPrivateOutput: + description: "" + nat_gateway_PerformPublicOutput: + description: "" + nat_gateway_PerformPurgeSplitableOutput: + description: "" + nat_gateway_PerformRemoteUpdateOutput: + description: "" + nat_gateway_PerformRenewOutput: + description: "" + nat_gateway_PerformSetAutoRenewOutput: + description: "" + nat_gateway_PerformSetClassMetadataOutput: + description: "" + nat_gateway_PerformSetOrgMetadataOutput: + description: "" + nat_gateway_PerformSetUserMetadataOutput: + description: "" + nat_gateway_PerformSnatResourcesOutput: + description: "" + nat_gateway_PerformStatusOutput: + description: "" + nat_gateway_PerformSyncstatusOutput: + description: "" + nat_gateway_ValidateCreateDataOutput: + description: "" + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDetails' + type: object + nat_gateway_ValidateUpdateDataOutput: + description: "" + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDetails' + type: object + nat_sentry_CustomizeDeleteOutput: + description: "" + schema: + properties: + nat_sentry: + $ref: '#/definitions/NatSEntryDetails' + type: object + nat_sentry_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + nat_sentry: + $ref: '#/definitions/NatSEntryDetails' + type: object + nat_sentry_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + nat_sentry: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + nat_sentry_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sentry_GetDetailsMetadataOutput: + description: "" + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sentry_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sentry_GetDetailsStatusOutput: + description: "" + schema: + properties: + nat_sentry: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_sentry_GetPropertyDistinctFieldOutput: + description: "" + nat_sentry_GetPropertyDomainTagValuePairsOutput: + description: "" + nat_sentry_GetPropertyDomainTagValueTreeOutput: + description: "" + nat_sentry_GetPropertySplitableExportOutput: + description: "" + nat_sentry_GetPropertySplitableOutput: + description: "" + nat_sentry_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + nat_sentry: + $ref: '#/definitions/StatusStatistic' + type: object + nat_sentry_GetPropertyTagValuePairsOutput: + description: "" + nat_sentry_GetPropertyTagValueTreeOutput: + description: "" + nat_sentry_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_sentries: + items: + $ref: '#/definitions/NatSEntryDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_sentry_PerformChangeOwnerOutput: + description: "" + nat_sentry_PerformClassMetadataOutput: + description: "" + nat_sentry_PerformPrivateOutput: + description: "" + nat_sentry_PerformPublicOutput: + description: "" + nat_sentry_PerformPurgeSplitableOutput: + description: "" + nat_sentry_PerformSetClassMetadataOutput: + description: "" + nat_sentry_PerformSetOrgMetadataOutput: + description: "" + nat_sentry_PerformSetUserMetadataOutput: + description: "" + nat_sentry_PerformStatusOutput: + description: "" + nat_sentry_ValidateCreateDataOutput: + description: "" + schema: + properties: + nat_sentry: + $ref: '#/definitions/NatSEntryDetails' + type: object + nat_sentry_ValidateUpdateDataOutput: + description: "" + schema: + properties: + nat_sentry: + $ref: '#/definitions/NatSEntryDetails' + type: object + nat_sku_CustomizeDeleteOutput: + description: "" + schema: + properties: + nat_sku: + $ref: '#/definitions/NatSkuDetails' + type: object + nat_sku_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + nat_sku: + $ref: '#/definitions/NatSkuDetails' + type: object + nat_sku_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sku_GetDetailsMetadataOutput: + description: "" + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sku_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sku_GetDetailsStatusOutput: + description: "" + schema: + properties: + nat_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_sku_GetPropertyDistinctFieldOutput: + description: "" + nat_sku_GetPropertySplitableExportOutput: + description: "" + nat_sku_GetPropertySplitableOutput: + description: "" + nat_sku_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + nat_sku: + $ref: '#/definitions/StatusStatistic' + type: object + nat_sku_GetPropertySyncTasksOutput: + description: "" + nat_sku_GetPropertyTagValuePairsOutput: + description: "" + nat_sku_GetPropertyTagValueTreeOutput: + description: "" + nat_sku_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_skus: + items: + $ref: '#/definitions/NatSkuDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_sku_PerformClassMetadataOutput: + description: "" + nat_sku_PerformDisableOutput: + description: "" + nat_sku_PerformEnableOutput: + description: "" + nat_sku_PerformPurgeSplitableOutput: + description: "" + nat_sku_PerformSetClassMetadataOutput: + description: "" + nat_sku_PerformSetOrgMetadataOutput: + description: "" + nat_sku_PerformSetUserMetadataOutput: + description: "" + nat_sku_PerformStatusOutput: + description: "" + nat_sku_PerformSyncSkusOutput: + description: "" + nat_sku_ValidateCreateDataOutput: + description: "" + schema: + properties: + nat_sku: + $ref: '#/definitions/NatSkuDetails' + type: object + nat_sku_ValidateUpdateDataOutput: + description: "" + schema: + properties: + nat_sku: + $ref: '#/definitions/NatSkuDetails' + type: object + net_tap_flow_CustomizeDeleteOutput: + description: "" + schema: + properties: + net_tap_flow: + $ref: '#/definitions/NetTapFlowDetails' + type: object + net_tap_flow_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + net_tap_flow: + $ref: '#/definitions/NetTapFlowDetails' + type: object + net_tap_flow_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_flow_GetDetailsMetadataOutput: + description: "" + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_flow_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_flow_GetDetailsStatusOutput: + description: "" + schema: + properties: + net_tap_flow: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + net_tap_flow_GetPropertyDistinctFieldOutput: + description: "" + net_tap_flow_GetPropertySplitableExportOutput: + description: "" + net_tap_flow_GetPropertySplitableOutput: + description: "" + net_tap_flow_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + net_tap_flow: + $ref: '#/definitions/StatusStatistic' + type: object + net_tap_flow_GetPropertyTagValuePairsOutput: + description: "" + net_tap_flow_GetPropertyTagValueTreeOutput: + description: "" + net_tap_flow_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + net_tap_flows: + items: + $ref: '#/definitions/NetTapFlowDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + net_tap_flow_PerformClassMetadataOutput: + description: "" + net_tap_flow_PerformDisableOutput: + description: "" + net_tap_flow_PerformEnableOutput: + description: "" + net_tap_flow_PerformPurgeSplitableOutput: + description: "" + net_tap_flow_PerformSetClassMetadataOutput: + description: "" + net_tap_flow_PerformSetOrgMetadataOutput: + description: "" + net_tap_flow_PerformSetUserMetadataOutput: + description: "" + net_tap_flow_PerformStatusOutput: + description: "" + net_tap_flow_ValidateCreateDataOutput: + description: "" + schema: + properties: + net_tap_flow: + $ref: '#/definitions/NetTapFlowDetails' + type: object + net_tap_flow_ValidateUpdateDataOutput: + description: "" + schema: + properties: + net_tap_flow: + $ref: '#/definitions/NetTapFlowDetails' + type: object + net_tap_service_CustomizeDeleteOutput: + description: "" + schema: + properties: + net_tap_service: + $ref: '#/definitions/NetTapServiceDetails' + type: object + net_tap_service_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + net_tap_service: + $ref: '#/definitions/NetTapServiceDetails' + type: object + net_tap_service_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_service_GetDetailsMetadataOutput: + description: "" + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_service_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_service_GetDetailsStatusOutput: + description: "" + schema: + properties: + net_tap_service: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + net_tap_service_GetPropertyDistinctFieldOutput: + description: "" + net_tap_service_GetPropertySplitableExportOutput: + description: "" + net_tap_service_GetPropertySplitableOutput: + description: "" + net_tap_service_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + net_tap_service: + $ref: '#/definitions/StatusStatistic' + type: object + net_tap_service_GetPropertyTagValuePairsOutput: + description: "" + net_tap_service_GetPropertyTagValueTreeOutput: + description: "" + net_tap_service_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + net_tap_services: + items: + $ref: '#/definitions/NetTapServiceDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + net_tap_service_PerformClassMetadataOutput: + description: "" + net_tap_service_PerformDisableOutput: + description: "" + net_tap_service_PerformEnableOutput: + description: "" + net_tap_service_PerformPurgeSplitableOutput: + description: "" + net_tap_service_PerformSetClassMetadataOutput: + description: "" + net_tap_service_PerformSetOrgMetadataOutput: + description: "" + net_tap_service_PerformSetUserMetadataOutput: + description: "" + net_tap_service_PerformStatusOutput: + description: "" + net_tap_service_ValidateCreateDataOutput: + description: "" + schema: + properties: + net_tap_service: + $ref: '#/definitions/NetTapServiceDetails' + type: object + net_tap_service_ValidateUpdateDataOutput: + description: "" + schema: + properties: + net_tap_service: + $ref: '#/definitions/NetTapServiceDetails' + type: object + network_CustomizeDeleteOutput: + description: "" + schema: + properties: + network: + $ref: '#/definitions/NetworkDetails' + type: object + network_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + network: + $ref: '#/definitions/NetworkDetails' + type: object + network_GetDetailsAddressesOutput: + description: "" + schema: + properties: + network: + $ref: '#/definitions/GetNetworkAddressesOutput' + type: object + network_GetDetailsAvailableAddressesOutput: + description: "" + schema: + properties: + network: + $ref: '#/definitions/GetNetworkAvailableAddressesOutput' + type: object + network_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + network: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + network_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_GetDetailsMetadataOutput: + description: "" + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_GetDetailsReservedIpsOutput: + description: "" + network_GetDetailsStatusOutput: + description: "" + schema: + properties: + network: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + network_GetPropertyDistinctFieldOutput: + description: "" + network_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + network: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + network_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + network: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + network_GetPropertyProjectTagValuePairsOutput: + description: "" + network_GetPropertyProjectTagValueTreeOutput: + description: "" + network_GetPropertySplitableExportOutput: + description: "" + network_GetPropertySplitableOutput: + description: "" + network_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + network: + $ref: '#/definitions/StatusStatistic' + type: object + network_GetPropertyTagValuePairsOutput: + description: "" + network_GetPropertyTagValueTreeOutput: + description: "" + network_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + networks: + items: + $ref: '#/definitions/NetworkDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + network_PerformCancelDeleteOutput: + description: "" + network_PerformChangeOwnerOutput: + description: "" + network_PerformClassMetadataOutput: + description: "" + network_PerformFreezeOutput: + description: "" + network_PerformMergeOutput: + description: "" + network_PerformPrivateOutput: + description: "" + network_PerformPublicOutput: + description: "" + network_PerformPurgeOutput: + description: "" + network_PerformPurgeSplitableOutput: + description: "" + network_PerformReleaseReservedIpOutput: + description: "" + network_PerformReserveIpOutput: + description: "" + network_PerformSetBgpTypeOutput: + description: "" + network_PerformSetClassMetadataOutput: + description: "" + network_PerformSetOrgMetadataOutput: + description: "" + network_PerformSetSchedtagOutput: + description: "" + network_PerformSetUserMetadataOutput: + description: "" + network_PerformSplitOutput: + description: "" + network_PerformStatusOutput: + description: "" + network_PerformSwitchWireOutput: + description: "" + network_PerformSyncAdditionalWiresOutput: + description: "" + network_PerformSyncOutput: + description: "" + network_PerformSyncstatusOutput: + description: "" + network_PerformTryCreateNetworkOutput: + description: "" + network_PerformUnfreezeOutput: + description: "" + network_ValidateCreateDataOutput: + description: "" + schema: + properties: + network: + $ref: '#/definitions/NetworkDetails' + type: object + network_ValidateUpdateDataOutput: + description: "" + schema: + properties: + network: + $ref: '#/definitions/NetworkDetails' + type: object + network_additional_wire_CustomizeDeleteOutput: + description: "" + schema: + properties: + network_additional_wire: + $ref: '#/definitions/ModelBaseDetails' + type: object + network_additional_wire_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + network_additional_wire: + $ref: '#/definitions/ModelBaseDetails' + type: object + network_additional_wire_GetPropertyDistinctFieldOutput: + description: "" + network_additional_wire_GetPropertySplitableExportOutput: + description: "" + network_additional_wire_GetPropertySplitableOutput: + description: "" + network_additional_wire_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + network_additional_wires: + items: + $ref: '#/definitions/ModelBaseDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + network_additional_wire_PerformPurgeSplitableOutput: + description: "" + network_additional_wire_ValidateCreateDataOutput: + description: "" + schema: + properties: + network_additional_wire: + $ref: '#/definitions/ModelBaseDetails' + type: object + network_additional_wire_ValidateUpdateDataOutput: + description: "" + schema: + properties: + network_additional_wire: + $ref: '#/definitions/ModelBaseDetails' + type: object + network_address_CustomizeDeleteOutput: + description: "" + schema: + properties: + network_address: + $ref: '#/definitions/NetworkAddressDetails' + type: object + network_address_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + network_address: + $ref: '#/definitions/NetworkAddressDetails' + type: object + network_address_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_address_GetDetailsMetadataOutput: + description: "" + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_address_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_address_GetPropertyDistinctFieldOutput: + description: "" + network_address_GetPropertySplitableExportOutput: + description: "" + network_address_GetPropertySplitableOutput: + description: "" + network_address_GetPropertyTagValuePairsOutput: + description: "" + network_address_GetPropertyTagValueTreeOutput: + description: "" + network_address_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + network_addresses: + items: + $ref: '#/definitions/NetworkAddressDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + network_address_PerformClassMetadataOutput: + description: "" + network_address_PerformPurgeSplitableOutput: + description: "" + network_address_PerformSetClassMetadataOutput: + description: "" + network_address_PerformSetOrgMetadataOutput: + description: "" + network_address_PerformSetUserMetadataOutput: + description: "" + network_address_ValidateCreateDataOutput: + description: "" + schema: + properties: + network_address: + $ref: '#/definitions/NetworkAddressDetails' + type: object + network_address_ValidateUpdateDataOutput: + description: "" + schema: + properties: + network_address: + $ref: '#/definitions/NetworkAddressDetails' + type: object + network_interface_CustomizeDeleteOutput: + description: "" + schema: + properties: + network_interface: + $ref: '#/definitions/NetworkInterfaceDetails' + type: object + network_interface_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + network_interface: + $ref: '#/definitions/NetworkInterfaceDetails' + type: object + network_interface_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + network_interface: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + network_interface_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_interface_GetDetailsMetadataOutput: + description: "" + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_interface_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_interface_GetDetailsStatusOutput: + description: "" + schema: + properties: + network_interface: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + network_interface_GetPropertyDistinctFieldOutput: + description: "" + network_interface_GetPropertyDomainTagValuePairsOutput: + description: "" + network_interface_GetPropertyDomainTagValueTreeOutput: + description: "" + network_interface_GetPropertySplitableExportOutput: + description: "" + network_interface_GetPropertySplitableOutput: + description: "" + network_interface_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + network_interface: + $ref: '#/definitions/StatusStatistic' + type: object + network_interface_GetPropertyTagValuePairsOutput: + description: "" + network_interface_GetPropertyTagValueTreeOutput: + description: "" + network_interface_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + network_interfaces: + items: + $ref: '#/definitions/NetworkInterfaceDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + network_interface_PerformChangeOwnerOutput: + description: "" + network_interface_PerformClassMetadataOutput: + description: "" + network_interface_PerformPrivateOutput: + description: "" + network_interface_PerformPublicOutput: + description: "" + network_interface_PerformPurgeSplitableOutput: + description: "" + network_interface_PerformSetClassMetadataOutput: + description: "" + network_interface_PerformSetOrgMetadataOutput: + description: "" + network_interface_PerformSetUserMetadataOutput: + description: "" + network_interface_PerformStatusOutput: + description: "" + network_interface_ValidateCreateDataOutput: + description: "" + schema: + properties: + network_interface: + $ref: '#/definitions/NetworkInterfaceDetails' + type: object + network_interface_ValidateUpdateDataOutput: + description: "" + schema: + properties: + network_interface: + $ref: '#/definitions/NetworkInterfaceDetails' + type: object + network_ip_mac_CustomizeDeleteOutput: + description: "" + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacDetails' + type: object + network_ip_mac_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacDetails' + type: object + network_ip_mac_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_ip_mac_GetDetailsMetadataOutput: + description: "" + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_ip_mac_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_ip_mac_GetPropertyDistinctFieldOutput: + description: "" + network_ip_mac_GetPropertySplitableExportOutput: + description: "" + network_ip_mac_GetPropertySplitableOutput: + description: "" + network_ip_mac_GetPropertyTagValuePairsOutput: + description: "" + network_ip_mac_GetPropertyTagValueTreeOutput: + description: "" + network_ip_mac_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + network_ip_macs: + items: + $ref: '#/definitions/NetworkIpMacDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + network_ip_mac_PerformBatchCreateOutput: + description: "" + network_ip_mac_PerformClassMetadataOutput: + description: "" + network_ip_mac_PerformPurgeSplitableOutput: + description: "" + network_ip_mac_PerformSetClassMetadataOutput: + description: "" + network_ip_mac_PerformSetOrgMetadataOutput: + description: "" + network_ip_mac_PerformSetUserMetadataOutput: + description: "" + network_ip_mac_ValidateCreateDataOutput: + description: "" + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacDetails' + type: object + network_ip_mac_ValidateUpdateDataOutput: + description: "" + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacDetails' + type: object + networkinterfacenetwork_CustomizeDeleteOutput: + description: "" + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + networkinterfacenetwork_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + networkinterfacenetwork_GetPropertyDistinctFieldOutput: + description: "" + networkinterfacenetwork_GetPropertySplitableExportOutput: + description: "" + networkinterfacenetwork_GetPropertySplitableOutput: + description: "" + networkinterfacenetwork_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + networkinterfacenetworks: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + networkinterfacenetwork_PerformPurgeSplitableOutput: + description: "" + networkinterfacenetwork_ValidateCreateDataOutput: + description: "" + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + networkinterfacenetwork_ValidateUpdateDataOutput: + description: "" + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + policy_assignment_CustomizeDeleteOutput: + description: "" + schema: + properties: + policy_assignment: + $ref: '#/definitions/PolicyAssignmentDetails' + type: object + policy_assignment_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + policy_assignment: + $ref: '#/definitions/PolicyAssignmentDetails' + type: object + policy_assignment_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + policy_assignment: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + policy_assignment_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_assignment_GetDetailsMetadataOutput: + description: "" + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_assignment_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_assignment_GetPropertyDistinctFieldOutput: + description: "" + policy_assignment_GetPropertyDomainTagValuePairsOutput: + description: "" + policy_assignment_GetPropertyDomainTagValueTreeOutput: + description: "" + policy_assignment_GetPropertySplitableExportOutput: + description: "" + policy_assignment_GetPropertySplitableOutput: + description: "" + policy_assignment_GetPropertyTagValuePairsOutput: + description: "" + policy_assignment_GetPropertyTagValueTreeOutput: + description: "" + policy_assignment_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + policy_assignments: + items: + $ref: '#/definitions/PolicyAssignmentDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + policy_assignment_PerformChangeOwnerOutput: + description: "" + policy_assignment_PerformClassMetadataOutput: + description: "" + policy_assignment_PerformPurgeSplitableOutput: + description: "" + policy_assignment_PerformSetClassMetadataOutput: + description: "" + policy_assignment_PerformSetOrgMetadataOutput: + description: "" + policy_assignment_PerformSetUserMetadataOutput: + description: "" + policy_assignment_ValidateCreateDataOutput: + description: "" + schema: + properties: + policy_assignment: + $ref: '#/definitions/PolicyAssignmentDetails' + type: object + policy_assignment_ValidateUpdateDataOutput: + description: "" + schema: + properties: + policy_assignment: + $ref: '#/definitions/PolicyAssignmentDetails' + type: object + policy_definition_CustomizeDeleteOutput: + description: "" + schema: + properties: + policy_definition: + $ref: '#/definitions/PolicyDefinitionDetails' + type: object + policy_definition_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + policy_definition: + $ref: '#/definitions/PolicyDefinitionDetails' + type: object + policy_definition_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_definition_GetDetailsMetadataOutput: + description: "" + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_definition_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_definition_GetDetailsStatusOutput: + description: "" + schema: + properties: + policy_definition: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + policy_definition_GetPropertyDistinctFieldOutput: + description: "" + policy_definition_GetPropertySplitableExportOutput: + description: "" + policy_definition_GetPropertySplitableOutput: + description: "" + policy_definition_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + policy_definition: + $ref: '#/definitions/StatusStatistic' + type: object + policy_definition_GetPropertyTagValuePairsOutput: + description: "" + policy_definition_GetPropertyTagValueTreeOutput: + description: "" + policy_definition_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + policy_definitions: + items: + $ref: '#/definitions/PolicyDefinitionDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + policy_definition_PerformClassMetadataOutput: + description: "" + policy_definition_PerformPurgeSplitableOutput: + description: "" + policy_definition_PerformSetClassMetadataOutput: + description: "" + policy_definition_PerformSetOrgMetadataOutput: + description: "" + policy_definition_PerformSetUserMetadataOutput: + description: "" + policy_definition_PerformStatusOutput: + description: "" + policy_definition_ValidateCreateDataOutput: + description: "" + schema: + properties: + policy_definition: + $ref: '#/definitions/PolicyDefinitionDetails' + type: object + policy_definition_ValidateUpdateDataOutput: + description: "" + schema: + properties: + policy_definition: + $ref: '#/definitions/PolicyDefinitionDetails' + type: object + project_mapping_CustomizeDeleteOutput: + description: "" + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingDetails' + type: object + project_mapping_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingDetails' + type: object + project_mapping_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + project_mapping: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + project_mapping_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_mapping_GetDetailsMetadataOutput: + description: "" + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_mapping_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_mapping_GetDetailsStatusOutput: + description: "" + schema: + properties: + project_mapping: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + project_mapping_GetPropertyDistinctFieldOutput: + description: "" + project_mapping_GetPropertyDomainTagValuePairsOutput: + description: "" + project_mapping_GetPropertyDomainTagValueTreeOutput: + description: "" + project_mapping_GetPropertySplitableExportOutput: + description: "" + project_mapping_GetPropertySplitableOutput: + description: "" + project_mapping_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + project_mapping: + $ref: '#/definitions/StatusStatistic' + type: object + project_mapping_GetPropertyTagValuePairsOutput: + description: "" + project_mapping_GetPropertyTagValueTreeOutput: + description: "" + project_mapping_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + project_mappings: + items: + $ref: '#/definitions/ProjectMappingDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + project_mapping_PerformChangeOwnerOutput: + description: "" + project_mapping_PerformClassMetadataOutput: + description: "" + project_mapping_PerformDisableOutput: + description: "" + project_mapping_PerformEnableOutput: + description: "" + project_mapping_PerformPrivateOutput: + description: "" + project_mapping_PerformPublicOutput: + description: "" + project_mapping_PerformPurgeSplitableOutput: + description: "" + project_mapping_PerformSetClassMetadataOutput: + description: "" + project_mapping_PerformSetOrgMetadataOutput: + description: "" + project_mapping_PerformSetUserMetadataOutput: + description: "" + project_mapping_PerformStatusOutput: + description: "" + project_mapping_ValidateCreateDataOutput: + description: "" + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingDetails' + type: object + project_mapping_ValidateUpdateDataOutput: + description: "" + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingDetails' + type: object + reservedip_CustomizeDeleteOutput: + description: "" + schema: + properties: + reservedip: + $ref: '#/definitions/ReservedipDetails' + type: object + reservedip_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + reservedip: + $ref: '#/definitions/ReservedipDetails' + type: object + reservedip_GetPropertyDistinctFieldOutput: + description: "" + reservedip_GetPropertySplitableExportOutput: + description: "" + reservedip_GetPropertySplitableOutput: + description: "" + reservedip_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + reservedips: + items: + $ref: '#/definitions/ReservedipDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + reservedip_PerformPurgeSplitableOutput: + description: "" + reservedip_ValidateCreateDataOutput: + description: "" + schema: + properties: + reservedip: + $ref: '#/definitions/ReservedipDetails' + type: object + reservedip_ValidateUpdateDataOutput: + description: "" + schema: + properties: + reservedip: + $ref: '#/definitions/ReservedipDetails' + type: object + route_table_CustomizeDeleteOutput: + description: "" + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableDetails' + type: object + route_table_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableDetails' + type: object + route_table_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + route_table: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + route_table_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_GetDetailsMetadataOutput: + description: "" + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_GetDetailsStatusOutput: + description: "" + schema: + properties: + route_table: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + route_table_GetPropertyDistinctFieldOutput: + description: "" + route_table_GetPropertyDomainTagValuePairsOutput: + description: "" + route_table_GetPropertyDomainTagValueTreeOutput: + description: "" + route_table_GetPropertySplitableExportOutput: + description: "" + route_table_GetPropertySplitableOutput: + description: "" + route_table_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + route_table: + $ref: '#/definitions/StatusStatistic' + type: object + route_table_GetPropertyTagValuePairsOutput: + description: "" + route_table_GetPropertyTagValueTreeOutput: + description: "" + route_table_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + route_tables: + items: + $ref: '#/definitions/RouteTableDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + route_table_PerformAddRoutesOutput: + description: "" + route_table_PerformChangeOwnerOutput: + description: "" + route_table_PerformClassMetadataOutput: + description: "" + route_table_PerformDelRoutesOutput: + description: "" + route_table_PerformPrivateOutput: + description: "" + route_table_PerformPublicOutput: + description: "" + route_table_PerformPurgeOutput: + description: "" + route_table_PerformPurgeSplitableOutput: + description: "" + route_table_PerformSetClassMetadataOutput: + description: "" + route_table_PerformSetOrgMetadataOutput: + description: "" + route_table_PerformSetUserMetadataOutput: + description: "" + route_table_PerformStatusOutput: + description: "" + route_table_PerformSyncstatusOutput: + description: "" + route_table_ValidateCreateDataOutput: + description: "" + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableDetails' + type: object + route_table_ValidateUpdateDataOutput: + description: "" + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableDetails' + type: object + route_table_association_CustomizeDeleteOutput: + description: "" + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_association_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_association_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_association_GetDetailsMetadataOutput: + description: "" + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_association_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_association_GetDetailsStatusOutput: + description: "" + schema: + properties: + route_table_association: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + route_table_association_GetPropertyDistinctFieldOutput: + description: "" + route_table_association_GetPropertySplitableExportOutput: + description: "" + route_table_association_GetPropertySplitableOutput: + description: "" + route_table_association_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStatistic' + type: object + route_table_association_GetPropertyTagValuePairsOutput: + description: "" + route_table_association_GetPropertyTagValueTreeOutput: + description: "" + route_table_association_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + route_table_associations: + items: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + route_table_association_PerformClassMetadataOutput: + description: "" + route_table_association_PerformPurgeSplitableOutput: + description: "" + route_table_association_PerformSetClassMetadataOutput: + description: "" + route_table_association_PerformSetOrgMetadataOutput: + description: "" + route_table_association_PerformSetUserMetadataOutput: + description: "" + route_table_association_PerformStatusOutput: + description: "" + route_table_association_ValidateCreateDataOutput: + description: "" + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_association_ValidateUpdateDataOutput: + description: "" + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_route_set_CustomizeDeleteOutput: + description: "" + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_route_set_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_route_set_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_route_set_GetDetailsMetadataOutput: + description: "" + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_route_set_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_route_set_GetDetailsStatusOutput: + description: "" + schema: + properties: + route_table_route_set: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + route_table_route_set_GetPropertyDistinctFieldOutput: + description: "" + route_table_route_set_GetPropertySplitableExportOutput: + description: "" + route_table_route_set_GetPropertySplitableOutput: + description: "" + route_table_route_set_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStatistic' + type: object + route_table_route_set_GetPropertyTagValuePairsOutput: + description: "" + route_table_route_set_GetPropertyTagValueTreeOutput: + description: "" + route_table_route_set_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + route_table_route_sets: + items: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + route_table_route_set_PerformClassMetadataOutput: + description: "" + route_table_route_set_PerformPurgeSplitableOutput: + description: "" + route_table_route_set_PerformSetClassMetadataOutput: + description: "" + route_table_route_set_PerformSetOrgMetadataOutput: + description: "" + route_table_route_set_PerformSetUserMetadataOutput: + description: "" + route_table_route_set_PerformStatusOutput: + description: "" + route_table_route_set_ValidateCreateDataOutput: + description: "" + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_route_set_ValidateUpdateDataOutput: + description: "" + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + scaling_activity_CustomizeDeleteOutput: + description: "" + schema: + properties: + scaling_activity: + $ref: '#/definitions/ScalingActivityDetails' + type: object + scaling_activity_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scaling_activity: + $ref: '#/definitions/ScalingActivityDetails' + type: object + scaling_activity_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_activity_GetDetailsMetadataOutput: + description: "" + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_activity_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_activity_GetDetailsStatusOutput: + description: "" + schema: + properties: + scaling_activity: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + scaling_activity_GetPropertyDistinctFieldOutput: + description: "" + scaling_activity_GetPropertySplitableExportOutput: + description: "" + scaling_activity_GetPropertySplitableOutput: + description: "" + scaling_activity_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + scaling_activity: + $ref: '#/definitions/StatusStatistic' + type: object + scaling_activity_GetPropertyTagValuePairsOutput: + description: "" + scaling_activity_GetPropertyTagValueTreeOutput: + description: "" + scaling_activity_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_activities: + items: + $ref: '#/definitions/ScalingActivityDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_activity_PerformClassMetadataOutput: + description: "" + scaling_activity_PerformPurgeSplitableOutput: + description: "" + scaling_activity_PerformSetClassMetadataOutput: + description: "" + scaling_activity_PerformSetOrgMetadataOutput: + description: "" + scaling_activity_PerformSetUserMetadataOutput: + description: "" + scaling_activity_PerformStatusOutput: + description: "" + scaling_activity_ValidateCreateDataOutput: + description: "" + schema: + properties: + scaling_activity: + $ref: '#/definitions/ScalingActivityDetails' + type: object + scaling_activity_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scaling_activity: + $ref: '#/definitions/ScalingActivityDetails' + type: object + scaling_alarm_CustomizeDeleteOutput: + description: "" + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_alarm_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_alarm_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_alarm_GetDetailsMetadataOutput: + description: "" + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_alarm_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_alarm_GetPropertyDistinctFieldOutput: + description: "" + scaling_alarm_GetPropertySplitableExportOutput: + description: "" + scaling_alarm_GetPropertySplitableOutput: + description: "" + scaling_alarm_GetPropertyTagValuePairsOutput: + description: "" + scaling_alarm_GetPropertyTagValueTreeOutput: + description: "" + scaling_alarm_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_alarms: + items: + $ref: '#/definitions/StandaloneResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_alarm_PerformClassMetadataOutput: + description: "" + scaling_alarm_PerformPurgeSplitableOutput: + description: "" + scaling_alarm_PerformSetClassMetadataOutput: + description: "" + scaling_alarm_PerformSetOrgMetadataOutput: + description: "" + scaling_alarm_PerformSetUserMetadataOutput: + description: "" + scaling_alarm_ValidateCreateDataOutput: + description: "" + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_alarm_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_group_CustomizeDeleteOutput: + description: "" + schema: + properties: + scaling_group: + $ref: '#/definitions/ScalingGroupDetails' + type: object + scaling_group_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scaling_group: + $ref: '#/definitions/ScalingGroupDetails' + type: object + scaling_group_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + scaling_group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + scaling_group_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_group_GetDetailsMetadataOutput: + description: "" + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_group_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_group_GetDetailsStatusOutput: + description: "" + schema: + properties: + scaling_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + scaling_group_GetPropertyDistinctFieldOutput: + description: "" + scaling_group_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + scaling_group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + scaling_group_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + scaling_group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + scaling_group_GetPropertyProjectTagValuePairsOutput: + description: "" + scaling_group_GetPropertyProjectTagValueTreeOutput: + description: "" + scaling_group_GetPropertySplitableExportOutput: + description: "" + scaling_group_GetPropertySplitableOutput: + description: "" + scaling_group_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + scaling_group: + $ref: '#/definitions/StatusStatistic' + type: object + scaling_group_GetPropertyTagValuePairsOutput: + description: "" + scaling_group_GetPropertyTagValueTreeOutput: + description: "" + scaling_group_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_groups: + items: + $ref: '#/definitions/ScalingGroupDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_group_PerformCancelDeleteOutput: + description: "" + scaling_group_PerformChangeOwnerOutput: + description: "" + scaling_group_PerformClassMetadataOutput: + description: "" + scaling_group_PerformDisableOutput: + description: "" + scaling_group_PerformEnableOutput: + description: "" + scaling_group_PerformFreezeOutput: + description: "" + scaling_group_PerformPurgeSplitableOutput: + description: "" + scaling_group_PerformSetClassMetadataOutput: + description: "" + scaling_group_PerformSetOrgMetadataOutput: + description: "" + scaling_group_PerformSetUserMetadataOutput: + description: "" + scaling_group_PerformStatusOutput: + description: "" + scaling_group_PerformUnfreezeOutput: + description: "" + scaling_group_ValidateCreateDataOutput: + description: "" + schema: + properties: + scaling_group: + $ref: '#/definitions/ScalingGroupDetails' + type: object + scaling_group_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scaling_group: + $ref: '#/definitions/ScalingGroupDetails' + type: object + scaling_group_guest_CustomizeDeleteOutput: + description: "" + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointResourceDetails' + type: object + scaling_group_guest_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointResourceDetails' + type: object + scaling_group_guest_GetPropertyDistinctFieldOutput: + description: "" + scaling_group_guest_GetPropertySplitableExportOutput: + description: "" + scaling_group_guest_GetPropertySplitableOutput: + description: "" + scaling_group_guest_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_group_guests: + items: + $ref: '#/definitions/GuestJointResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_group_guest_PerformPurgeSplitableOutput: + description: "" + scaling_group_guest_ValidateCreateDataOutput: + description: "" + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointResourceDetails' + type: object + scaling_group_guest_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointResourceDetails' + type: object + scaling_group_network_CustomizeDeleteOutput: + description: "" + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + scaling_group_network_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + scaling_group_network_GetPropertyDistinctFieldOutput: + description: "" + scaling_group_network_GetPropertySplitableExportOutput: + description: "" + scaling_group_network_GetPropertySplitableOutput: + description: "" + scaling_group_network_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_group_networks: + items: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_group_network_PerformPurgeSplitableOutput: + description: "" + scaling_group_network_ValidateCreateDataOutput: + description: "" + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + scaling_group_network_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + scaling_policy_CustomizeDeleteOutput: + description: "" + schema: + properties: + scaling_policy: + $ref: '#/definitions/ScalingPolicyDetails' + type: object + scaling_policy_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scaling_policy: + $ref: '#/definitions/ScalingPolicyDetails' + type: object + scaling_policy_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + scaling_policy: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + scaling_policy_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_policy_GetDetailsMetadataOutput: + description: "" + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_policy_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_policy_GetDetailsStatusOutput: + description: "" + schema: + properties: + scaling_policy: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + scaling_policy_GetPropertyDistinctFieldOutput: + description: "" + scaling_policy_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + scaling_policy: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + scaling_policy_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + scaling_policy: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + scaling_policy_GetPropertyProjectTagValuePairsOutput: + description: "" + scaling_policy_GetPropertyProjectTagValueTreeOutput: + description: "" + scaling_policy_GetPropertySplitableExportOutput: + description: "" + scaling_policy_GetPropertySplitableOutput: + description: "" + scaling_policy_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + scaling_policy: + $ref: '#/definitions/StatusStatistic' + type: object + scaling_policy_GetPropertyTagValuePairsOutput: + description: "" + scaling_policy_GetPropertyTagValueTreeOutput: + description: "" + scaling_policy_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_policies: + items: + $ref: '#/definitions/ScalingPolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_policy_PerformCancelDeleteOutput: + description: "" + scaling_policy_PerformChangeOwnerOutput: + description: "" + scaling_policy_PerformClassMetadataOutput: + description: "" + scaling_policy_PerformDisableOutput: + description: "" + scaling_policy_PerformEnableOutput: + description: "" + scaling_policy_PerformFreezeOutput: + description: "" + scaling_policy_PerformPurgeSplitableOutput: + description: "" + scaling_policy_PerformSetClassMetadataOutput: + description: "" + scaling_policy_PerformSetOrgMetadataOutput: + description: "" + scaling_policy_PerformSetUserMetadataOutput: + description: "" + scaling_policy_PerformStatusOutput: + description: "" + scaling_policy_PerformTriggerOutput: + description: "" + scaling_policy_PerformUnfreezeOutput: + description: "" + scaling_policy_ValidateCreateDataOutput: + description: "" + schema: + properties: + scaling_policy: + $ref: '#/definitions/ScalingPolicyDetails' + type: object + scaling_policy_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scaling_policy: + $ref: '#/definitions/ScalingPolicyDetails' + type: object + scaling_timer_CustomizeDeleteOutput: + description: "" + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_timer_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_timer_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_timer_GetDetailsMetadataOutput: + description: "" + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_timer_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_timer_GetPropertyDistinctFieldOutput: + description: "" + scaling_timer_GetPropertySplitableExportOutput: + description: "" + scaling_timer_GetPropertySplitableOutput: + description: "" + scaling_timer_GetPropertyTagValuePairsOutput: + description: "" + scaling_timer_GetPropertyTagValueTreeOutput: + description: "" + scaling_timer_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_timers: + items: + $ref: '#/definitions/StandaloneResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_timer_PerformClassMetadataOutput: + description: "" + scaling_timer_PerformPurgeSplitableOutput: + description: "" + scaling_timer_PerformSetClassMetadataOutput: + description: "" + scaling_timer_PerformSetOrgMetadataOutput: + description: "" + scaling_timer_PerformSetUserMetadataOutput: + description: "" + scaling_timer_ValidateCreateDataOutput: + description: "" + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_timer_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + schedpolicy_CustomizeDeleteOutput: + description: "" + schema: + properties: + schedpolicy: + $ref: '#/definitions/SchedpolicyDetails' + type: object + schedpolicy_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + schedpolicy: + $ref: '#/definitions/SchedpolicyDetails' + type: object + schedpolicy_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedpolicy_GetDetailsMetadataOutput: + description: "" + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedpolicy_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedpolicy_GetPropertyDistinctFieldOutput: + description: "" + schedpolicy_GetPropertySplitableExportOutput: + description: "" + schedpolicy_GetPropertySplitableOutput: + description: "" + schedpolicy_GetPropertyTagValuePairsOutput: + description: "" + schedpolicy_GetPropertyTagValueTreeOutput: + description: "" + schedpolicy_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + schedpolicies: + items: + $ref: '#/definitions/SchedpolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + schedpolicy_PerformClassMetadataOutput: + description: "" + schedpolicy_PerformEvaluateOutput: + description: "" + schedpolicy_PerformPurgeSplitableOutput: + description: "" + schedpolicy_PerformSetClassMetadataOutput: + description: "" + schedpolicy_PerformSetOrgMetadataOutput: + description: "" + schedpolicy_PerformSetUserMetadataOutput: + description: "" + schedpolicy_ValidateCreateDataOutput: + description: "" + schema: + properties: + schedpolicy: + $ref: '#/definitions/SchedpolicyDetails' + type: object + schedpolicy_ValidateUpdateDataOutput: + description: "" + schema: + properties: + schedpolicy: + $ref: '#/definitions/SchedpolicyDetails' + type: object + schedtag_CustomizeDeleteOutput: + description: "" + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagDetails' + type: object + schedtag_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagDetails' + type: object + schedtag_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedtag_GetDetailsMetadataOutput: + description: "" + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedtag_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedtag_GetPropertyDistinctFieldOutput: + description: "" + schedtag_GetPropertySplitableExportOutput: + description: "" + schedtag_GetPropertySplitableOutput: + description: "" + schedtag_GetPropertyTagValuePairsOutput: + description: "" + schedtag_GetPropertyTagValueTreeOutput: + description: "" + schedtag_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + schedtags: + items: + $ref: '#/definitions/SchedtagDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + schedtag_PerformClassMetadataOutput: + description: "" + schedtag_PerformPurgeSplitableOutput: + description: "" + schedtag_PerformSetClassMetadataOutput: + description: "" + schedtag_PerformSetOrgMetadataOutput: + description: "" + schedtag_PerformSetResourceOutput: + description: "" + schedtag_PerformSetScopeOutput: + description: "" + schedtag_PerformSetUserMetadataOutput: + description: "" + schedtag_ValidateCreateDataOutput: + description: "" + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagDetails' + type: object + schedtag_ValidateUpdateDataOutput: + description: "" + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagDetails' + type: object + security_group_CustomizeDeleteOutput: + description: "" + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupDetails' + type: object + security_group_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupDetails' + type: object + security_group_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + security_group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + security_group_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + security_group_GetDetailsMetadataOutput: + description: "" + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + security_group_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + security_group_GetDetailsStatusOutput: + description: "" + schema: + properties: + security_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + security_group_GetPropertyDistinctFieldOutput: + description: "" + security_group_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + security_group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + security_group_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + security_group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + security_group_GetPropertyProjectTagValuePairsOutput: + description: "" + security_group_GetPropertyProjectTagValueTreeOutput: + description: "" + security_group_GetPropertySplitableExportOutput: + description: "" + security_group_GetPropertySplitableOutput: + description: "" + security_group_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + security_group: + $ref: '#/definitions/StatusStatistic' + type: object + security_group_GetPropertyTagValuePairsOutput: + description: "" + security_group_GetPropertyTagValueTreeOutput: + description: "" + security_group_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + security_groups: + items: + $ref: '#/definitions/SecgroupDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + security_group_PerformAddRuleOutput: + description: "" + security_group_PerformCancelDeleteOutput: + description: "" + security_group_PerformChangeOwnerOutput: + description: "" + security_group_PerformClassMetadataOutput: + description: "" + security_group_PerformCloneOutput: + description: "" + schema: + properties: + security_group: + $ref: '#/definitions/SecurityGroupCloneInput' + type: object + security_group_PerformFreezeOutput: + description: "" + security_group_PerformImportRulesOutput: + description: "" + security_group_PerformPrivateOutput: + description: "" + security_group_PerformPublicOutput: + description: "" + security_group_PerformPurgeSplitableOutput: + description: "" + security_group_PerformSetClassMetadataOutput: + description: "" + security_group_PerformSetOrgMetadataOutput: + description: "" + security_group_PerformSetUserMetadataOutput: + description: "" + security_group_PerformStatusOutput: + description: "" + security_group_PerformSyncstatusOutput: + description: "" + security_group_PerformUnfreezeOutput: + description: "" + security_group_ValidateCreateDataOutput: + description: "" + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupDetails' + type: object + security_group_ValidateUpdateDataOutput: + description: "" + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupDetails' + type: object + security_group_rule_CustomizeDeleteOutput: + description: "" + schema: + properties: + security_group_rule: + $ref: '#/definitions/SecgroupRuleDetails' + type: object + security_group_rule_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + security_group_rule: + $ref: '#/definitions/SecgroupRuleDetails' + type: object + security_group_rule_GetDetailsStatusOutput: + description: "" + schema: + properties: + security_group_rule: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + security_group_rule_GetPropertyDistinctFieldOutput: + description: "" + security_group_rule_GetPropertySplitableExportOutput: + description: "" + security_group_rule_GetPropertySplitableOutput: + description: "" + security_group_rule_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + security_group_rules: + items: + $ref: '#/definitions/SecgroupRuleDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + security_group_rule_PerformPurgeSplitableOutput: + description: "" + security_group_rule_ValidateCreateDataOutput: + description: "" + schema: + properties: + security_group_rule: + $ref: '#/definitions/SecgroupRuleDetails' + type: object + security_group_rule_ValidateUpdateDataOutput: + description: "" + schema: + properties: + security_group_rule: + $ref: '#/definitions/SecgroupRuleDetails' + type: object + server_CustomizeDeleteOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerDetails' + type: object + server_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerDetails' + type: object + server_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + server_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_GetDetailsCpusetCoresOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerGetCPUSetCoresResp' + type: object + server_GetDetailsCreateParamsOutput: + description: "" + server_GetDetailsDescOutput: + description: "" + server_GetDetailsHardwareInfoOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerGetHardwareInfoResp' + type: object + server_GetDetailsIsoOutput: + description: "" + server_GetDetailsJnlpOutput: + description: "" + server_GetDetailsMakeSshableCmdOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/GuestMakeSshableCmdOutput' + type: object + server_GetDetailsMetadataOutput: + description: "" + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_GetDetailsQemuInfoOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerQemuInfo' + type: object + server_GetDetailsRemoteNicsOutput: + description: "" + server_GetDetailsSshableOutput: + description: "" + server_GetDetailsSshportOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/GuestSshportOutput' + type: object + server_GetDetailsStatusOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + server_GetDetailsTasksOutput: + description: "" + server_GetDetailsVirtInstallOutput: + description: "" + server_GetDetailsVncOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerVncOutput' + type: object + server_GetPropertyDistinctFieldOutput: + description: "" + server_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + server: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + server_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + server: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + server_GetPropertyProjectTagValuePairsOutput: + description: "" + server_GetPropertyProjectTagValueTreeOutput: + description: "" + server_GetPropertySplitableExportOutput: + description: "" + server_GetPropertySplitableOutput: + description: "" + server_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/StatusStatistic' + type: object + server_GetPropertyTagValuePairsOutput: + description: "" + server_GetPropertyTagValueTreeOutput: + description: "" + server_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + servers: + items: + $ref: '#/definitions/ServerDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + server_PerformAddSecgroupOutput: + description: "" + server_PerformAddSubIpsOutput: + description: "" + server_PerformAssociateEipOutput: + description: "" + server_PerformAttachIsolatedDeviceOutput: + description: "" + server_PerformAttachdiskOutput: + description: "" + server_PerformAttachnetworkOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/SGuest' + type: object + server_PerformBatchMigrateOutput: + description: "" + server_PerformBatchSetUserMetadataOutput: + description: "" + server_PerformBatchUserMetadataOutput: + description: "" + server_PerformBindGroupsOutput: + description: "" + server_PerformBlockMirrorReadyOutput: + description: "" + server_PerformBlockStreamFailedOutput: + description: "" + server_PerformCalculateRecordChecksumOutput: + description: "" + server_PerformCancelDeleteOutput: + description: "" + server_PerformCancelExpireOutput: + description: "" + server_PerformCancelLiveMigrateOutput: + description: "" + server_PerformChangeBandwidthOutput: + description: "" + server_PerformChangeConfigOutput: + description: "" + server_PerformChangeDiskStorageOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerChangeDiskStorageInput' + type: object + server_PerformChangeIpaddrOutput: + description: "" + server_PerformChangeOwnerOutput: + description: "" + server_PerformChangeStorageOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerChangeStorageInput' + type: object + server_PerformClassMetadataOutput: + description: "" + server_PerformCloneOutput: + description: "" + server_PerformCloseForwardOutput: + description: "" + server_PerformConvertOutput: + description: "" + server_PerformConvertToKvmOutput: + description: "" + server_PerformCpusetOutput: + description: "" + server_PerformCpusetRemoveOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerCPUSetRemoveResp' + type: object + server_PerformCreateBackupOutput: + description: "" + server_PerformCreateEipOutput: + description: "" + server_PerformCreatediskOutput: + description: "" + server_PerformDelExtraOptionOutput: + description: "" + server_PerformDeleteBackupOutput: + description: "" + server_PerformDeployOutput: + description: "" + server_PerformDetachIsolatedDeviceOutput: + description: "" + server_PerformDetachScalingGroupOutput: + description: "" + server_PerformDetachdiskOutput: + description: "" + server_PerformDetachnetworkOutput: + description: "" + server_PerformDirtyServerStartOutput: + description: "" + server_PerformDirtyServerVerifyOutput: + description: "" + server_PerformDissociateEipOutput: + description: "" + server_PerformEjectisoOutput: + description: "" + server_PerformEjectvfdOutput: + description: "" + server_PerformEnableMemcleanOutput: + description: "" + server_PerformFreezeOutput: + description: "" + server_PerformHaveAgentOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/GuestHaveAgentOutput' + type: object + server_PerformImportFromLibvirtOutput: + description: "" + server_PerformImportOutput: + description: "" + server_PerformInsertisoOutput: + description: "" + server_PerformInsertvfdOutput: + description: "" + server_PerformInstanceBackupOutput: + description: "" + server_PerformInstanceSnapshotOutput: + description: "" + server_PerformInstanceSnapshotResetOutput: + description: "" + server_PerformIoThrottleOutput: + description: "" + server_PerformListForwardOutput: + description: "" + server_PerformLiveMigrateOutput: + description: "" + server_PerformLoginInfoOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerLoginInfoOutput' + type: object + server_PerformMakeSshableOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/GuestMakeSshableOutput' + type: object + server_PerformMigrateForecastOutput: + description: "" + server_PerformMigrateNetworkOutput: + description: "" + server_PerformMigrateOutput: + description: "" + server_PerformModifySrcCheckOutput: + description: "" + server_PerformMonitorOutput: + description: "" + server_PerformOpenForwardOutput: + description: "" + server_PerformPostpaidExpireOutput: + description: "" + server_PerformPrepaidRecycleOutput: + description: "" + server_PerformProbeIsolatedDevicesOutput: + description: "" + server_PerformPublicipToEipOutput: + description: "" + server_PerformPurgeOutput: + description: "" + server_PerformPurgeSplitableOutput: + description: "" + server_PerformQgaCommandOutput: + description: "" + server_PerformQgaGetNetworkOutput: + description: "" + server_PerformQgaGuestInfoTaskOutput: + description: "" + server_PerformQgaPingOutput: + description: "" + server_PerformQgaSetPasswordOutput: + description: "" + server_PerformRebuildRootOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/SGuest' + type: object + server_PerformRemoteUpdateOutput: + description: "" + server_PerformRenewOutput: + description: "" + server_PerformResetNicTrafficLimitOutput: + description: "" + server_PerformResetOutput: + description: "" + server_PerformResizeDiskOutput: + description: "" + server_PerformRestartOutput: + description: "" + server_PerformResumeOutput: + description: "" + server_PerformRevokeAdminSecgroupOutput: + description: "" + server_PerformRevokeSecgroupOutput: + description: "" + server_PerformSaveGuestImageOutput: + description: "" + server_PerformSaveImageOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerSaveImageInput' + type: object + server_PerformSaveTemplateOutput: + description: "" + server_PerformSendkeysOutput: + description: "" + server_PerformSetAutoRenewOutput: + description: "" + server_PerformSetBootIndexOutput: + description: "" + server_PerformSetClassMetadataOutput: + description: "" + server_PerformSetExtraOptionOutput: + description: "" + server_PerformSetIsolatedDeviceOutput: + description: "" + server_PerformSetNicTrafficLimitOutput: + description: "" + server_PerformSetOrgMetadataOutput: + description: "" + server_PerformSetOsInfoOutput: + description: "" + server_PerformSetPasswordOutput: + description: "" + server_PerformSetQemuParamsOutput: + description: "" + server_PerformSetSecgroupOutput: + description: "" + server_PerformSetSshportOutput: + description: "" + server_PerformSetUserMetadataOutput: + description: "" + server_PerformSlaveBlockStreamReadyOutput: + description: "" + server_PerformSnapshotAndCloneOutput: + description: "" + server_PerformStartBackupOutput: + description: "" + server_PerformStartOutput: + description: "" + server_PerformStartRescueOutput: + description: "" + server_PerformStatusOutput: + description: "" + server_PerformStopOutput: + description: "" + server_PerformStopRescueOutput: + description: "" + server_PerformStreamDisksCompleteOutput: + description: "" + server_PerformSuspendOutput: + description: "" + server_PerformSwitchToBackupOutput: + description: "" + server_PerformSyncFixNicsOutput: + description: "" + server_PerformSyncOsInfoOutput: + description: "" + server_PerformSyncOutput: + description: "" + server_PerformSyncstatusOutput: + description: "" + server_PerformUnbindGroupsOutput: + description: "" + server_PerformUndoPrepaidRecycleOutput: + description: "" + server_PerformUnfreezeOutput: + description: "" + server_PerformUserDataOutput: + description: "" + server_ValidateCreateDataOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerDetails' + type: object + server_ValidateUpdateDataOutput: + description: "" + schema: + properties: + server: + $ref: '#/definitions/ServerDetails' + type: object + server_sku_CustomizeDeleteOutput: + description: "" + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuDetails' + type: object + server_sku_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuDetails' + type: object + server_sku_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_sku_GetDetailsMetadataOutput: + description: "" + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_sku_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_sku_GetDetailsStatusOutput: + description: "" + schema: + properties: + server_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + server_sku_GetPropertyDistinctFieldOutput: + description: "" + server_sku_GetPropertyInstanceSpecsOutput: + description: "" + server_sku_GetPropertySplitableExportOutput: + description: "" + server_sku_GetPropertySplitableOutput: + description: "" + server_sku_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + server_sku: + $ref: '#/definitions/StatusStatistic' + type: object + server_sku_GetPropertySyncTasksOutput: + description: "" + server_sku_GetPropertyTagValuePairsOutput: + description: "" + server_sku_GetPropertyTagValueTreeOutput: + description: "" + server_sku_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + server_skus: + items: + $ref: '#/definitions/ServerSkuDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + server_sku_PerformClassMetadataOutput: + description: "" + server_sku_PerformDisableOutput: + description: "" + server_sku_PerformEnableOutput: + description: "" + server_sku_PerformPurgeSplitableOutput: + description: "" + server_sku_PerformSetClassMetadataOutput: + description: "" + server_sku_PerformSetOrgMetadataOutput: + description: "" + server_sku_PerformSetUserMetadataOutput: + description: "" + server_sku_PerformStatusOutput: + description: "" + server_sku_PerformSyncSkusOutput: + description: "" + server_sku_ValidateCreateDataOutput: + description: "" + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuDetails' + type: object + server_sku_ValidateUpdateDataOutput: + description: "" + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuDetails' + type: object + service_catalog_CustomizeDeleteOutput: + description: "" + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDetails' + type: object + service_catalog_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDetails' + type: object + service_catalog_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + service_catalog: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + service_catalog_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_catalog_GetDetailsMetadataOutput: + description: "" + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_catalog_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_catalog_GetDetailsStatusOutput: + description: "" + schema: + properties: + service_catalog: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + service_catalog_GetPropertyDistinctFieldOutput: + description: "" + service_catalog_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + service_catalog: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + service_catalog_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + service_catalog: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + service_catalog_GetPropertyProjectTagValuePairsOutput: + description: "" + service_catalog_GetPropertyProjectTagValueTreeOutput: + description: "" + service_catalog_GetPropertySplitableExportOutput: + description: "" + service_catalog_GetPropertySplitableOutput: + description: "" + service_catalog_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + service_catalog: + $ref: '#/definitions/StatusStatistic' + type: object + service_catalog_GetPropertyTagValuePairsOutput: + description: "" + service_catalog_GetPropertyTagValueTreeOutput: + description: "" + service_catalog_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + service_catalogs: + items: + $ref: '#/definitions/ServiceCatalogDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + service_catalog_PerformCancelDeleteOutput: + description: "" + service_catalog_PerformChangeOwnerOutput: + description: "" + service_catalog_PerformClassMetadataOutput: + description: "" + service_catalog_PerformDeployOutput: + description: "" + service_catalog_PerformFreezeOutput: + description: "" + service_catalog_PerformPrivateOutput: + description: "" + service_catalog_PerformPublicOutput: + description: "" + service_catalog_PerformPurgeSplitableOutput: + description: "" + service_catalog_PerformSetClassMetadataOutput: + description: "" + service_catalog_PerformSetOrgMetadataOutput: + description: "" + service_catalog_PerformSetUserMetadataOutput: + description: "" + service_catalog_PerformStatusOutput: + description: "" + service_catalog_PerformUnfreezeOutput: + description: "" + service_catalog_ValidateCreateDataOutput: + description: "" + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDetails' + type: object + service_catalog_ValidateUpdateDataOutput: + description: "" + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDetails' + type: object + snapshot_CustomizeDeleteOutput: + description: "" + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotDetails' + type: object + snapshot_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotDetails' + type: object + snapshot_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + snapshot: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + snapshot_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_GetDetailsMetadataOutput: + description: "" + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_GetDetailsStatusOutput: + description: "" + schema: + properties: + snapshot: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + snapshot_GetPropertyDistinctFieldOutput: + description: "" + snapshot_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + snapshot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + snapshot_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + snapshot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + snapshot_GetPropertyProjectTagValuePairsOutput: + description: "" + snapshot_GetPropertyProjectTagValueTreeOutput: + description: "" + snapshot_GetPropertySplitableExportOutput: + description: "" + snapshot_GetPropertySplitableOutput: + description: "" + snapshot_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + snapshot: + $ref: '#/definitions/StatusStatistic' + type: object + snapshot_GetPropertyTagValuePairsOutput: + description: "" + snapshot_GetPropertyTagValueTreeOutput: + description: "" + snapshot_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + snapshots: + items: + $ref: '#/definitions/SnapshotDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + snapshot_PerformCancelDeleteOutput: + description: "" + snapshot_PerformChangeOwnerOutput: + description: "" + snapshot_PerformClassMetadataOutput: + description: "" + snapshot_PerformDeleteDiskSnapshotsOutput: + description: "" + snapshot_PerformDeletedOutput: + description: "" + snapshot_PerformFreezeOutput: + description: "" + snapshot_PerformPurgeOutput: + description: "" + snapshot_PerformPurgeSplitableOutput: + description: "" + snapshot_PerformSetClassMetadataOutput: + description: "" + snapshot_PerformSetOrgMetadataOutput: + description: "" + snapshot_PerformSetUserMetadataOutput: + description: "" + snapshot_PerformStatusOutput: + description: "" + snapshot_PerformSyncstatusOutput: + description: "" + snapshot_PerformUnfreezeOutput: + description: "" + snapshot_ValidateCreateDataOutput: + description: "" + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotDetails' + type: object + snapshot_ValidateUpdateDataOutput: + description: "" + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotDetails' + type: object + snapshot_policy_CustomizeDeleteOutput: + description: "" + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDetails' + type: object + snapshot_policy_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDetails' + type: object + snapshot_policy_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + snapshot_policy: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + snapshot_policy_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_policy_GetDetailsMetadataOutput: + description: "" + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_policy_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_policy_GetDetailsStatusOutput: + description: "" + schema: + properties: + snapshot_policy: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + snapshot_policy_GetPropertyDistinctFieldOutput: + description: "" + snapshot_policy_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + snapshot_policy: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + snapshot_policy_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + snapshot_policy: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + snapshot_policy_GetPropertyProjectTagValuePairsOutput: + description: "" + snapshot_policy_GetPropertyProjectTagValueTreeOutput: + description: "" + snapshot_policy_GetPropertySplitableExportOutput: + description: "" + snapshot_policy_GetPropertySplitableOutput: + description: "" + snapshot_policy_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + snapshot_policy: + $ref: '#/definitions/StatusStatistic' + type: object + snapshot_policy_GetPropertyTagValuePairsOutput: + description: "" + snapshot_policy_GetPropertyTagValueTreeOutput: + description: "" + snapshot_policy_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + snapshot_policies: + items: + $ref: '#/definitions/SnapshotPolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + snapshot_policy_PerformBindDisksOutput: + description: "" + snapshot_policy_PerformCancelDeleteOutput: + description: "" + snapshot_policy_PerformChangeOwnerOutput: + description: "" + snapshot_policy_PerformClassMetadataOutput: + description: "" + snapshot_policy_PerformFreezeOutput: + description: "" + snapshot_policy_PerformPurgeSplitableOutput: + description: "" + snapshot_policy_PerformSetClassMetadataOutput: + description: "" + snapshot_policy_PerformSetOrgMetadataOutput: + description: "" + snapshot_policy_PerformSetUserMetadataOutput: + description: "" + snapshot_policy_PerformStatusOutput: + description: "" + snapshot_policy_PerformSyncstatusOutput: + description: "" + snapshot_policy_PerformUnbindDisksOutput: + description: "" + snapshot_policy_PerformUnfreezeOutput: + description: "" + snapshot_policy_ValidateCreateDataOutput: + description: "" + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDetails' + type: object + snapshot_policy_ValidateUpdateDataOutput: + description: "" + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDetails' + type: object + snapshot_policy_disk_CustomizeDeleteOutput: + description: "" + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + snapshot_policy_disk_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + snapshot_policy_disk_GetPropertyDistinctFieldOutput: + description: "" + snapshot_policy_disk_GetPropertySplitableExportOutput: + description: "" + snapshot_policy_disk_GetPropertySplitableOutput: + description: "" + snapshot_policy_disk_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + snapshot_policy_disks: + items: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + snapshot_policy_disk_PerformPurgeSplitableOutput: + description: "" + snapshot_policy_disk_ValidateCreateDataOutput: + description: "" + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + snapshot_policy_disk_ValidateUpdateDataOutput: + description: "" + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + ssl_certificate_CustomizeDeleteOutput: + description: "" + schema: + properties: + ssl_certificate: + $ref: '#/definitions/SSLCertificateDetails' + type: object + ssl_certificate_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + ssl_certificate: + $ref: '#/definitions/SSLCertificateDetails' + type: object + ssl_certificate_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + ssl_certificate: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + ssl_certificate_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + ssl_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + ssl_certificate_GetDetailsMetadataOutput: + description: "" + schema: + properties: + ssl_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + ssl_certificate_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + ssl_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + ssl_certificate_GetDetailsStatusOutput: + description: "" + schema: + properties: + ssl_certificate: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + ssl_certificate_GetPropertyDistinctFieldOutput: + description: "" + ssl_certificate_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + ssl_certificate: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + ssl_certificate_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + ssl_certificate: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + ssl_certificate_GetPropertyProjectTagValuePairsOutput: + description: "" + ssl_certificate_GetPropertyProjectTagValueTreeOutput: + description: "" + ssl_certificate_GetPropertySplitableExportOutput: + description: "" + ssl_certificate_GetPropertySplitableOutput: + description: "" + ssl_certificate_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + ssl_certificate: + $ref: '#/definitions/StatusStatistic' + type: object + ssl_certificate_GetPropertyTagValuePairsOutput: + description: "" + ssl_certificate_GetPropertyTagValueTreeOutput: + description: "" + ssl_certificate_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + ssl_certificates: + items: + $ref: '#/definitions/SSLCertificateDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + ssl_certificate_PerformCancelDeleteOutput: + description: "" + ssl_certificate_PerformChangeOwnerOutput: + description: "" + ssl_certificate_PerformClassMetadataOutput: + description: "" + ssl_certificate_PerformFreezeOutput: + description: "" + ssl_certificate_PerformPurgeSplitableOutput: + description: "" + ssl_certificate_PerformSetClassMetadataOutput: + description: "" + ssl_certificate_PerformSetOrgMetadataOutput: + description: "" + ssl_certificate_PerformSetUserMetadataOutput: + description: "" + ssl_certificate_PerformStatusOutput: + description: "" + ssl_certificate_PerformUnfreezeOutput: + description: "" + ssl_certificate_ValidateCreateDataOutput: + description: "" + schema: + properties: + ssl_certificate: + $ref: '#/definitions/SSLCertificateDetails' + type: object + ssl_certificate_ValidateUpdateDataOutput: + description: "" + schema: + properties: + ssl_certificate: + $ref: '#/definitions/SSLCertificateDetails' + type: object + storage_CustomizeDeleteOutput: + description: "" + schema: + properties: + storage: + $ref: '#/definitions/StorageDetails' + type: object + storage_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + storage: + $ref: '#/definitions/StorageDetails' + type: object + storage_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + storage: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + storage_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storage_GetDetailsHardwareInfoOutput: + description: "" + schema: + properties: + storage: + $ref: '#/definitions/StorageHardwareInfo' + type: object + storage_GetDetailsMetadataOutput: + description: "" + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storage_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storage_GetDetailsStatusOutput: + description: "" + schema: + properties: + storage: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + storage_GetPropertyDistinctFieldOutput: + description: "" + storage_GetPropertyDomainTagValuePairsOutput: + description: "" + storage_GetPropertyDomainTagValueTreeOutput: + description: "" + storage_GetPropertySplitableExportOutput: + description: "" + storage_GetPropertySplitableOutput: + description: "" + storage_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + storage: + $ref: '#/definitions/StatusStatistic' + type: object + storage_GetPropertyTagValuePairsOutput: + description: "" + storage_GetPropertyTagValueTreeOutput: + description: "" + storage_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + storages: + items: + $ref: '#/definitions/StorageDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + storage_PerformCacheImageOutput: + description: "" + storage_PerformChangeOwnerOutput: + description: "" + storage_PerformClassMetadataOutput: + description: "" + storage_PerformDisableOutput: + description: "" + storage_PerformEnableOutput: + description: "" + storage_PerformForceDetachHostOutput: + description: "" + storage_PerformOfflineOutput: + description: "" + storage_PerformOnlineOutput: + description: "" + storage_PerformPrivateOutput: + description: "" + storage_PerformPublicOutput: + description: "" + storage_PerformPurgeSplitableOutput: + description: "" + storage_PerformSetClassMetadataOutput: + description: "" + storage_PerformSetHardwareInfoOutput: + description: "" + schema: + properties: + storage: + $ref: '#/definitions/StorageHardwareInfo' + type: object + storage_PerformSetOrgMetadataOutput: + description: "" + storage_PerformSetSchedtagOutput: + description: "" + storage_PerformSetUserMetadataOutput: + description: "" + storage_PerformStatusOutput: + description: "" + storage_PerformUncacheImageOutput: + description: "" + storage_ValidateCreateDataOutput: + description: "" + schema: + properties: + storage: + $ref: '#/definitions/StorageDetails' + type: object + storage_ValidateUpdateDataOutput: + description: "" + schema: + properties: + storage: + $ref: '#/definitions/StorageDetails' + type: object + storagecache_CustomizeDeleteOutput: + description: "" + schema: + properties: + storagecache: + $ref: '#/definitions/StoragecacheDetails' + type: object + storagecache_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + storagecache: + $ref: '#/definitions/StoragecacheDetails' + type: object + storagecache_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storagecache_GetDetailsMetadataOutput: + description: "" + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storagecache_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storagecache_GetPropertyDistinctFieldOutput: + description: "" + storagecache_GetPropertySplitableExportOutput: + description: "" + storagecache_GetPropertySplitableOutput: + description: "" + storagecache_GetPropertyTagValuePairsOutput: + description: "" + storagecache_GetPropertyTagValueTreeOutput: + description: "" + storagecache_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + storagecaches: + items: + $ref: '#/definitions/StoragecacheDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + storagecache_PerformCacheImageOutput: + description: "" + storagecache_PerformClassMetadataOutput: + description: "" + storagecache_PerformPurgeSplitableOutput: + description: "" + storagecache_PerformSetClassMetadataOutput: + description: "" + storagecache_PerformSetOrgMetadataOutput: + description: "" + storagecache_PerformSetUserMetadataOutput: + description: "" + storagecache_PerformUncacheImageOutput: + description: "" + storagecache_ValidateCreateDataOutput: + description: "" + schema: + properties: + storagecache: + $ref: '#/definitions/StoragecacheDetails' + type: object + storagecache_ValidateUpdateDataOutput: + description: "" + schema: + properties: + storagecache: + $ref: '#/definitions/StoragecacheDetails' + type: object + storagecachedimage_CustomizeDeleteOutput: + description: "" + schema: + properties: + storagecachedimage: + $ref: '#/definitions/StoragecachedimageDetails' + type: object + storagecachedimage_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + storagecachedimage: + $ref: '#/definitions/StoragecachedimageDetails' + type: object + storagecachedimage_GetPropertyDistinctFieldOutput: + description: "" + storagecachedimage_GetPropertySplitableExportOutput: + description: "" + storagecachedimage_GetPropertySplitableOutput: + description: "" + storagecachedimage_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + storagecachedimages: + items: + $ref: '#/definitions/StoragecachedimageDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + storagecachedimage_PerformPurgeSplitableOutput: + description: "" + storagecachedimage_ValidateCreateDataOutput: + description: "" + schema: + properties: + storagecachedimage: + $ref: '#/definitions/StoragecachedimageDetails' + type: object + storagecachedimage_ValidateUpdateDataOutput: + description: "" + schema: + properties: + storagecachedimage: + $ref: '#/definitions/StoragecachedimageDetails' + type: object + tablestore_CustomizeDeleteOutput: + description: "" + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreDetails' + type: object + tablestore_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreDetails' + type: object + tablestore_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + tablestore: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + tablestore_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + tablestore_GetDetailsMetadataOutput: + description: "" + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + tablestore_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + tablestore_GetDetailsStatusOutput: + description: "" + schema: + properties: + tablestore: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + tablestore_GetPropertyDistinctFieldOutput: + description: "" + tablestore_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + tablestore: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + tablestore_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + tablestore: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + tablestore_GetPropertyProjectTagValuePairsOutput: + description: "" + tablestore_GetPropertyProjectTagValueTreeOutput: + description: "" + tablestore_GetPropertySplitableExportOutput: + description: "" + tablestore_GetPropertySplitableOutput: + description: "" + tablestore_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + tablestore: + $ref: '#/definitions/StatusStatistic' + type: object + tablestore_GetPropertyTagValuePairsOutput: + description: "" + tablestore_GetPropertyTagValueTreeOutput: + description: "" + tablestore_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + tablestores: + items: + $ref: '#/definitions/TablestoreDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + tablestore_PerformCancelDeleteOutput: + description: "" + tablestore_PerformChangeOwnerOutput: + description: "" + tablestore_PerformClassMetadataOutput: + description: "" + tablestore_PerformFreezeOutput: + description: "" + tablestore_PerformPurgeSplitableOutput: + description: "" + tablestore_PerformSetClassMetadataOutput: + description: "" + tablestore_PerformSetOrgMetadataOutput: + description: "" + tablestore_PerformSetUserMetadataOutput: + description: "" + tablestore_PerformStatusOutput: + description: "" + tablestore_PerformUnfreezeOutput: + description: "" + tablestore_ValidateCreateDataOutput: + description: "" + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreDetails' + type: object + tablestore_ValidateUpdateDataOutput: + description: "" + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreDetails' + type: object + vpc_CustomizeDeleteOutput: + description: "" + schema: + properties: + vpc: + $ref: '#/definitions/VpcDetails' + type: object + vpc_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + vpc: + $ref: '#/definitions/VpcDetails' + type: object + vpc_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + vpc: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + vpc_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_GetDetailsMetadataOutput: + description: "" + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_GetDetailsStatusOutput: + description: "" + schema: + properties: + vpc: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + vpc_GetDetailsTopologyOutput: + description: "" + schema: + properties: + vpc: + $ref: '#/definitions/VpcTopologyOutput' + type: object + vpc_GetPropertyDistinctFieldOutput: + description: "" + vpc_GetPropertyDomainTagValuePairsOutput: + description: "" + vpc_GetPropertyDomainTagValueTreeOutput: + description: "" + vpc_GetPropertySplitableExportOutput: + description: "" + vpc_GetPropertySplitableOutput: + description: "" + vpc_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + vpc: + $ref: '#/definitions/StatusStatistic' + type: object + vpc_GetPropertyTagValuePairsOutput: + description: "" + vpc_GetPropertyTagValueTreeOutput: + description: "" + vpc_ListItemFilterOutput: + description: "" + 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 + vpcs: + items: + $ref: '#/definitions/VpcDetails' + type: array + x-go-name: Output + type: object + vpc_PerformChangeOwnerOutput: + description: "" + vpc_PerformClassMetadataOutput: + description: "" + vpc_PerformDisableOutput: + description: "" + vpc_PerformEnableOutput: + description: "" + vpc_PerformPrivateOutput: + description: "" + vpc_PerformPublicOutput: + description: "" + vpc_PerformPurgeOutput: + description: "" + vpc_PerformPurgeSplitableOutput: + description: "" + vpc_PerformSetClassMetadataOutput: + description: "" + vpc_PerformSetOrgMetadataOutput: + description: "" + vpc_PerformSetUserMetadataOutput: + description: "" + vpc_PerformStatusOutput: + description: "" + vpc_PerformSyncOutput: + description: "" + vpc_PerformSyncstatusOutput: + description: "" + vpc_ValidateCreateDataOutput: + description: "" + schema: + properties: + vpc: + $ref: '#/definitions/VpcDetails' + type: object + vpc_ValidateUpdateDataOutput: + description: "" + schema: + properties: + vpc: + $ref: '#/definitions/VpcDetails' + type: object + vpc_peering_connection_CustomizeDeleteOutput: + description: "" + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: object + vpc_peering_connection_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: object + vpc_peering_connection_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + vpc_peering_connection_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_peering_connection_GetDetailsMetadataOutput: + description: "" + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_peering_connection_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_peering_connection_GetDetailsStatusOutput: + description: "" + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + vpc_peering_connection_GetPropertyDistinctFieldOutput: + description: "" + vpc_peering_connection_GetPropertyDomainTagValuePairsOutput: + description: "" + vpc_peering_connection_GetPropertyDomainTagValueTreeOutput: + description: "" + vpc_peering_connection_GetPropertySplitableExportOutput: + description: "" + vpc_peering_connection_GetPropertySplitableOutput: + description: "" + vpc_peering_connection_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/StatusStatistic' + type: object + vpc_peering_connection_GetPropertyTagValuePairsOutput: + description: "" + vpc_peering_connection_GetPropertyTagValueTreeOutput: + description: "" + vpc_peering_connection_ListItemFilterOutput: + description: "" + 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 + vpc_peering_connections: + items: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: array + x-go-name: Output + type: object + vpc_peering_connection_PerformChangeOwnerOutput: + description: "" + vpc_peering_connection_PerformClassMetadataOutput: + description: "" + vpc_peering_connection_PerformDisableOutput: + description: "" + vpc_peering_connection_PerformEnableOutput: + description: "" + vpc_peering_connection_PerformPrivateOutput: + description: "" + vpc_peering_connection_PerformPublicOutput: + description: "" + vpc_peering_connection_PerformPurgeSplitableOutput: + description: "" + vpc_peering_connection_PerformSetClassMetadataOutput: + description: "" + vpc_peering_connection_PerformSetOrgMetadataOutput: + description: "" + vpc_peering_connection_PerformSetUserMetadataOutput: + description: "" + vpc_peering_connection_PerformStatusOutput: + description: "" + vpc_peering_connection_PerformSyncstatusOutput: + description: "" + vpc_peering_connection_ValidateCreateDataOutput: + description: "" + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: object + vpc_peering_connection_ValidateUpdateDataOutput: + description: "" + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: object + waf_instance_CustomizeDeleteOutput: + description: "" + schema: + properties: + waf_instance: + $ref: '#/definitions/WafInstanceDetails' + type: object + waf_instance_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + waf_instance: + $ref: '#/definitions/WafInstanceDetails' + type: object + waf_instance_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + waf_instance: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + waf_instance_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_instance_GetDetailsCloudResourcesOutput: + description: "" + schema: + properties: + waf_instance: + $ref: '#/definitions/SCloudResources' + type: object + waf_instance_GetDetailsMetadataOutput: + description: "" + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_instance_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_instance_GetDetailsStatusOutput: + description: "" + schema: + properties: + waf_instance: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_instance_GetPropertyDistinctFieldOutput: + description: "" + waf_instance_GetPropertyDomainTagValuePairsOutput: + description: "" + waf_instance_GetPropertyDomainTagValueTreeOutput: + description: "" + waf_instance_GetPropertySplitableExportOutput: + description: "" + waf_instance_GetPropertySplitableOutput: + description: "" + waf_instance_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + waf_instance: + $ref: '#/definitions/StatusStatistic' + type: object + waf_instance_GetPropertyTagValuePairsOutput: + description: "" + waf_instance_GetPropertyTagValueTreeOutput: + description: "" + waf_instance_ListItemFilterOutput: + description: "" + 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 + waf_instances: + items: + $ref: '#/definitions/WafInstanceDetails' + type: array + x-go-name: Output + type: object + waf_instance_PerformChangeOwnerOutput: + description: "" + waf_instance_PerformClassMetadataOutput: + description: "" + waf_instance_PerformDisableOutput: + description: "" + waf_instance_PerformEnableOutput: + description: "" + waf_instance_PerformPrivateOutput: + description: "" + waf_instance_PerformPublicOutput: + description: "" + waf_instance_PerformPurgeSplitableOutput: + description: "" + waf_instance_PerformRemoteUpdateOutput: + description: "" + waf_instance_PerformSetClassMetadataOutput: + description: "" + waf_instance_PerformSetOrgMetadataOutput: + description: "" + waf_instance_PerformSetUserMetadataOutput: + description: "" + waf_instance_PerformStatusOutput: + description: "" + waf_instance_PerformSyncstatusOutput: + description: "" + waf_instance_ValidateCreateDataOutput: + description: "" + schema: + properties: + waf_instance: + $ref: '#/definitions/WafInstanceDetails' + type: object + waf_instance_ValidateUpdateDataOutput: + description: "" + schema: + properties: + waf_instance: + $ref: '#/definitions/WafInstanceDetails' + type: object + waf_ip_set_CustomizeDeleteOutput: + description: "" + schema: + properties: + waf_ip_set: + $ref: '#/definitions/WafIPSetDetails' + type: object + waf_ip_set_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + waf_ip_set: + $ref: '#/definitions/WafIPSetDetails' + type: object + waf_ip_set_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + waf_ip_set: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + waf_ip_set_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_GetDetailsMetadataOutput: + description: "" + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_GetDetailsStatusOutput: + description: "" + schema: + properties: + waf_ip_set: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_ip_set_GetPropertyDistinctFieldOutput: + description: "" + waf_ip_set_GetPropertyDomainTagValuePairsOutput: + description: "" + waf_ip_set_GetPropertyDomainTagValueTreeOutput: + description: "" + waf_ip_set_GetPropertySplitableExportOutput: + description: "" + waf_ip_set_GetPropertySplitableOutput: + description: "" + waf_ip_set_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + waf_ip_set: + $ref: '#/definitions/StatusStatistic' + type: object + waf_ip_set_GetPropertyTagValuePairsOutput: + description: "" + waf_ip_set_GetPropertyTagValueTreeOutput: + description: "" + waf_ip_set_ListItemFilterOutput: + description: "" + 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 + waf_ip_sets: + items: + $ref: '#/definitions/WafIPSetDetails' + type: array + x-go-name: Output + type: object + waf_ip_set_PerformChangeOwnerOutput: + description: "" + waf_ip_set_PerformClassMetadataOutput: + description: "" + waf_ip_set_PerformPrivateOutput: + description: "" + waf_ip_set_PerformPublicOutput: + description: "" + waf_ip_set_PerformPurgeSplitableOutput: + description: "" + waf_ip_set_PerformSetClassMetadataOutput: + description: "" + waf_ip_set_PerformSetOrgMetadataOutput: + description: "" + waf_ip_set_PerformSetUserMetadataOutput: + description: "" + waf_ip_set_PerformStatusOutput: + description: "" + waf_ip_set_ValidateCreateDataOutput: + description: "" + schema: + properties: + waf_ip_set: + $ref: '#/definitions/WafIPSetDetails' + type: object + waf_ip_set_ValidateUpdateDataOutput: + description: "" + schema: + properties: + waf_ip_set: + $ref: '#/definitions/WafIPSetDetails' + type: object + waf_ip_set_cache_CustomizeDeleteOutput: + description: "" + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/WafIPSetCacheDetails' + type: object + waf_ip_set_cache_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/WafIPSetCacheDetails' + type: object + waf_ip_set_cache_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_cache_GetDetailsMetadataOutput: + description: "" + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_cache_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_cache_GetDetailsStatusOutput: + description: "" + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_ip_set_cache_GetPropertyDistinctFieldOutput: + description: "" + waf_ip_set_cache_GetPropertySplitableExportOutput: + description: "" + waf_ip_set_cache_GetPropertySplitableOutput: + description: "" + waf_ip_set_cache_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/StatusStatistic' + type: object + waf_ip_set_cache_GetPropertyTagValuePairsOutput: + description: "" + waf_ip_set_cache_GetPropertyTagValueTreeOutput: + description: "" + waf_ip_set_cache_ListItemFilterOutput: + description: "" + 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 + waf_ip_set_caches: + items: + $ref: '#/definitions/WafIPSetCacheDetails' + type: array + x-go-name: Output + type: object + waf_ip_set_cache_PerformClassMetadataOutput: + description: "" + waf_ip_set_cache_PerformPurgeSplitableOutput: + description: "" + waf_ip_set_cache_PerformSetClassMetadataOutput: + description: "" + waf_ip_set_cache_PerformSetOrgMetadataOutput: + description: "" + waf_ip_set_cache_PerformSetUserMetadataOutput: + description: "" + waf_ip_set_cache_PerformStatusOutput: + description: "" + waf_ip_set_cache_ValidateCreateDataOutput: + description: "" + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/WafIPSetCacheDetails' + type: object + waf_ip_set_cache_ValidateUpdateDataOutput: + description: "" + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/WafIPSetCacheDetails' + type: object + waf_regex_set_CustomizeDeleteOutput: + description: "" + schema: + properties: + waf_regex_set: + $ref: '#/definitions/WafRegexSetDetails' + type: object + waf_regex_set_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + waf_regex_set: + $ref: '#/definitions/WafRegexSetDetails' + type: object + waf_regex_set_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + waf_regex_set: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + waf_regex_set_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_GetDetailsMetadataOutput: + description: "" + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_GetDetailsStatusOutput: + description: "" + schema: + properties: + waf_regex_set: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_regex_set_GetPropertyDistinctFieldOutput: + description: "" + waf_regex_set_GetPropertyDomainTagValuePairsOutput: + description: "" + waf_regex_set_GetPropertyDomainTagValueTreeOutput: + description: "" + waf_regex_set_GetPropertySplitableExportOutput: + description: "" + waf_regex_set_GetPropertySplitableOutput: + description: "" + waf_regex_set_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + waf_regex_set: + $ref: '#/definitions/StatusStatistic' + type: object + waf_regex_set_GetPropertyTagValuePairsOutput: + description: "" + waf_regex_set_GetPropertyTagValueTreeOutput: + description: "" + waf_regex_set_ListItemFilterOutput: + description: "" + 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 + waf_regex_sets: + items: + $ref: '#/definitions/WafRegexSetDetails' + type: array + x-go-name: Output + type: object + waf_regex_set_PerformChangeOwnerOutput: + description: "" + waf_regex_set_PerformClassMetadataOutput: + description: "" + waf_regex_set_PerformPrivateOutput: + description: "" + waf_regex_set_PerformPublicOutput: + description: "" + waf_regex_set_PerformPurgeSplitableOutput: + description: "" + waf_regex_set_PerformSetClassMetadataOutput: + description: "" + waf_regex_set_PerformSetOrgMetadataOutput: + description: "" + waf_regex_set_PerformSetUserMetadataOutput: + description: "" + waf_regex_set_PerformStatusOutput: + description: "" + waf_regex_set_ValidateCreateDataOutput: + description: "" + schema: + properties: + waf_regex_set: + $ref: '#/definitions/WafRegexSetDetails' + type: object + waf_regex_set_ValidateUpdateDataOutput: + description: "" + schema: + properties: + waf_regex_set: + $ref: '#/definitions/WafRegexSetDetails' + type: object + waf_regex_set_cache_CustomizeDeleteOutput: + description: "" + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: object + waf_regex_set_cache_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: object + waf_regex_set_cache_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_cache_GetDetailsMetadataOutput: + description: "" + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_cache_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_cache_GetDetailsStatusOutput: + description: "" + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_regex_set_cache_GetPropertyDistinctFieldOutput: + description: "" + waf_regex_set_cache_GetPropertySplitableExportOutput: + description: "" + waf_regex_set_cache_GetPropertySplitableOutput: + description: "" + waf_regex_set_cache_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/StatusStatistic' + type: object + waf_regex_set_cache_GetPropertyTagValuePairsOutput: + description: "" + waf_regex_set_cache_GetPropertyTagValueTreeOutput: + description: "" + waf_regex_set_cache_ListItemFilterOutput: + description: "" + 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 + waf_regex_set_caches: + items: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: array + x-go-name: Output + type: object + waf_regex_set_cache_PerformClassMetadataOutput: + description: "" + waf_regex_set_cache_PerformPurgeSplitableOutput: + description: "" + waf_regex_set_cache_PerformSetClassMetadataOutput: + description: "" + waf_regex_set_cache_PerformSetOrgMetadataOutput: + description: "" + waf_regex_set_cache_PerformSetUserMetadataOutput: + description: "" + waf_regex_set_cache_PerformStatusOutput: + description: "" + waf_regex_set_cache_ValidateCreateDataOutput: + description: "" + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: object + waf_regex_set_cache_ValidateUpdateDataOutput: + description: "" + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: object + waf_rule_CustomizeDeleteOutput: + description: "" + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleDetails' + type: object + waf_rule_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleDetails' + type: object + waf_rule_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_GetDetailsMetadataOutput: + description: "" + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_GetDetailsStatusOutput: + description: "" + schema: + properties: + waf_rule: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_rule_GetPropertyDistinctFieldOutput: + description: "" + waf_rule_GetPropertySplitableExportOutput: + description: "" + waf_rule_GetPropertySplitableOutput: + description: "" + waf_rule_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + waf_rule: + $ref: '#/definitions/StatusStatistic' + type: object + waf_rule_GetPropertyTagValuePairsOutput: + description: "" + waf_rule_GetPropertyTagValueTreeOutput: + description: "" + waf_rule_ListItemFilterOutput: + description: "" + 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 + waf_rules: + items: + $ref: '#/definitions/WafRuleDetails' + type: array + x-go-name: Output + type: object + waf_rule_PerformClassMetadataOutput: + description: "" + waf_rule_PerformPurgeSplitableOutput: + description: "" + waf_rule_PerformSetClassMetadataOutput: + description: "" + waf_rule_PerformSetOrgMetadataOutput: + description: "" + waf_rule_PerformSetUserMetadataOutput: + description: "" + waf_rule_PerformStatusOutput: + description: "" + waf_rule_PerformSyncstatusOutput: + description: "" + waf_rule_ValidateCreateDataOutput: + description: "" + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleDetails' + type: object + waf_rule_ValidateUpdateDataOutput: + description: "" + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleDetails' + type: object + waf_rule_group_CustomizeDeleteOutput: + description: "" + schema: + properties: + waf_rule_group: + $ref: '#/definitions/WafRuleGroupDetails' + type: object + waf_rule_group_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + waf_rule_group: + $ref: '#/definitions/WafRuleGroupDetails' + type: object + waf_rule_group_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + waf_rule_group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + waf_rule_group_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_GetDetailsMetadataOutput: + description: "" + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_GetDetailsStatusOutput: + description: "" + schema: + properties: + waf_rule_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_rule_group_GetPropertyDistinctFieldOutput: + description: "" + waf_rule_group_GetPropertyDomainTagValuePairsOutput: + description: "" + waf_rule_group_GetPropertyDomainTagValueTreeOutput: + description: "" + waf_rule_group_GetPropertySplitableExportOutput: + description: "" + waf_rule_group_GetPropertySplitableOutput: + description: "" + waf_rule_group_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + waf_rule_group: + $ref: '#/definitions/StatusStatistic' + type: object + waf_rule_group_GetPropertyTagValuePairsOutput: + description: "" + waf_rule_group_GetPropertyTagValueTreeOutput: + description: "" + waf_rule_group_ListItemFilterOutput: + description: "" + 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 + waf_rule_groups: + items: + $ref: '#/definitions/WafRuleGroupDetails' + type: array + x-go-name: Output + type: object + waf_rule_group_PerformChangeOwnerOutput: + description: "" + waf_rule_group_PerformClassMetadataOutput: + description: "" + waf_rule_group_PerformPrivateOutput: + description: "" + waf_rule_group_PerformPublicOutput: + description: "" + waf_rule_group_PerformPurgeSplitableOutput: + description: "" + waf_rule_group_PerformSetClassMetadataOutput: + description: "" + waf_rule_group_PerformSetOrgMetadataOutput: + description: "" + waf_rule_group_PerformSetUserMetadataOutput: + description: "" + waf_rule_group_PerformStatusOutput: + description: "" + waf_rule_group_ValidateCreateDataOutput: + description: "" + schema: + properties: + waf_rule_group: + $ref: '#/definitions/WafRuleGroupDetails' + type: object + waf_rule_group_ValidateUpdateDataOutput: + description: "" + schema: + properties: + waf_rule_group: + $ref: '#/definitions/WafRuleGroupDetails' + type: object + waf_rule_group_cache_CustomizeDeleteOutput: + description: "" + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: object + waf_rule_group_cache_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: object + waf_rule_group_cache_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_cache_GetDetailsMetadataOutput: + description: "" + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_cache_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_cache_GetDetailsStatusOutput: + description: "" + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_rule_group_cache_GetPropertyDistinctFieldOutput: + description: "" + waf_rule_group_cache_GetPropertySplitableExportOutput: + description: "" + waf_rule_group_cache_GetPropertySplitableOutput: + description: "" + waf_rule_group_cache_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/StatusStatistic' + type: object + waf_rule_group_cache_GetPropertyTagValuePairsOutput: + description: "" + waf_rule_group_cache_GetPropertyTagValueTreeOutput: + description: "" + waf_rule_group_cache_ListItemFilterOutput: + description: "" + 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 + waf_rule_group_caches: + items: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: array + x-go-name: Output + type: object + waf_rule_group_cache_PerformClassMetadataOutput: + description: "" + waf_rule_group_cache_PerformPurgeSplitableOutput: + description: "" + waf_rule_group_cache_PerformSetClassMetadataOutput: + description: "" + waf_rule_group_cache_PerformSetOrgMetadataOutput: + description: "" + waf_rule_group_cache_PerformSetUserMetadataOutput: + description: "" + waf_rule_group_cache_PerformStatusOutput: + description: "" + waf_rule_group_cache_ValidateCreateDataOutput: + description: "" + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: object + waf_rule_group_cache_ValidateUpdateDataOutput: + description: "" + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: object + waf_rule_statement_CustomizeDeleteOutput: + description: "" + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseDetails' + type: object + waf_rule_statement_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseDetails' + type: object + waf_rule_statement_GetPropertyDistinctFieldOutput: + description: "" + waf_rule_statement_GetPropertySplitableExportOutput: + description: "" + waf_rule_statement_GetPropertySplitableOutput: + description: "" + waf_rule_statement_ListItemFilterOutput: + description: "" + 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 + waf_rule_statements: + items: + $ref: '#/definitions/ResourceBaseDetails' + type: array + x-go-name: Output + type: object + waf_rule_statement_PerformPurgeSplitableOutput: + description: "" + waf_rule_statement_ValidateCreateDataOutput: + description: "" + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseDetails' + type: object + waf_rule_statement_ValidateUpdateDataOutput: + description: "" + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseDetails' + type: object + wire_CustomizeDeleteOutput: + description: "" + schema: + properties: + wire: + $ref: '#/definitions/WireDetails' + type: object + wire_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + wire: + $ref: '#/definitions/WireDetails' + type: object + wire_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + wire: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + wire_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + wire_GetDetailsMetadataOutput: + description: "" + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + wire_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + wire_GetDetailsStatusOutput: + description: "" + schema: + properties: + wire: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + wire_GetDetailsTopologyOutput: + description: "" + schema: + properties: + wire: + $ref: '#/definitions/WireTopologyOutput' + type: object + wire_GetPropertyDistinctFieldOutput: + description: "" + wire_GetPropertyDomainTagValuePairsOutput: + description: "" + wire_GetPropertyDomainTagValueTreeOutput: + description: "" + wire_GetPropertySplitableExportOutput: + description: "" + wire_GetPropertySplitableOutput: + description: "" + wire_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + wire: + $ref: '#/definitions/StatusStatistic' + type: object + wire_GetPropertyTagValuePairsOutput: + description: "" + wire_GetPropertyTagValueTreeOutput: + description: "" + wire_ListItemFilterOutput: + description: "" + 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 + wires: + items: + $ref: '#/definitions/WireDetails' + type: array + x-go-name: Output + type: object + wire_PerformChangeOwnerOutput: + description: "" + wire_PerformClassMetadataOutput: + description: "" + wire_PerformMergeFromOutput: + description: "" + wire_PerformMergeNetworkOutput: + description: "" + wire_PerformMergeToOutput: + description: "" + wire_PerformPrivateOutput: + description: "" + wire_PerformPublicOutput: + description: "" + wire_PerformPurgeSplitableOutput: + description: "" + wire_PerformSetClassMetadataOutput: + description: "" + wire_PerformSetOrgMetadataOutput: + description: "" + wire_PerformSetUserMetadataOutput: + description: "" + wire_PerformStatusOutput: + description: "" + wire_ValidateCreateDataOutput: + description: "" + schema: + properties: + wire: + $ref: '#/definitions/WireDetails' + type: object + wire_ValidateUpdateDataOutput: + description: "" + schema: + properties: + wire: + $ref: '#/definitions/WireDetails' + type: object + zone_CustomizeDeleteOutput: + description: "" + schema: + properties: + zone: + $ref: '#/definitions/ZoneDetails' + type: object + zone_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + zone: + $ref: '#/definitions/ZoneDetails' + type: object + zone_GetDetailsCapabilityOutput: + description: "" + zone_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + zone_GetDetailsDiskCapabilityOutput: + description: "" + zone_GetDetailsMetadataOutput: + description: "" + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + zone_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + zone_GetDetailsStatusOutput: + description: "" + schema: + properties: + zone: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + zone_GetPropertyDistinctFieldOutput: + description: "" + zone_GetPropertySplitableExportOutput: + description: "" + zone_GetPropertySplitableOutput: + description: "" + zone_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + zone: + $ref: '#/definitions/StatusStatistic' + type: object + zone_GetPropertyTagValuePairsOutput: + description: "" + zone_GetPropertyTagValueTreeOutput: + description: "" + zone_ListItemFilterOutput: + description: "" + 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 + zones: + items: + $ref: '#/definitions/ZoneDetails' + type: array + x-go-name: Output + type: object + zone_PerformClassMetadataOutput: + description: "" + zone_PerformPurgeOutput: + description: "" + zone_PerformPurgeSplitableOutput: + description: "" + zone_PerformSetClassMetadataOutput: + description: "" + zone_PerformSetOrgMetadataOutput: + description: "" + zone_PerformSetSchedtagOutput: + description: "" + zone_PerformSetUserMetadataOutput: + description: "" + zone_PerformStatusOutput: + description: "" + zone_ValidateCreateDataOutput: + description: "" + schema: + properties: + zone: + $ref: '#/definitions/ZoneDetails' + type: object + zone_ValidateUpdateDataOutput: + description: "" + schema: + properties: + zone: + $ref: '#/definitions/ZoneDetails' + type: object schemes: -- https -- http + - https + - http securityDefinitions: - keystone: - in: header - name: X-Auth-Token - type: apiKey + keystone: + in: header + name: X-Auth-Token + type: apiKey swagger: "2.0" diff --git a/docs/swagger/swagger_identity.yaml b/docs/swagger/swagger_identity.yaml index 55bbec5ecd..4377a18f08 100644 --- a/docs/swagger/swagger_identity.yaml +++ b/docs/swagger/swagger_identity.yaml @@ -1,12691 +1,16628 @@ basePath: / consumes: -- application/json + - 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: 项目归属域信息 + CredentialCreateInput: 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 + __meta__: + additionalProperties: type: string - x-go-name: Id - name: - description: 域名称 - type: string - x-go-name: Name + description: 标签列表,最多支持20个 + example: + user:rd: op type: object - id: + 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 + is_sso: + description: 是否是SSO登录方式 + type: boolean + x-go-name: IsSso + 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 + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + 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 + is_sso: + description: 是否是SSO登录方式 + type: boolean + x-go-name: IsSso + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + 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 + is_sso: + description: 是否是SSO登录方式 + type: boolean + x-go-name: IsSso + 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 - 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: + is_system_account: + type: boolean + x-go-name: IsSystemAccount + 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-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: 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 + IsSystemAccount: + description: 是否为系统账号 + type: boolean + 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 + OrganizationCreateInput: + 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 + 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 + key: + description: key + items: + type: string + type: array + x-go-name: Key + keys: + description: |- + keys + swagger: ignore + type: string + x-go-name: Keys + level: + description: 'swagger: ignore' + format: int64 + type: integer + x-go-name: Level + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + type: + $ref: '#/definitions/TOrgType' + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + OrganizationNodePerformBindInput: + properties: + resource_type: + type: string + x-go-name: ResourceType + target_id: + items: + type: string + type: array + x-go-name: TargetId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + OrganizationNodeUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + weight: + format: int64 + type: integer + x-go-name: Weight + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + OrganizationPerformAddLevelsInput: + properties: + Description: + type: string + Tags: + additionalProperties: + type: string + type: object + Weight: + format: int64 + type: integer + key: + items: + type: string + type: array + x-go-name: Key + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + OrganizationPerformAddNodeInput: + properties: + Description: + type: string + Tags: + additionalProperties: + type: string + type: object + Weight: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + OrganizationPerformCleanInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + OrganizationPerformSyncInput: + properties: + Reset: + type: boolean + ResourceType: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + OrganizationUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + 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 + 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 + object_tags: + $ref: '#/definitions/TTagSet' + org_node_id: + description: 组织架构节点ID + items: + type: string + type: array + x-go-name: OrgNodeId + 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 + scope: + $ref: '#/definitions/TRbacScope' + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + PolicyDetails: + properties: + OrgNodes: + items: + $ref: '#/definitions/SOrganizationNodeInfo' + type: array + 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: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + extra: + description: 额外信息 + type: object + x-go-name: Extra + id: + description: 资源UUID 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只需要指定其中一个 + 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 - x-go-name: Id - name: - description: 指定Domain的Name - type: string - x-go-name: Name + description: 标签 type: object - x-go-name: Domain - project: - description: 指定token的scope为指定的项目 + 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 + org_node_id: + description: 匹配的组织架构节点 + items: + type: string + type: array + x-go-name: OrgNodeId + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + 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' + org_node_id: + description: 组织架构节点ID + items: + type: string + type: array + x-go-name: OrgNodeId + 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 + ProjectCleanInput: + 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: + Organization: + $ref: '#/definitions/SProjectOrganization' + 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 + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + 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 + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + 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: - domain: - description: 指定项目所在的域（domain） - properties: - id: - description: 指定项目所在域的ID，ID和Name只需要指定其中一个 + id: type: string x-go-name: Id - name: - description: 指定项目所在域的Name + service: 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 + x-go-name: Service 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: |- - 设置配额操作 + x-go-name: CASTicket + id: + description: ID of identity provider, optional + type: string + x-go-name: Id + methods: + 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 + 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-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: 标签 + 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-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: + 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 + SOrganizationDetails: + description: +onecloud:model-api-gen + properties: + Enabled: + $ref: '#/definitions/TriState' + Extra: + description: 额外信息 + type: object + IsPublic: + description: 是否共享 + type: boolean + Keys: + type: string + Level: + format: int64 + type: integer + PublicScope: + description: 默认共享范围 + type: string + Type: + $ref: '#/definitions/TOrgType' + 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 + 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 + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/keystone/models + SOrganizationNodeDetails: + 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 + full_label: + type: string + x-go-name: FullLabel + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + level: + format: int64 + type: integer + x-go-name: Level + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + org_id: + type: string + x-go-name: OrgId + organization: + type: string + x-go-name: Organization + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + tags: + $ref: '#/definitions/TTagSet' + type: + $ref: '#/definitions/TOrgType' + 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 + weight: + format: int64 + type: integer + x-go-name: Weight + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SOrganizationNodeInfo: + properties: + FullLabel: + type: string + Id: + type: string + OrgId: + type: string + Organization: + type: string + Tags: + $ref: '#/definitions/TTagSet' + Type: + $ref: '#/definitions/TOrgType' + 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 + SProjectOrganization: + properties: + Id: + type: string + Keys: + items: + type: string + type: array + Name: + type: string + Nodes: + items: + $ref: '#/definitions/SProjectOrganizationNode' + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SProjectOrganizationNode: + properties: + Id: + type: string + Labels: + 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 + StandaloneAnonResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneAnonResourceCreateInput: + 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 + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneAnonResourceDetails: + 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 + 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 + TOrgType: + type: string + 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/StatusStatisticStatusInfo' + $ref: '#/definitions/STag' 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: 用户所属项目列表 + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: items: - $ref: '#/definitions/KeystoneTenantV2' + $ref: '#/definitions/TTagSet' 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 + 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-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: 外部资源统计信息（资源类别：数量） + x-go-package: yunion.io/x/onecloud/pkg/mcclient + TokenCredentialV3: + properties: + token: + $ref: '#/definitions/KeystoneTokenV3' type: object - x-go-name: ExtResource - ext_resources_last_update: - description: 外部资源统计信息上次更新时间 - format: date-time + x-go-package: yunion.io/x/onecloud/pkg/mcclient + TriState: type: string - x-go-name: ExtResourcesLastUpdate - ext_resources_next_update: - description: 外部资源统计信息下次更新时间 - format: date-time - type: string - x-go-name: ExtResourcesNextUpdate - extra: - description: 额外信息 + x-go-package: yunion.io/x/pkg/tristate + 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-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: 标签 + 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: + 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 + 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 + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + 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-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 + 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" + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Cloudprovider 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') - 支持的操作符如下： + /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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: credential_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: credential_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: domain_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: domain_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: endpoint_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: endpoint_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: group_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: group_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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_domain + 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: identity_provider_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: identity_provider_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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 + /organization_nodes: + get: + description: 列表 + operationId: organization_node_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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: org_id + type: string + x-go-name: OrgId + - in: query + name: org_type + type: string + x-go-name: OrgType + - format: int64 + in: query + name: level + type: integer + x-go-name: Level + - $ref: '#/definitions/TTagSetList' + description: domain tags filter imposed by policy + in: query + name: policy_domain_tags + x-go-name: PolicyDomainTags + - $ref: '#/definitions/TTagSetList' + description: project tags filter imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - $ref: '#/definitions/TTagSetList' + description: object tags filter imposed by policy + in: query + name: policy_object_tags + x-go-name: PolicyObjectTags + responses: + "200": + $ref: '#/responses/organization_node_ListItemFilterOutput' + summary: 项目列表 + tags: + - organization_node + post: + description: 新建 + operationId: organization_node_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + organization_node: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_node_ValidateCreateDataOutput' + summary: 新建 + tags: + - organization_node + /organization_nodes/{id}: + delete: + description: 删除 + operationId: organization_node_CustomizeDelete + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_node_CustomizeDeleteOutput' + summary: 删除 + tags: + - organization_node + get: + description: 获取详情 + operationId: organization_node_FetchCustomizeColumns + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_node_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - organization_node + put: + description: 更新 + operationId: organization_node_ValidateUpdateData + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization_node: + $ref: '#/definitions/OrganizationNodeUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_node_ValidateUpdateDataOutput' + summary: 更新 + tags: + - organization_node + /organization_nodes/{id}/bind: + post: + description: 执行操作Bind + operationId: organization_node_PerformBind + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization_node: + $ref: '#/definitions/OrganizationNodePerformBindInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_node_PerformBindOutput' + summary: 执行操作Bind + tags: + - organization_node + /organization_nodes/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: organization_node_GetDetailsClassMetadata + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_node_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - organization_node + post: + description: 执行操作ClassMetadata + operationId: organization_node_PerformClassMetadata + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_node_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - organization_node + /organization_nodes/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: organization_node_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_node_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - organization_node + /organization_nodes/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: organization_node_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_node_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - organization_node + /organization_nodes/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: organization_node_PerformSetClassMetadata + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_node_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - organization_node + /organization_nodes/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: organization_node_PerformSetOrgMetadata + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_node_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - organization_node + /organization_nodes/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: organization_node_PerformSetUserMetadata + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_node_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - organization_node + /organization_nodes/{id}/unbind: + post: + description: 执行操作Unbind + operationId: organization_node_PerformUnbind + parameters: + - description: The Id or Name of organization_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization_node: + $ref: '#/definitions/OrganizationNodePerformBindInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_node_PerformUnbindOutput' + summary: 执行操作Unbind + tags: + - organization_node + /organization_nodes/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: organization_node_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/organization_node_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - organization_node + /organization_nodes/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: organization_node_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + organization_node: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_node_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - organization_node + /organization_nodes/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: organization_node_GetPropertySplitable + responses: + "200": + $ref: '#/responses/organization_node_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - organization_node + /organization_nodes/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: organization_node_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/organization_node_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - organization_node + /organization_nodes/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: organization_node_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/organization_node_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - organization_node + /organization_nodes/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: organization_node_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/organization_node_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - organization_node + /organizations: + get: + description: 列表 + operationId: organization_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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: 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: status + type: array + x-go-name: Status + - in: query + items: + $ref: '#/definitions/TOrgType' + name: type + type: array + x-go-name: Type + - in: query + name: key + type: string + x-go-name: Key + responses: + "200": + $ref: '#/responses/organization_ListItemFilterOutput' + summary: 组织列表 + tags: + - organization + post: + description: 新建 + operationId: organization_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + organization: + $ref: '#/definitions/OrganizationCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_ValidateCreateDataOutput' + summary: 新建 + tags: + - organization + /organizations/{id}: + delete: + description: 删除 + operationId: organization_CustomizeDelete + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_CustomizeDeleteOutput' + summary: 删除 + tags: + - organization + get: + description: 获取详情 + operationId: organization_FetchCustomizeColumns + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - organization + put: + description: 更新 + operationId: organization_ValidateUpdateData + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + $ref: '#/definitions/OrganizationUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_ValidateUpdateDataOutput' + summary: 更新 + tags: + - organization + /organizations/{id}/add-level: + post: + description: 执行操作AddLevel + operationId: organization_PerformAddLevel + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + $ref: '#/definitions/OrganizationPerformAddLevelsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformAddLevelOutput' + summary: 执行操作AddLevel + tags: + - organization + /organizations/{id}/add-node: + post: + description: 执行操作AddNode + operationId: organization_PerformAddNode + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + $ref: '#/definitions/OrganizationPerformAddNodeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformAddNodeOutput' + summary: 执行操作AddNode + tags: + - organization + /organizations/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: organization_GetDetailsClassMetadata + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - organization + post: + description: 执行操作ClassMetadata + operationId: organization_PerformClassMetadata + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - organization + /organizations/{id}/clean: + post: + description: 执行操作Clean + operationId: organization_PerformClean + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + $ref: '#/definitions/OrganizationPerformCleanInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformCleanOutput' + summary: 执行操作Clean + tags: + - organization + /organizations/{id}/disable: + post: + description: 执行操作Disable + operationId: organization_PerformDisable + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformDisableOutput' + summary: 执行操作Disable + tags: + - organization + /organizations/{id}/enable: + post: + description: 执行操作Enable + operationId: organization_PerformEnable + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformEnableOutput' + summary: 执行操作Enable + tags: + - organization + /organizations/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: organization_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 organization + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - organization + /organizations/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: organization_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - organization + /organizations/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: organization_PerformSetClassMetadata + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - organization + /organizations/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: organization_PerformSetOrgMetadata + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - organization + /organizations/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: organization_PerformSetUserMetadata + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - organization + /organizations/{id}/status: + get: + description: 获取指定信息Status + operationId: organization_GetDetailsStatus + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/organization_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - organization + /organizations/{id}/sync: + post: + description: 执行操作Sync + operationId: organization_PerformSync + parameters: + - description: The Id or Name of organization + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + organization: + $ref: '#/definitions/OrganizationPerformSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformSyncOutput' + summary: 执行操作Sync + tags: + - organization + /organizations/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: organization_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/organization_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - organization + /organizations/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: organization_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/organization_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - organization + /organizations/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: organization_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/organization_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - organization + /organizations/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: organization_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + organization: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/organization_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - organization + /organizations/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: organization_GetPropertySplitable + responses: + "200": + $ref: '#/responses/organization_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - organization + /organizations/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: organization_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/organization_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - organization + /organizations/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: organization_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/organization_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - organization + /organizations/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: organization_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/organization_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - organization + /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 - 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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: 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}/disable: + post: + description: 执行操作Disable + operationId: policy_PerformDisable + 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/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_PerformDisableOutput' + summary: 禁用资源 + tags: + - policy + /policies/{id}/enable: + post: + description: 执行操作Enable + operationId: policy_PerformEnable + 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/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_PerformEnableOutput' + summary: 启用资源 + 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 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: policy_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: policy_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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 - - 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 + 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 + - description: 通过项目管理员id过滤 + in: query + items: + type: string + name: admin_id + type: array + x-go-name: AdminId + 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列表，如果列表为空，则获取全部标签 + 标签分为 - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - 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 project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - project + /projects/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: project_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: project_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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/clean: + post: + description: 执行操作Clean + operationId: project_PerformClean + parameters: + - in: body + name: body + schema: + properties: + project: + $ref: '#/definitions/ProjectCleanInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_PerformCleanOutput' + summary: 执行操作Clean + 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') + 支持的操作符如下： - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | 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 + - $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列表，如果列表为空，则获取全部标签 + 标签分为 - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: region_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: region_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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 - - $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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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') + 支持的操作符如下： - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | 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: 指定查询的权限范围，可能值为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列表，如果列表为空，则获取全部标签 + 标签分为 - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - 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 role + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/role_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - role + /roles/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: role_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: role_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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') + 支持的操作符如下： - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | 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 + 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 - - 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列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 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 + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: service_certificate_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: service_certificate_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: service_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: service_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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 + /token_caches: + get: + description: 列表 + operationId: token_cache_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 + responses: + "200": + $ref: '#/responses/token_cache_ListItemFilterOutput' + summary: 列表 + tags: + - token_cache + post: + description: 新建 + operationId: token_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + token_cache: + $ref: '#/definitions/StandaloneAnonResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/token_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - token_cache + /token_caches/{id}: + delete: + description: 删除 + operationId: token_cache_CustomizeDelete + parameters: + - description: The Id or Name of token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/token_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - token_cache + get: + description: 获取详情 + operationId: token_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/token_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - token_cache + put: + description: 更新 + operationId: token_cache_ValidateUpdateData + parameters: + - description: The Id or Name of token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + token_cache: + $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/token_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - token_cache + /token_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: token_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/token_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - token_cache + post: + description: 执行操作ClassMetadata + operationId: token_cache_PerformClassMetadata + parameters: + - description: The Id or Name of token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + token_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/token_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - token_cache + /token_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: token_cache_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 token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/token_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - token_cache + /token_caches/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: token_cache_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/token_cache_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - token_cache + /token_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: token_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + token_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/token_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - token_cache + /token_caches/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: token_cache_PerformSetOrgMetadata + parameters: + - description: The Id or Name of token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + token_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/token_cache_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - token_cache + /token_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: token_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of token_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + token_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/token_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - token_cache + /token_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: token_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/token_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - token_cache + /token_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: token_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + token_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/token_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - token_cache + /token_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: token_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/token_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - token_cache + /token_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: token_cache_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/token_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - token_cache + /token_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: token_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/token_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - token_cache + /token_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: token_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/token_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - token_cache + /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: 以资源是否启用/禁用过滤列表 + 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}/disable: + post: + description: 执行操作Disable + operationId: user_PerformDisable + 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/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformDisableOutput' + summary: 执行操作Disable + tags: + - user + /users/{id}/enable: + post: + description: 执行操作Enable + operationId: user_PerformEnable + 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/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformEnableOutput' + summary: 执行操作Enable + 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}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: user_GetDetailsOrgMetadata + 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_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + 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-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: user_PerformSetOrgMetadata + 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_PerformSetOrgMetadataOutput' + 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: + delete: + description: keystone v3删除token API + operationId: invalidateTokensV3 + summary: keystone v3删除token API + tags: + - authentication + 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 + /v3/auth/tokens/invalid: + get: + description: keystone v3获取被删除的token的列表API + operationId: fetchInvalidTokensV3 + summary: keystone v3获取被删除的token的列表API + tags: + - authentication produces: -- application/json + - 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 + credential_CustomizeDeleteOutput: + description: "" + schema: + properties: + credential: + $ref: '#/definitions/CredentialDetails' + type: object + credential_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + credential: + $ref: '#/definitions/CredentialDetails' + type: object + credential_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + credential: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + credential_GetDetailsMetadataOutput: + description: "" + schema: + properties: + credential: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + credential_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + credential: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + credential_GetPropertyDistinctFieldOutput: + description: "" + credential_GetPropertySplitableExportOutput: + description: "" + credential_GetPropertySplitableOutput: + description: "" + credential_GetPropertyTagValuePairsOutput: + description: "" + credential_GetPropertyTagValueTreeOutput: + description: "" + credential_ListItemFilterOutput: + description: "" + 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: + description: "" + credential_PerformPurgeSplitableOutput: + description: "" + credential_PerformSetClassMetadataOutput: + description: "" + credential_PerformSetOrgMetadataOutput: + description: "" + credential_PerformSetUserMetadataOutput: + description: "" + credential_ValidateCreateDataOutput: + description: "" + schema: + properties: + credential: + $ref: '#/definitions/CredentialDetails' + type: object + credential_ValidateUpdateDataOutput: + description: "" + schema: + properties: + credential: + $ref: '#/definitions/CredentialDetails' + type: object + domain_CustomizeDeleteOutput: + description: "" + schema: + properties: + domain: + $ref: '#/definitions/DomainDetails' + type: object + domain_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + domain: + $ref: '#/definitions/DomainDetails' + type: object + domain_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + domain_GetDetailsMetadataOutput: + description: "" + schema: + properties: + domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + domain_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + domain_GetPropertyDistinctFieldOutput: + description: "" + domain_GetPropertySplitableExportOutput: + description: "" + domain_GetPropertySplitableOutput: + description: "" + domain_GetPropertyTagValuePairsOutput: + description: "" + domain_GetPropertyTagValueTreeOutput: + description: "" + domain_ListItemFilterOutput: + description: "" + 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: + description: "" + domain_PerformPurgeSplitableOutput: + description: "" + domain_PerformSetClassMetadataOutput: + description: "" + domain_PerformSetOrgMetadataOutput: + description: "" + domain_PerformSetUserMetadataOutput: + description: "" + domain_PerformUnlinkIdpOutput: + description: "" + domain_ValidateCreateDataOutput: + description: "" + schema: + properties: + domain: + $ref: '#/definitions/DomainDetails' + type: object + domain_ValidateUpdateDataOutput: + description: "" + schema: + properties: + domain: + $ref: '#/definitions/DomainDetails' + type: object + endpoint_CustomizeDeleteOutput: + description: "" + schema: + properties: + endpoint: + $ref: '#/definitions/EndpointDetails' + type: object + endpoint_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + endpoint: + $ref: '#/definitions/EndpointDetails' + type: object + endpoint_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + endpoint: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + endpoint_GetDetailsMetadataOutput: + description: "" + schema: + properties: + endpoint: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + endpoint_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + endpoint: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + endpoint_GetPropertyDistinctFieldOutput: + description: "" + endpoint_GetPropertySplitableExportOutput: + description: "" + endpoint_GetPropertySplitableOutput: + description: "" + endpoint_GetPropertyTagValuePairsOutput: + description: "" + endpoint_GetPropertyTagValueTreeOutput: + description: "" + endpoint_ListItemFilterOutput: + description: "" + 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: + description: "" + endpoint_PerformPurgeSplitableOutput: + description: "" + endpoint_PerformSetClassMetadataOutput: + description: "" + endpoint_PerformSetOrgMetadataOutput: + description: "" + endpoint_PerformSetUserMetadataOutput: + description: "" + endpoint_ValidateCreateDataOutput: + description: "" + schema: + properties: + endpoint: + $ref: '#/definitions/EndpointDetails' + type: object + endpoint_ValidateUpdateDataOutput: + description: "" + schema: + properties: + endpoint: + $ref: '#/definitions/EndpointDetails' + type: object + group_CustomizeDeleteOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/GroupDetails' + type: object + group_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/GroupDetails' + type: object + group_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetDetailsMetadataOutput: + description: "" + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetPropertyDistinctFieldOutput: + description: "" + group_GetPropertyDomainTagValuePairsOutput: + description: "" + group_GetPropertyDomainTagValueTreeOutput: + description: "" + group_GetPropertySplitableExportOutput: + description: "" + group_GetPropertySplitableOutput: + description: "" + group_GetPropertyTagValuePairsOutput: + description: "" + group_GetPropertyTagValueTreeOutput: + description: "" + group_ListItemFilterOutput: + description: "" + 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: + description: "" + group_PerformClassMetadataOutput: + description: "" + group_PerformJoinOutput: + description: "" + group_PerformLeaveOutput: + description: "" + group_PerformPurgeSplitableOutput: + description: "" + group_PerformRemoveUsersOutput: + description: "" + group_PerformSetClassMetadataOutput: + description: "" + group_PerformSetOrgMetadataOutput: + description: "" + group_PerformSetUserMetadataOutput: + description: "" + group_ValidateCreateDataOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/GroupDetails' + type: object + group_ValidateUpdateDataOutput: + description: "" + schema: + properties: + group: + $ref: '#/definitions/GroupDetails' + type: object + identity_provider_CustomizeDeleteOutput: + description: "" + schema: + properties: + identity_provider: + $ref: '#/definitions/IdentityProviderDetails' + type: object + identity_provider_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + identity_provider: + $ref: '#/definitions/IdentityProviderDetails' + type: object + identity_provider_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + identity_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + identity_provider_GetDetailsConfigOutput: + description: "" + identity_provider_GetDetailsMetadataOutput: + description: "" + schema: + properties: + identity_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + identity_provider_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + identity_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + identity_provider_GetDetailsSamlMetadataOutput: + description: "" + schema: + properties: + identity_provider: + $ref: '#/definitions/GetIdpSamlMetadataOutput' + type: object + identity_provider_GetDetailsSsoCallbackUriOutput: + description: "" + schema: + properties: + identity_provider: + $ref: '#/definitions/GetIdpSsoCallbackUriOutput' + type: object + identity_provider_GetDetailsSsoRedirectUriOutput: + description: "" + schema: + properties: + identity_provider: + $ref: '#/definitions/GetIdpSsoRedirectUriOutput' + type: object + identity_provider_GetDetailsStatusOutput: + description: "" + schema: + properties: + identity_provider: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + identity_provider_GetPropertyDistinctFieldOutput: + description: "" + identity_provider_GetPropertySplitableExportOutput: + description: "" + identity_provider_GetPropertySplitableOutput: + description: "" + identity_provider_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + identity_provider: + $ref: '#/definitions/StatusStatistic' + type: object + identity_provider_GetPropertyTagValuePairsOutput: + description: "" + identity_provider_GetPropertyTagValueTreeOutput: + description: "" + identity_provider_ListItemFilterOutput: + description: "" + 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: + description: "" + identity_provider_PerformConfigOutput: + description: "" + identity_provider_PerformDefaultSsoOutput: + description: "" + identity_provider_PerformDisableOutput: + description: "" + identity_provider_PerformEnableOutput: + description: "" + identity_provider_PerformPurgeSplitableOutput: + description: "" + identity_provider_PerformSetClassMetadataOutput: + description: "" + identity_provider_PerformSetOrgMetadataOutput: + description: "" + identity_provider_PerformSetUserMetadataOutput: + description: "" + identity_provider_PerformStatusOutput: + description: "" + identity_provider_PerformSyncOutput: + description: "" + identity_provider_ValidateCreateDataOutput: + description: "" + schema: + properties: + identity_provider: + $ref: '#/definitions/IdentityProviderDetails' + type: object + identity_provider_ValidateUpdateDataOutput: + description: "" + schema: + properties: + identity_provider: + $ref: '#/definitions/IdentityProviderDetails' + type: object + models_GetIdentityQuotaOutput: + description: "" + schema: + properties: + identity_quotas: + items: + $ref: '#/definitions/SIdentityQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListIdentityQuotasOutput: + description: "" + schema: + properties: + identity_quotas: + items: + $ref: '#/definitions/SIdentityQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetIdentityQuotasOutput: + description: "" + schema: + properties: + identity_quotas: + items: + $ref: '#/definitions/SIdentityQuotaDetail' + type: array + x-go-name: Output + type: object + organization_CustomizeDeleteOutput: + description: "" + schema: + properties: + organization: + $ref: '#/definitions/SOrganizationDetails' + type: object + organization_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + organization: + $ref: '#/definitions/SOrganizationDetails' + type: object + organization_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + organization: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + organization_GetDetailsMetadataOutput: + description: "" + schema: + properties: + organization: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + organization_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + organization: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + organization_GetDetailsStatusOutput: + description: "" + schema: + properties: + organization: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + organization_GetPropertyDistinctFieldOutput: + description: "" + organization_GetPropertyDomainTagValuePairsOutput: + description: "" + organization_GetPropertyDomainTagValueTreeOutput: + description: "" + organization_GetPropertySplitableExportOutput: + description: "" + organization_GetPropertySplitableOutput: + description: "" + organization_GetPropertyTagValuePairsOutput: + description: "" + organization_GetPropertyTagValueTreeOutput: + description: "" + organization_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + organizations: + items: + $ref: '#/definitions/SOrganizationDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + organization_PerformAddLevelOutput: + description: "" + organization_PerformAddNodeOutput: + description: "" + organization_PerformClassMetadataOutput: + description: "" + organization_PerformCleanOutput: + description: "" + organization_PerformDisableOutput: + description: "" + organization_PerformEnableOutput: + description: "" + organization_PerformPurgeSplitableOutput: + description: "" + organization_PerformSetClassMetadataOutput: + description: "" + organization_PerformSetOrgMetadataOutput: + description: "" + organization_PerformSetUserMetadataOutput: + description: "" + organization_PerformSyncOutput: + description: "" + organization_ValidateCreateDataOutput: + description: "" + schema: + properties: + organization: + $ref: '#/definitions/SOrganizationDetails' + type: object + organization_ValidateUpdateDataOutput: + description: "" + schema: + properties: + organization: + $ref: '#/definitions/SOrganizationDetails' + type: object + organization_node_CustomizeDeleteOutput: + description: "" + schema: + properties: + organization_node: + $ref: '#/definitions/SOrganizationNodeDetails' + type: object + organization_node_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + organization_node: + $ref: '#/definitions/SOrganizationNodeDetails' + type: object + organization_node_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + organization_node: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + organization_node_GetDetailsMetadataOutput: + description: "" + schema: + properties: + organization_node: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + organization_node_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + organization_node: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + organization_node_GetPropertyDistinctFieldOutput: + description: "" + organization_node_GetPropertySplitableExportOutput: + description: "" + organization_node_GetPropertySplitableOutput: + description: "" + organization_node_GetPropertyTagValuePairsOutput: + description: "" + organization_node_GetPropertyTagValueTreeOutput: + description: "" + organization_node_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + organization_nodes: + items: + $ref: '#/definitions/SOrganizationNodeDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + organization_node_PerformBindOutput: + description: "" + organization_node_PerformClassMetadataOutput: + description: "" + organization_node_PerformPurgeSplitableOutput: + description: "" + organization_node_PerformSetClassMetadataOutput: + description: "" + organization_node_PerformSetOrgMetadataOutput: + description: "" + organization_node_PerformSetUserMetadataOutput: + description: "" + organization_node_PerformUnbindOutput: + description: "" + organization_node_ValidateCreateDataOutput: + description: "" + schema: + properties: + organization_node: + $ref: '#/definitions/SOrganizationNodeDetails' + type: object + organization_node_ValidateUpdateDataOutput: + description: "" + schema: + properties: + organization_node: + $ref: '#/definitions/SOrganizationNodeDetails' + type: object + policy_CustomizeDeleteOutput: + description: "" + schema: + properties: + policy: + $ref: '#/definitions/PolicyDetails' + type: object + policy_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + policy: + $ref: '#/definitions/PolicyDetails' + type: object + policy_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_GetDetailsMetadataOutput: + description: "" + schema: + properties: + policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_GetPropertyDistinctFieldOutput: + description: "" + policy_GetPropertyDomainTagValuePairsOutput: + description: "" + policy_GetPropertyDomainTagValueTreeOutput: + description: "" + policy_GetPropertySplitableExportOutput: + description: "" + policy_GetPropertySplitableOutput: + description: "" + policy_GetPropertyTagValuePairsOutput: + description: "" + policy_GetPropertyTagValueTreeOutput: + description: "" + policy_ListItemFilterOutput: + description: "" + 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: + description: "" + policy_PerformClassMetadataOutput: + description: "" + policy_PerformDisableOutput: + description: "" + policy_PerformEnableOutput: + description: "" + policy_PerformPrivateOutput: + description: "" + policy_PerformPublicOutput: + description: "" + policy_PerformPurgeSplitableOutput: + description: "" + policy_PerformSetClassMetadataOutput: + description: "" + policy_PerformSetOrgMetadataOutput: + description: "" + policy_PerformSetUserMetadataOutput: + description: "" + policy_ValidateCreateDataOutput: + description: "" + schema: + properties: + policy: + $ref: '#/definitions/PolicyDetails' + type: object + policy_ValidateUpdateDataOutput: + description: "" + schema: + properties: + policy: + $ref: '#/definitions/PolicyDetails' + type: object + project_CustomizeDeleteOutput: + description: "" + schema: + properties: + project: + $ref: '#/definitions/ProjectDetails' + type: object + project_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + project: + $ref: '#/definitions/ProjectDetails' + type: object + project_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_GetDetailsMetadataOutput: + description: "" + schema: + properties: + project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_GetPropertyDistinctFieldOutput: + description: "" + project_GetPropertyDomainTagValuePairsOutput: + description: "" + project_GetPropertyDomainTagValueTreeOutput: + description: "" + project_GetPropertySplitableExportOutput: + description: "" + project_GetPropertySplitableOutput: + description: "" + project_GetPropertyTagValuePairsOutput: + description: "" + project_GetPropertyTagValueTreeOutput: + description: "" + project_ListItemFilterOutput: + description: "" + 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: + description: "" + project_PerformCleanOutput: + description: "" + project_PerformJoinOutput: + description: "" + project_PerformLeaveOutput: + description: "" + project_PerformPurgeSplitableOutput: + description: "" + project_PerformSetAdminOutput: + description: "" + project_PerformSetClassMetadataOutput: + description: "" + project_PerformSetOrgMetadataOutput: + description: "" + project_PerformSetUserMetadataOutput: + description: "" + project_ValidateCreateDataOutput: + description: "" + schema: + properties: + project: + $ref: '#/definitions/ProjectDetails' + type: object + project_ValidateUpdateDataOutput: + description: "" + schema: + properties: + project: + $ref: '#/definitions/ProjectDetails' + type: object + region_CustomizeDeleteOutput: + description: "" + schema: + properties: + region: + $ref: '#/definitions/RegionDetails' + type: object + region_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + region: + $ref: '#/definitions/RegionDetails' + type: object + region_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + region: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + region_GetDetailsMetadataOutput: + description: "" + schema: + properties: + region: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + region_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + region: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + region_GetPropertyDistinctFieldOutput: + description: "" + region_GetPropertySplitableExportOutput: + description: "" + region_GetPropertySplitableOutput: + description: "" + region_GetPropertyTagValuePairsOutput: + description: "" + region_GetPropertyTagValueTreeOutput: + description: "" + region_ListItemFilterOutput: + description: "" + 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: + description: "" + region_PerformPurgeSplitableOutput: + description: "" + region_PerformSetClassMetadataOutput: + description: "" + region_PerformSetOrgMetadataOutput: + description: "" + region_PerformSetUserMetadataOutput: + description: "" + region_ValidateCreateDataOutput: + description: "" + schema: + properties: + region: + $ref: '#/definitions/RegionDetails' + type: object + region_ValidateUpdateDataOutput: + description: "" + schema: + properties: + region: + $ref: '#/definitions/RegionDetails' + type: object + role_CustomizeDeleteOutput: + description: "" + schema: + properties: + role: + $ref: '#/definitions/RoleDetails' + type: object + role_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + role: + $ref: '#/definitions/RoleDetails' + type: object + role_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + role: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + role_GetDetailsMetadataOutput: + description: "" + schema: + properties: + role: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + role_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + role: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + role_GetPropertyDistinctFieldOutput: + description: "" + role_GetPropertyDomainTagValuePairsOutput: + description: "" + role_GetPropertyDomainTagValueTreeOutput: + description: "" + role_GetPropertySplitableExportOutput: + description: "" + role_GetPropertySplitableOutput: + description: "" + role_GetPropertyTagValuePairsOutput: + description: "" + role_GetPropertyTagValueTreeOutput: + description: "" + role_ListItemFilterOutput: + description: "" + 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: + description: "" + role_PerformClassMetadataOutput: + description: "" + role_PerformPrivateOutput: + description: "" + role_PerformPublicOutput: + description: "" + role_PerformPurgeSplitableOutput: + description: "" + role_PerformRemovePolicyOutput: + description: "" + role_PerformSetClassMetadataOutput: + description: "" + role_PerformSetOrgMetadataOutput: + description: "" + role_PerformSetPoliciesOutput: + description: "" + role_PerformSetUserMetadataOutput: + description: "" + role_ValidateCreateDataOutput: + description: "" + schema: + properties: + role: + $ref: '#/definitions/RoleDetails' + type: object + role_ValidateUpdateDataOutput: + description: "" + schema: + properties: + role: + $ref: '#/definitions/RoleDetails' + type: object + role_policy_CustomizeDeleteOutput: + description: "" + schema: + properties: + role_policy: + $ref: '#/definitions/RolePolicyDetails' + type: object + role_policy_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + role_policy: + $ref: '#/definitions/RolePolicyDetails' + type: object + role_policy_GetPropertyDistinctFieldOutput: + description: "" + role_policy_GetPropertySplitableExportOutput: + description: "" + role_policy_GetPropertySplitableOutput: + description: "" + role_policy_ListItemFilterOutput: + description: "" + 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: + description: "" + role_policy_ValidateCreateDataOutput: + description: "" + schema: + properties: + role_policy: + $ref: '#/definitions/RolePolicyDetails' + type: object + role_policy_ValidateUpdateDataOutput: + description: "" + schema: + properties: + role_policy: + $ref: '#/definitions/RolePolicyDetails' + type: object + scope_resource_CustomizeDeleteOutput: + description: "" + schema: + properties: + scope_resource: + $ref: '#/definitions/ModelBaseDetails' + type: object + scope_resource_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scope_resource: + $ref: '#/definitions/ModelBaseDetails' + type: object + scope_resource_GetPropertyDistinctFieldOutput: + description: "" + scope_resource_GetPropertySplitableExportOutput: + description: "" + scope_resource_GetPropertySplitableOutput: + description: "" + scope_resource_ListItemFilterOutput: + description: "" + 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: + description: "" + scope_resource_ValidateCreateDataOutput: + description: "" + schema: + properties: + scope_resource: + $ref: '#/definitions/ModelBaseDetails' + type: object + scope_resource_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scope_resource: + $ref: '#/definitions/ModelBaseDetails' + type: object + service_CustomizeDeleteOutput: + description: "" + schema: + properties: + service: + $ref: '#/definitions/ServiceDetails' + type: object + service_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + service: + $ref: '#/definitions/ServiceDetails' + type: object + service_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_GetDetailsConfigOutput: + description: "" + service_GetDetailsMetadataOutput: + description: "" + schema: + properties: + service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_GetPropertyDistinctFieldOutput: + description: "" + service_GetPropertySplitableExportOutput: + description: "" + service_GetPropertySplitableOutput: + description: "" + service_GetPropertyTagValuePairsOutput: + description: "" + service_GetPropertyTagValueTreeOutput: + description: "" + service_ListItemFilterOutput: + description: "" + 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: + description: "" + service_PerformConfigOutput: + description: "" + service_PerformPurgeSplitableOutput: + description: "" + service_PerformSetClassMetadataOutput: + description: "" + service_PerformSetOrgMetadataOutput: + description: "" + service_PerformSetUserMetadataOutput: + description: "" + service_ValidateCreateDataOutput: + description: "" + schema: + properties: + service: + $ref: '#/definitions/ServiceDetails' + type: object + service_ValidateUpdateDataOutput: + description: "" + schema: + properties: + service: + $ref: '#/definitions/ServiceDetails' + type: object + service_certificate_CustomizeDeleteOutput: + description: "" + schema: + properties: + service_certificate: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + service_certificate_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + service_certificate: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + service_certificate_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + service_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_certificate_GetDetailsMetadataOutput: + description: "" + schema: + properties: + service_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_certificate_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + service_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_certificate_GetPropertyDistinctFieldOutput: + description: "" + service_certificate_GetPropertySplitableExportOutput: + description: "" + service_certificate_GetPropertySplitableOutput: + description: "" + service_certificate_GetPropertyTagValuePairsOutput: + description: "" + service_certificate_GetPropertyTagValueTreeOutput: + description: "" + service_certificate_ListItemFilterOutput: + description: "" + 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: + description: "" + service_certificate_PerformPurgeSplitableOutput: + description: "" + service_certificate_PerformSetClassMetadataOutput: + description: "" + service_certificate_PerformSetOrgMetadataOutput: + description: "" + service_certificate_PerformSetUserMetadataOutput: + description: "" + service_certificate_ValidateCreateDataOutput: + description: "" + schema: + properties: + service_certificate: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + service_certificate_ValidateUpdateDataOutput: + description: "" + schema: + properties: + service_certificate: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + token_cache_CustomizeDeleteOutput: + description: "" + schema: + properties: + token_cache: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + token_cache_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + token_cache: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + token_cache_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + token_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + token_cache_GetDetailsMetadataOutput: + description: "" + schema: + properties: + token_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + token_cache_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + token_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + token_cache_GetPropertyDistinctFieldOutput: + description: "" + token_cache_GetPropertySplitableExportOutput: + description: "" + token_cache_GetPropertySplitableOutput: + description: "" + token_cache_GetPropertyTagValuePairsOutput: + description: "" + token_cache_GetPropertyTagValueTreeOutput: + description: "" + token_cache_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + token_caches: + items: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + token_cache_PerformClassMetadataOutput: + description: "" + token_cache_PerformPurgeSplitableOutput: + description: "" + token_cache_PerformSetClassMetadataOutput: + description: "" + token_cache_PerformSetOrgMetadataOutput: + description: "" + token_cache_PerformSetUserMetadataOutput: + description: "" + token_cache_ValidateCreateDataOutput: + description: "" + schema: + properties: + token_cache: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + token_cache_ValidateUpdateDataOutput: + description: "" + schema: + properties: + token_cache: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + tokens_AuthenticateV2Output: + description: "" + schema: + $ref: '#/definitions/SAuthenticateV2ResponseBody' + tokens_AuthenticateV3Output: + description: "" + headers: + X-Subject-Token: + description: |- + 验证成功的keystone V3 token + in:header + type: string + schema: + $ref: '#/definitions/TokenCredentialV3' + user_CustomizeDeleteOutput: + description: "" + schema: + properties: + user: + $ref: '#/definitions/UserDetails' + type: object + user_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + user: + $ref: '#/definitions/UserDetails' + type: object + user_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + user: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + user_GetDetailsMetadataOutput: + description: "" + schema: + properties: + user: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + user_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + user: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + user_GetPropertyDistinctFieldOutput: + description: "" + user_GetPropertyDomainTagValuePairsOutput: + description: "" + user_GetPropertyDomainTagValueTreeOutput: + description: "" + user_GetPropertySplitableExportOutput: + description: "" + user_GetPropertySplitableOutput: + description: "" + user_GetPropertyTagValuePairsOutput: + description: "" + user_GetPropertyTagValueTreeOutput: + description: "" + user_ListItemFilterOutput: + description: "" + 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: + description: "" + user_PerformDisableOutput: + description: "" + user_PerformEnableOutput: + description: "" + user_PerformJoinOutput: + description: "" + user_PerformLeaveOutput: + description: "" + user_PerformLinkIdpOutput: + description: "" + user_PerformPurgeSplitableOutput: + description: "" + user_PerformResetCredentialsOutput: + description: "" + user_PerformSetClassMetadataOutput: + description: "" + user_PerformSetOrgMetadataOutput: + description: "" + user_PerformSetUserMetadataOutput: + description: "" + user_PerformUnlinkIdpOutput: + description: "" + user_ValidateCreateDataOutput: + description: "" + schema: + properties: + user: + $ref: '#/definitions/UserDetails' + type: object + user_ValidateUpdateDataOutput: + description: "" + schema: + properties: + user: + $ref: '#/definitions/UserDetails' + type: object schemes: -- https -- http + - https + - http securityDefinitions: - keystone: - in: header - name: X-Auth-Token - type: apiKey + keystone: + in: header + name: X-Auth-Token + type: apiKey swagger: "2.0" diff --git a/docs/swagger/swagger_image.yaml b/docs/swagger/swagger_image.yaml index 93ab88b13c..dfaec09c09 100644 --- a/docs/swagger/swagger_image.yaml +++ b/docs/swagger/swagger_image.yaml @@ -1,3365 +1,3601 @@ basePath: / consumes: -- application/json + - application/json definitions: - ChangeOwnerCandidateDomainsOutput: - properties: - candidates: - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: Candidates - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - 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 - GuestImageCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates type: object - x-go-name: Metadata - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disk_format: - description: 镜像格式 - type: string - x-go-name: DiskFormat - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - encrypt_key_alg: - description: 新建密钥算法 - type: string - x-go-name: EncryptKeyAlg - encrypt_key_id: - description: 加密密钥的ID - type: string - x-go-name: EncryptKeyId - encrypt_key_new: - description: 是否新建密钥 - type: boolean - x-go-name: EncryptKeyNew - encrypt_key_user_id: - description: 加密密钥的用户ID - type: string - x-go-name: EncryptKeyUserId - 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 - images: - description: 镜像列表 - items: - $ref: '#/definitions/GuestImageCreateInputSubimage' - type: array - x-go-name: Images - 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: 'description: indicate the resource is a system resource, which - is not visible to user' - 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 - notes: - description: 备注 - type: string - x-go-name: Notes - os_arch: - description: CPU架构 x86_64 or aarch64 - type: string - x-go-name: OsArch - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - properties: - additionalProperties: - type: string - description: 镜像属性 + x-go-package: yunion.io/x/onecloud/pkg/apis + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details type: object - x-go-name: Properties - protected: - description: 是否有删除保护 - type: boolean - x-go-name: Protected - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - size: - description: 镜像大小, 单位Byte - format: int64 - type: integer - x-go-name: Size - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/image - GuestImageCreateInputSubimage: - properties: - disk_format: - description: 磁盘格式 - type: string - x-go-name: DiskFormat - id: - description: Id - type: string - x-go-name: Id - virtual_size: - description: 磁盘大小 - format: int64 - type: integer - x-go-name: VirtualSize - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/image - GuestImageDetails: - 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 - data_images: - items: - $ref: '#/definitions/SubImageInfo' - type: array - x-go-name: DataImages - 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 - disable_delete: - type: boolean - x-go-name: DisableDelete - disk_format: - type: string - x-go-name: DiskFormat - domain_id: - description: 域Id - type: string - x-go-name: DomainId - encrypt_alg: - description: 加密算法，aes-256 or sm4 - type: string - x-go-name: EncryptAlg - encrypt_key: - description: 秘钥名称 - type: string - x-go-name: EncryptKey - encrypt_key_id: - description: 加密密钥ID - type: string - x-go-name: EncryptKeyId - encrypt_key_user: - description: 密钥用户 - type: string - x-go-name: EncryptKeyUser - encrypt_key_user_domain: - description: 密钥用户域 - type: string - x-go-name: EncryptKeyUserDomain - encrypt_key_user_domain_id: - description: 密钥用户域ID - type: string - x-go-name: EncryptKeyUserDomainId - encrypt_key_user_id: - description: 密钥用户ID - type: string - x-go-name: EncryptKeyUserId - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - 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: 标签 + x-go-package: yunion.io/x/onecloud/pkg/httperrors + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status type: object - x-go-name: Metadata - min_ram_mb: - format: int32 - type: integer - x-go-name: MinRamMb - name: - description: 资源名称 - type: string - x-go-name: Name - os_arch: - description: 操作系统 CPU 架构 - example: x86 arm - type: string - x-go-name: OsArch - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - properties: + x-go-package: yunion.io/x/onecloud/pkg/apis + GuestImageCreateInput: + 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 + disk_format: + description: 镜像格式 + type: string + x-go-name: DiskFormat + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + 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 + images: + description: 镜像列表 + items: + $ref: '#/definitions/GuestImageCreateInputSubimage' + type: array + x-go-name: Images + 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: 'description: indicate the resource is a system resource, which is not visible to user' + 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 + notes: + description: 备注 + type: string + x-go-name: Notes + os_arch: + description: CPU架构 x86_64 or aarch64 + type: string + x-go-name: OsArch + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + properties: + additionalProperties: + type: string + description: 镜像属性 + type: object + x-go-name: Properties + protected: + description: 是否有删除保护 + type: boolean + x-go-name: Protected + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + size: + description: 镜像大小, 单位Byte + format: int64 + type: integer + x-go-name: Size + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name type: object - x-go-name: Properties - protected: - type: boolean - x-go-name: Protected - public_scope: - description: 默认共享范围 - type: string - x-go-name: PublicScope - public_src: - description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: PublicSrc - root_image: - $ref: '#/definitions/SubImageInfo' - 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 - size: - description: Status string `json:"status"` - format: int64 - type: integer - x-go-name: Size - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/image - ImageCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/image + GuestImageCreateInputSubimage: + properties: + disk_format: + description: 磁盘格式 + type: string + x-go-name: DiskFormat + id: + description: Id + type: string + x-go-name: Id + virtual_size: + description: 磁盘大小 + format: int64 + type: integer + x-go-name: VirtualSize type: object - x-go-name: Metadata - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disk_format: - description: 镜像格式 - type: string - x-go-name: DiskFormat - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - encrypt_key_alg: - description: 新建密钥算法 - type: string - x-go-name: EncryptKeyAlg - encrypt_key_id: - description: 加密密钥的ID - type: string - x-go-name: EncryptKeyId - encrypt_key_new: - description: 是否新建密钥 - type: boolean - x-go-name: EncryptKeyNew - encrypt_key_user_id: - description: 加密密钥的用户ID - type: string - x-go-name: EncryptKeyUserId - 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_data: - description: 是否是数据盘镜像 - type: boolean - x-go-name: IsData - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - is_guest_image: - description: 是否是主机镜像 - type: boolean - x-go-name: IsGuestImage - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - is_standard: - description: 是否是标准镜像 - type: boolean - x-go-name: IsStandard - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - min_disk: - description: 最小系统盘要求 - format: int32 - type: integer - x-go-name: MinDiskMB - min_ram: - description: 最小内存要求 - format: int32 - type: integer - x-go-name: MinRamMB - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - properties: - additionalProperties: - type: string - description: 镜像属性 + x-go-package: yunion.io/x/onecloud/pkg/apis/image + GuestImageDetails: + 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 + data_images: + items: + $ref: '#/definitions/SubImageInfo' + type: array + x-go-name: DataImages + 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 + disable_delete: + type: boolean + x-go-name: DisableDelete + disk_format: + type: string + x-go-name: DiskFormat + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + 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 + min_ram_mb: + format: int32 + type: integer + x-go-name: MinRamMb + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + properties: + type: object + x-go-name: Properties + protected: + type: boolean + x-go-name: Protected + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + root_image: + $ref: '#/definitions/SubImageInfo' + 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 + size: + description: Status string `json:"status"` + format: int64 + type: integer + x-go-name: Size + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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-name: Properties - protected: - description: 是否有删除保护 - type: boolean - x-go-name: Protected - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - size: - description: 镜像大小, 单位Byte - format: int64 - type: integer - x-go-name: Size - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/image - ImageDetails: - properties: - auto_delete_at: - description: 自动清除时间 - format: date-time - type: string - x-go-name: AutoDeleteAt - 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 - checksum: - description: 校验和 - type: string - x-go-name: Checksum - 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 - disable_delete: - description: 删除保护 - type: boolean - x-go-name: DisableDelete - disk_format: - description: 镜像格式 - type: string - x-go-name: DiskFormat - domain_id: - description: 域Id - type: string - x-go-name: DomainId - encrypt_alg: - description: 加密算法，aes-256 or sm4 - type: string - x-go-name: EncryptAlg - encrypt_key: - description: 秘钥名称 - type: string - x-go-name: EncryptKey - encrypt_key_id: - description: 加密密钥ID - type: string - x-go-name: EncryptKeyId - encrypt_key_user: - description: 密钥用户 - type: string - x-go-name: EncryptKeyUser - encrypt_key_user_domain: - description: 密钥用户域 - type: string - x-go-name: EncryptKeyUserDomain - encrypt_key_user_domain_id: - description: 密钥用户域ID - type: string - x-go-name: EncryptKeyUserDomainId - encrypt_key_user_id: - description: 密钥用户ID - type: string - x-go-name: EncryptKeyUserId - encrypt_status: - description: 加密状态, "",encrypting,encrypted - type: string - x-go-name: EncryptStatus - fast_hash: - type: string - x-go-name: FastHash - freezed: - description: 资源是否被冻结 - type: boolean - x-go-name: Freezed - id: - description: 资源UUID - type: string - x-go-name: Id - is_data: - description: 是否是数据盘镜像 - type: boolean - x-go-name: IsData - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_guest_image: - description: 是否是主机镜像 - type: boolean - x-go-name: IsGuestImage - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - is_standard: - description: 是否是标准镜像 - type: boolean - x-go-name: IsStandard - is_system: - description: 是否是系统资源 - type: boolean - x-go-name: IsSystem - location: - description: 存储地址 - type: string - x-go-name: Location - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/image + ImageCreateInput: + 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 + disk_format: + description: 镜像格式 + type: string + x-go-name: DiskFormat + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + 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_data: + description: 是否是数据盘镜像 + type: boolean + x-go-name: IsData + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_guest_image: + description: 是否是主机镜像 + type: boolean + x-go-name: IsGuestImage + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_standard: + description: 是否是标准镜像 + type: boolean + x-go-name: IsStandard + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + min_disk: + description: 最小系统盘要求 + format: int32 + type: integer + x-go-name: MinDiskMB + min_ram: + description: 最小内存要求 + format: int32 + type: integer + x-go-name: MinRamMB + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + properties: + additionalProperties: + type: string + description: 镜像属性 + type: object + x-go-name: Properties + protected: + description: 是否有删除保护 + type: boolean + x-go-name: Protected + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + size: + description: 镜像大小, 单位Byte + format: int64 + type: integer + x-go-name: Size + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name type: object - x-go-name: Metadata - min_disk: - description: 最小系统盘要求 - format: int32 - type: integer - x-go-name: MinDiskMB - min_ram: - description: 最小内存要求 - format: int32 - type: integer - x-go-name: MinRamMB - name: - description: 资源名称 - type: string - x-go-name: Name - os_arch: - description: 操作系统 CPU 架构 - example: x86 arm - type: string - x-go-name: OsArch - oss_checksum: - description: |- - image copy from url, save origin checksum before probe - 从镜像时长导入的镜像校验和 - type: string - x-go-name: OssChecksum - owner: - description: 用户Id - type: string - x-go-name: Owner - pending_deleted: - description: 资源是否处于回收站中 - type: boolean - x-go-name: PendingDeleted - pending_deleted_at: - description: 资源放入回收站时间 - format: date-time - type: string - x-go-name: PendingDeletedAt - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - project_src: - description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' - example: local - type: string - x-go-name: ProjectSrc - properties: - additionalProperties: - type: string - description: 镜像属性信息 + x-go-package: yunion.io/x/onecloud/pkg/apis/image + ImageDetails: + properties: + auto_delete_at: + description: 自动清除时间 + format: date-time + type: string + x-go-name: AutoDeleteAt + 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 + checksum: + description: 校验和 + type: string + x-go-name: Checksum + 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 + disable_delete: + description: 删除保护 + type: boolean + x-go-name: DisableDelete + disk_format: + description: 镜像格式 + type: string + x-go-name: DiskFormat + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + encrypt_status: + description: 加密状态, "",encrypting,encrypted + type: string + x-go-name: EncryptStatus + fast_hash: + type: string + x-go-name: FastHash + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + is_data: + description: 是否是数据盘镜像 + type: boolean + x-go-name: IsData + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_guest_image: + description: 是否是主机镜像 + type: boolean + x-go-name: IsGuestImage + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_standard: + description: 是否是标准镜像 + type: boolean + x-go-name: IsStandard + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + location: + description: 存储地址 + type: string + x-go-name: Location + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + min_disk: + description: 最小系统盘要求 + format: int32 + type: integer + x-go-name: MinDiskMB + min_ram: + description: 最小内存要求 + format: int32 + type: integer + x-go-name: MinRamMB + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + oss_checksum: + description: |- + image copy from url, save origin checksum before probe + 从镜像时长导入的镜像校验和 + type: string + x-go-name: OssChecksum + owner: + description: 用户Id + type: string + x-go-name: Owner + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + properties: + additionalProperties: + type: string + description: 镜像属性信息 + type: object + x-go-name: Properties + protected: + description: 是否有删除保护 + type: boolean + x-go-name: Protected + 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 + size: + description: 镜像大小, 单位Byte + format: int64 + type: integer + x-go-name: Size + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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-name: Properties - protected: - description: 是否有删除保护 - type: boolean - x-go-name: Protected - 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 - size: - description: 镜像大小, 单位Byte - format: int64 - type: integer - x-go-name: Size - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/image - ImageUpdateStatusInput: - properties: - reason: - description: 更新镜像状态原因 - type: string - x-go-name: Reason - status: - description: 镜像状态 - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/image - PerformChangeProjectOwnerInput: - properties: - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformFreezeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPrivateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformProbeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/image - PerformPublicProjectInput: - 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 - shared_project_ids: - description: 如果共享范围为项目，则在此列表中指定共享的目标项目 - items: - type: string - type: array - x-go-name: SharedProjectIds - 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 - PerformUnfreezeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ProjectStatistic: - properties: - Count: - format: int64 - type: integer - Id: - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PurgeSplitTableInput: - properties: - tables: - items: - type: string - type: array - x-go-name: Tables - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - SImageQuotaDetail: - description: 区域配额详情 - properties: - Image: - format: int64 - type: integer - Type: - type: string - 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 - project: - description: 配额适用的项目名称 - type: string - x-go-name: Project - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - 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/image/models - 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 - SetImageQuotaInput: - description: 设置镜像配额输入参数 - properties: - Image: - format: int64 - type: integer - Type: - type: string - action: - description: |- - 设置配额操作 + x-go-package: yunion.io/x/onecloud/pkg/apis/image + ImageUpdateStatusInput: + properties: + reason: + description: 更新镜像状态原因 + type: string + x-go-name: Reason + status: + description: 镜像状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + PerformChangeProjectOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformFreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformProbeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + PerformPublicProjectInput: + 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 + shared_project_ids: + description: 如果共享范围为项目，则在此列表中指定共享的目标项目 + items: + type: string + type: array + x-go-name: SharedProjectIds + 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 + PerformUnfreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ProjectStatistic: + properties: + Count: + format: int64 + type: integer + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SImageQuotaDetail: + description: 区域配额详情 + properties: + Image: + format: int64 + type: integer + Type: + type: string + 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 + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + 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/image/models + 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 + SetImageQuotaInput: + description: 设置镜像配额输入参数 + properties: + Image: + format: int64 + type: integer + Type: + type: string + 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 - project_id: - description: 配额适用的项目ID - type: string - x-go-name: ProjectId - 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/image/models - SharableVirtualResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - 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 - StatusStatistic: - properties: - TotalCpuCount: - description: CPU总量 - format: int64 - type: integer - TotalDiskSizeMb: - description: 存储总量 - format: int64 - type: integer - TotalMemSizeMb: - description: 内存总量 - format: int64 - type: integer - status_info: + 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 + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + 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/image/models + SharableVirtualResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + 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 + 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 + SubImageInfo: + properties: + created_at: + format: date-time + type: string + x-go-name: CreatedAt + disable_delete: + type: boolean + x-go-name: DisableDelete + disk_format: + type: string + x-go-name: DiskFormat + encrypt_key_id: + type: string + x-go-name: EncryptKeyId + id: + type: string + x-go-name: ID + min_disk_mb: + format: int32 + type: integer + x-go-name: MinDiskMB + name: + type: string + x-go-name: Name + size: + format: int64 + type: integer + x-go-name: Size + status: + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + TTagSet: items: - $ref: '#/definitions/StatusStatisticStatusInfo' + $ref: '#/definitions/STag' 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 - SubImageInfo: - properties: - created_at: - format: date-time - type: string - x-go-name: CreatedAt - disable_delete: - type: boolean - x-go-name: DisableDelete - disk_format: - type: string - x-go-name: DiskFormat - encrypt_key_id: - type: string - x-go-name: EncryptKeyId - id: - type: string - x-go-name: ID - min_disk_mb: - format: int32 - type: integer - x-go-name: MinDiskMB - name: - type: string - x-go-name: Name - size: - format: int64 - type: integer - x-go-name: Size - status: - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/image - 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 + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: + items: + $ref: '#/definitions/TTagSet' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils host: '"127.0.0.1:8889"' info: - contact: - email: lizexi@yunion.cn - name: Zexi Li - description: Image API - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html - version: "1.0" + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Cloudprovider API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" paths: - /guest_images: - get: - description: 列表 - operationId: guest_image_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') - 支持的操作符如下： + /guest_images: + get: + description: 列表 + operationId: guest_image_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: |- - 通过操作系统架构过滤 - x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 - arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 - 其他的输入会过滤出以输入字符开头的资源 - enmu: x86, arm - in: query - name: os_arch - type: string - x-go-name: OsArch - - description: 是否删除保护 - in: query - name: protected - type: boolean - x-go-name: Protected - responses: - "200": - $ref: '#/responses/guest_image_ListItemFilterOutput' - summary: 主机镜像列表 - tags: - - guest_image - post: - description: 新建 - operationId: guest_image_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - guest_image: - $ref: '#/definitions/GuestImageCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_ValidateCreateDataOutput' - summary: 新建 - tags: - - guest_image - /guest_images/{id}: - delete: - description: 删除 - operationId: guest_image_CustomizeDelete - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_image_CustomizeDeleteOutput' - summary: 删除 - tags: - - guest_image - get: - description: 获取详情 - operationId: guest_image_FetchCustomizeColumns - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_image_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - guest_image - put: - description: 更新 - operationId: guest_image_ValidateUpdateData - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_ValidateUpdateDataOutput' - summary: 更新 - tags: - - guest_image - /guest_images/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: guest_image_PerformCancelDelete - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_image_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - guest_image - /guest_images/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: guest_image_PerformChangeOwner - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - guest_image - /guest_images/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: guest_image_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_image_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - guest_image - /guest_images/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: guest_image_GetDetailsClassMetadata - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_image_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - guest_image - post: - description: 执行操作ClassMetadata - operationId: guest_image_PerformClassMetadata - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - guest_image - /guest_images/{id}/freeze: - post: - description: 执行操作Freeze - operationId: guest_image_PerformFreeze - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - guest_image - /guest_images/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: guest_image_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - description: 是否删除保护 + in: query + name: protected + type: boolean + x-go-name: Protected + - in: query + items: + type: string + name: disk_format + type: array + x-go-name: DiskFormat + responses: + "200": + $ref: '#/responses/guest_image_ListItemFilterOutput' + summary: 主机镜像列表 + tags: + - guest_image + post: + description: 新建 + operationId: guest_image_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guest_image: + $ref: '#/definitions/GuestImageCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_ValidateCreateDataOutput' + summary: 新建 + tags: + - guest_image + /guest_images/{id}: + delete: + description: 删除 + operationId: guest_image_CustomizeDelete + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_CustomizeDeleteOutput' + summary: 删除 + tags: + - guest_image + get: + description: 获取详情 + operationId: guest_image_FetchCustomizeColumns + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guest_image + put: + description: 更新 + operationId: guest_image_ValidateUpdateData + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guest_image + /guest_images/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: guest_image_PerformCancelDelete + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - guest_image + /guest_images/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: guest_image_PerformChangeOwner + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - guest_image + /guest_images/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: guest_image_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - guest_image + /guest_images/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: guest_image_GetDetailsClassMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - guest_image + post: + description: 执行操作ClassMetadata + operationId: guest_image_PerformClassMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - guest_image + /guest_images/{id}/freeze: + post: + description: 执行操作Freeze + operationId: guest_image_PerformFreeze + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - guest_image + /guest_images/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: guest_image_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 guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_image_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - guest_image - /guest_images/{id}/private: - post: - description: 执行操作Private - operationId: guest_image_PerformPrivate - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformPrivateOutput' - summary: 执行操作Private - tags: - - guest_image - /guest_images/{id}/public: - post: - description: 执行操作Public - operationId: guest_image_PerformPublic - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformPublicOutput' - summary: 执行操作Public - tags: - - guest_image - /guest_images/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: guest_image_PerformSetClassMetadata - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformSetClassMetadataOutput' - summary: 执行操作SetClassMetadata - tags: - - guest_image - /guest_images/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: guest_image_PerformSetUserMetadata - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - guest_image - /guest_images/{id}/status: - get: - description: 获取指定信息Status - operationId: guest_image_GetDetailsStatus - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/guest_image_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - guest_image - post: - description: 执行操作Status - operationId: guest_image_PerformStatus - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformStatusOutput' - summary: 更新资源状态 - tags: - - guest_image - /guest_images/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: guest_image_PerformUnfreeze - parameters: - - description: The Id or Name of guest_image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - guest_image: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - guest_image - /guest_images/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: guest_image_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/guest_image_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - guest_image - /guest_images/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: guest_image_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/guest_image_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - guest_image - /guest_images/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: guest_image_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/guest_image_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - guest_image - /guest_images/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: guest_image_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/guest_image_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - guest_image - /guest_images/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: guest_image_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/guest_image_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - guest_image - /guest_images/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: guest_image_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - guest_image: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/guest_image_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - guest_image - /guest_images/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: guest_image_GetPropertySplitable - responses: - "200": - $ref: '#/responses/guest_image_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - guest_image - /guest_images/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: guest_image_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/guest_image_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - guest_image - /guest_images/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: guest_image_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/guest_image_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - guest_image - /guest_images/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: guest_image_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/guest_image_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - guest_image - /guest_images/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: guest_image_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/guest_image_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - guest_image - /image_quotas/{scope}: - get: - description: 获取所有项目或者域的镜像配额 - operationId: models_ListImageQuotas - 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/models_ListImageQuotasOutput' - summary: 获取所有项目或者域的镜像配额 - tags: - - image_quota - /image_quotas/{scope}/{scopeId}: - get: - description: 获取指定项目或者域的镜像配额 - operationId: models_GetImageQuota - 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: scopeId - required: true - type: string - x-go-name: ScopeId - - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/models_GetImageQuotaOutput' - summary: 获取指定项目或者域的镜像配额 - tags: - - image_quota - post: - description: 设置指定项目或者域的镜像配额 - operationId: models_SetRegionQuotas - parameters: - - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 - in: path - name: scope - required: true - type: string - x-go-name: Scope - - description: 指定项目或者域的ID - in: path - name: scopeId - required: true - type: string - x-go-name: ScopeId - - in: body - name: body - schema: - properties: - image_quotas: - $ref: '#/definitions/SetImageQuotaInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/models_SetRegionQuotasOutput' - summary: 设置指定项目或者域的镜像配额 - tags: - - image_quota - /images: - get: - description: 列表 - operationId: image_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - guest_image + /guest_images/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: guest_image_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - guest_image + /guest_images/{id}/private: + post: + description: 执行操作Private + operationId: guest_image_PerformPrivate + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformPrivateOutput' + summary: 执行操作Private + tags: + - guest_image + /guest_images/{id}/public: + post: + description: 执行操作Public + operationId: guest_image_PerformPublic + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformPublicOutput' + summary: 执行操作Public + tags: + - guest_image + /guest_images/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: guest_image_PerformSetClassMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformSetClassMetadataOutput' + summary: 执行操作SetClassMetadata + tags: + - guest_image + /guest_images/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: guest_image_PerformSetOrgMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - guest_image + /guest_images/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: guest_image_PerformSetUserMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - guest_image + /guest_images/{id}/status: + get: + description: 获取指定信息Status + operationId: guest_image_GetDetailsStatus + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - guest_image + post: + description: 执行操作Status + operationId: guest_image_PerformStatus + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformStatusOutput' + summary: 更新资源状态 + tags: + - guest_image + /guest_images/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: guest_image_PerformUnfreeze + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - guest_image + /guest_images/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guest_image_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guest_image + /guest_images/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: guest_image_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - guest_image + /guest_images/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: guest_image_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - guest_image + /guest_images/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: guest_image_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - guest_image + /guest_images/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: guest_image_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - guest_image + /guest_images/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guest_image_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guest_image + /guest_images/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guest_image_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guest_image_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guest_image + /guest_images/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guest_image_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/guest_image_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guest_image + /guest_images/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: guest_image_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - guest_image + /guest_images/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: guest_image_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - guest_image + /guest_images/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: guest_image_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - guest_image + /image_quotas/{scope}: + get: + description: 获取所有项目或者域的镜像配额 + operationId: models_ListImageQuotas + 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: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListImageQuotasOutput' + summary: 获取所有项目或者域的镜像配额 + tags: + - image_quota + /image_quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的镜像配额 + operationId: models_GetImageQuota + 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: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + responses: + "200": + $ref: '#/responses/models_GetImageQuotaOutput' + summary: 获取指定项目或者域的镜像配额 + tags: + - image_quota + post: + description: 设置指定项目或者域的镜像配额 + operationId: models_SetRegionQuotas + parameters: + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - in: body + name: body + schema: + properties: + image_quotas: + $ref: '#/definitions/SetImageQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetRegionQuotasOutput' + summary: 设置指定项目或者域的镜像配额 + tags: + - image_quota + /images: + get: + description: 列表 + operationId: image_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: |- - 通过操作系统架构过滤 - x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 - arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 - 其他的输入会过滤出以输入字符开头的资源 - enmu: x86, arm - in: query - name: os_arch - type: string - x-go-name: OsArch - - description: 以镜像的格式过滤，可能值为：qcow2, iso, vmdk, vhd, raw等 - in: query - items: - type: string - name: disk_formats - type: array - x-go-name: DiskFormats - - description: 列出是否支持UEFI启动的镜像 - in: query - name: uefi - type: boolean - x-go-name: Uefi - - description: '根据已转换格式过滤, 可能值为: qcow2, vmdk, vhd, raw等' - in: query - items: - type: string - name: subFormats - type: array - x-go-name: SubFormats - - description: 是否为标准镜像 - in: query - name: is_standard - type: boolean - x-go-name: IsStandard - - description: 是否删除保护 - in: query - name: protected - type: boolean - x-go-name: Protected - - description: 是否为主机镜像的子镜像 - in: query - name: is_guest_image - type: boolean - x-go-name: IsGuestImage - - description: 是否为数据盘 - in: query - name: is_data - type: boolean - x-go-name: IsData - - description: '操作系统类型，可能值为: Linux, Windows, FreeBSD 等' - in: query - items: - type: string - name: os_types - type: array - x-go-name: OsTypes - - description: 操作系统精确匹配 - in: query - name: os_type_precise_match - type: boolean - x-go-name: OsTypePreciseMatch - - description: '操作系统架构, 可能值为: arm, x86 等' - in: query - items: - type: string - name: os_archs - type: array - x-go-name: OsArchs - - description: 操作系统架构精确匹配 - in: query - name: os_arch_precise_match - type: boolean - x-go-name: OsArchPreciseMatch - - description: '发行版本，可能值为: CentOS, Ubuntu, Debian, ArchLinux, OpenEuler 等' - in: query - items: - type: string - name: distributions - type: array - x-go-name: Distributions - - description: 发行版精确匹配 - in: query - name: DistributionPreciseMatch - type: boolean - responses: - "200": - $ref: '#/responses/image_ListItemFilterOutput' - summary: 磁盘镜像列表 - tags: - - image - post: - description: 新建 - operationId: image_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - image: - $ref: '#/definitions/ImageCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_ValidateCreateDataOutput' - summary: 新建 - tags: - - image - /images/{id}: - delete: - description: 删除 - operationId: image_CustomizeDelete - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_CustomizeDeleteOutput' - summary: 删除 - tags: - - image - get: - description: 获取详情 - operationId: image_FetchCustomizeColumns - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - image - put: - description: 更新 - operationId: image_ValidateUpdateData - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_ValidateUpdateDataOutput' - summary: 更新 - tags: - - image - /images/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: image_PerformCancelDelete - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - image - /images/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: image_PerformChangeOwner - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - image - /images/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: image_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - image - /images/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: image_GetDetailsClassMetadata - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - image - post: - description: 执行操作ClassMetadata - operationId: image_PerformClassMetadata - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - image - /images/{id}/freeze: - post: - description: 执行操作Freeze - operationId: image_PerformFreeze - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - image - /images/{id}/mark-standard: - post: - description: 执行操作MarkStandard - operationId: image_PerformMarkStandard - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_PerformMarkStandardOutput' - summary: 执行操作MarkStandard - tags: - - image - /images/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: image_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + items: + type: string + name: os_arch + type: array + x-go-name: OsArch + - description: 以镜像的格式过滤，可能值为：qcow2, iso, vmdk, vhd, raw等 + in: query + items: + type: string + name: disk_formats + type: array + x-go-name: DiskFormats + - description: 列出是否支持UEFI启动的镜像 + in: query + name: uefi + type: boolean + x-go-name: Uefi + - description: '根据已转换格式过滤, 可能值为: qcow2, vmdk, vhd, raw等' + in: query + items: + type: string + name: subFormats + type: array + x-go-name: SubFormats + - description: 是否为标准镜像 + in: query + name: is_standard + type: boolean + x-go-name: IsStandard + - description: 是否删除保护 + in: query + name: protected + type: boolean + x-go-name: Protected + - description: 是否为主机镜像的子镜像 + in: query + name: is_guest_image + type: boolean + x-go-name: IsGuestImage + - description: 是否为数据盘 + in: query + name: is_data + type: boolean + x-go-name: IsData + - description: '操作系统类型，可能值为: Linux, Windows, FreeBSD 等' + in: query + items: + type: string + name: os_types + type: array + x-go-name: OsTypes + - description: 操作系统精确匹配 + in: query + name: os_type_precise_match + type: boolean + x-go-name: OsTypePreciseMatch + - description: '操作系统架构, 可能值为: arm, x86 等' + in: query + items: + type: string + name: os_archs + type: array + x-go-name: OsArchs + - description: 操作系统架构精确匹配 + in: query + name: os_arch_precise_match + type: boolean + x-go-name: OsArchPreciseMatch + - description: '发行版本，可能值为: CentOS, Ubuntu, Debian, ArchLinux, OpenEuler 等' + in: query + items: + type: string + name: distributions + type: array + x-go-name: Distributions + - description: 发行版精确匹配 + in: query + name: DistributionPreciseMatch + type: boolean + responses: + "200": + $ref: '#/responses/image_ListItemFilterOutput' + summary: 磁盘镜像列表 + tags: + - image + post: + description: 新建 + operationId: image_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + image: + $ref: '#/definitions/ImageCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_ValidateCreateDataOutput' + summary: 新建 + tags: + - image + /images/{id}: + delete: + description: 删除 + operationId: image_CustomizeDelete + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_CustomizeDeleteOutput' + summary: 删除 + tags: + - image + get: + description: 获取详情 + operationId: image_FetchCustomizeColumns + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - image + put: + description: 更新 + operationId: image_ValidateUpdateData + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_ValidateUpdateDataOutput' + summary: 更新 + tags: + - image + /images/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: image_PerformCancelDelete + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - image + /images/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: image_PerformChangeOwner + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - image + /images/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: image_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - image + /images/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: image_GetDetailsClassMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - image + post: + description: 执行操作ClassMetadata + operationId: image_PerformClassMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - image + /images/{id}/freeze: + post: + description: 执行操作Freeze + operationId: image_PerformFreeze + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - image + /images/{id}/mark-standard: + post: + description: 执行操作MarkStandard + operationId: image_PerformMarkStandard + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_PerformMarkStandardOutput' + summary: 执行操作MarkStandard + tags: + - image + /images/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: image_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 image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - image - /images/{id}/private: - post: - description: 执行操作Private - operationId: image_PerformPrivate - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformPrivateOutput' - summary: 执行操作Private - tags: - - image - /images/{id}/probe: - post: - description: 执行操作Probe - operationId: image_PerformProbe - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - $ref: '#/definitions/PerformProbeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformProbeOutput' - summary: 执行操作Probe - tags: - - image - /images/{id}/public: - post: - description: 执行操作Public - operationId: image_PerformPublic - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformPublicOutput' - summary: 执行操作Public - tags: - - image - /images/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: image_PerformSetClassMetadata - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformSetClassMetadataOutput' - summary: 执行操作SetClassMetadata - tags: - - image - /images/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: image_PerformSetUserMetadata - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - image - /images/{id}/status: - get: - description: 获取指定信息Status - operationId: image_GetDetailsStatus - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - image - post: - description: 执行操作Status - operationId: image_PerformStatus - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformStatusOutput' - summary: 更新资源状态 - tags: - - image - /images/{id}/subformats: - get: - description: 获取指定信息Subformats - operationId: image_GetDetailsSubformats - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_GetDetailsSubformatsOutput' - summary: 获取指定信息Subformats - tags: - - image - /images/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: image_PerformUnfreeze - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - image - /images/{id}/update-status: - post: - description: 执行操作UpdateStatus - operationId: image_PerformUpdateStatus - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - image: - $ref: '#/definitions/ImageUpdateStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformUpdateStatusOutput' - summary: 执行操作UpdateStatus - tags: - - image - /images/{id}/update-torrent-status: - post: - description: 执行操作UpdateTorrentStatus - operationId: image_PerformUpdateTorrentStatus - parameters: - - description: The Id or Name of image - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/image_PerformUpdateTorrentStatusOutput' - summary: 执行操作UpdateTorrentStatus - tags: - - image - /images/detail: - get: - description: 获取指定资源类的信息Detail - operationId: image_GetPropertyDetail - responses: - "200": - $ref: '#/responses/image_GetPropertyDetailOutput' - summary: 获取指定资源类的信息Detail - tags: - - image - /images/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: image_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/image_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - image - /images/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: image_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/image_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - image - /images/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: image_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/image_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - image - /images/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: image_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/image_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - image - /images/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: image_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/image_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - image - /images/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: image_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - image: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/image_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - image - /images/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: image_GetPropertySplitable - responses: - "200": - $ref: '#/responses/image_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - image - /images/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: image_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/image_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - image - /images/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: image_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/image_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - image - /images/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: image_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/image_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - image - /images/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: image_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/image_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - image + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - image + /images/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: image_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - image + /images/{id}/private: + post: + description: 执行操作Private + operationId: image_PerformPrivate + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformPrivateOutput' + summary: 执行操作Private + tags: + - image + /images/{id}/probe: + post: + description: 执行操作Probe + operationId: image_PerformProbe + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformProbeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformProbeOutput' + summary: 执行操作Probe + tags: + - image + /images/{id}/public: + post: + description: 执行操作Public + operationId: image_PerformPublic + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformPublicOutput' + summary: 执行操作Public + tags: + - image + /images/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: image_PerformSetClassMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformSetClassMetadataOutput' + summary: 执行操作SetClassMetadata + tags: + - image + /images/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: image_PerformSetOrgMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - image + /images/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: image_PerformSetUserMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - image + /images/{id}/status: + get: + description: 获取指定信息Status + operationId: image_GetDetailsStatus + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - image + post: + description: 执行操作Status + operationId: image_PerformStatus + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformStatusOutput' + summary: 更新资源状态 + tags: + - image + /images/{id}/subformats: + get: + description: 获取指定信息Subformats + operationId: image_GetDetailsSubformats + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsSubformatsOutput' + summary: 获取指定信息Subformats + tags: + - image + /images/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: image_PerformUnfreeze + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - image + /images/{id}/update-status: + post: + description: 执行操作UpdateStatus + operationId: image_PerformUpdateStatus + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/ImageUpdateStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformUpdateStatusOutput' + summary: 执行操作UpdateStatus + tags: + - image + /images/{id}/update-torrent-status: + post: + description: 执行操作UpdateTorrentStatus + operationId: image_PerformUpdateTorrentStatus + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_PerformUpdateTorrentStatusOutput' + summary: 执行操作UpdateTorrentStatus + tags: + - image + /images/detail: + get: + description: 获取指定资源类的信息Detail + operationId: image_GetPropertyDetail + responses: + "200": + $ref: '#/responses/image_GetPropertyDetailOutput' + summary: 获取指定资源类的信息Detail + tags: + - image + /images/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: image_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/image_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - image + /images/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: image_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/image_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - image + /images/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: image_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/image_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - image + /images/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: image_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/image_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - image + /images/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: image_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/image_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - image + /images/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: image_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - image + /images/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: image_GetPropertySplitable + responses: + "200": + $ref: '#/responses/image_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - image + /images/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: image_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/image_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - image + /images/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: image_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/image_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - image + /images/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: image_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/image_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - image + /images/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: image_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/image_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - image + /images/vmware-account-added: + post: + description: 执行操作VmwareAccountAdded + operationId: image_PerformVmwareAccountAdded + parameters: + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformVmwareAccountAddedOutput' + summary: 执行操作VmwareAccountAdded + tags: + - image produces: -- application/json + - application/json responses: - guest_image_CustomizeDeleteOutput: - schema: - properties: - guest_image: - $ref: '#/definitions/GuestImageDetails' - type: object - guest_image_FetchCustomizeColumnsOutput: - schema: - properties: - guest_image: - $ref: '#/definitions/GuestImageDetails' - type: object - guest_image_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - guest_image: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - guest_image_GetDetailsClassMetadataOutput: - schema: - properties: - guest_image: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - guest_image_GetDetailsMetadataOutput: - schema: - properties: - guest_image: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - guest_image_GetDetailsStatusOutput: - schema: - properties: - guest_image: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - guest_image_GetPropertyDistinctFieldOutput: {} - guest_image_GetPropertyDomainStatisticsOutput: - schema: - properties: - guest_image: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - guest_image_GetPropertyProjectStatisticsOutput: - schema: - properties: - guest_image: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - guest_image_GetPropertyProjectTagValuePairsOutput: {} - guest_image_GetPropertyProjectTagValueTreeOutput: {} - guest_image_GetPropertySplitableExportOutput: {} - guest_image_GetPropertySplitableOutput: {} - guest_image_GetPropertyStatisticsOutput: - schema: - properties: - guest_image: - $ref: '#/definitions/StatusStatistic' - type: object - guest_image_GetPropertyTagValuePairsOutput: {} - guest_image_GetPropertyTagValueTreeOutput: {} - guest_image_ListItemFilterOutput: - schema: - properties: - guest_images: - items: - $ref: '#/definitions/GuestImageDetails' - 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 - guest_image_PerformCancelDeleteOutput: {} - guest_image_PerformChangeOwnerOutput: {} - guest_image_PerformClassMetadataOutput: {} - guest_image_PerformFreezeOutput: {} - guest_image_PerformPrivateOutput: {} - guest_image_PerformPublicOutput: {} - guest_image_PerformPurgeSplitableOutput: {} - guest_image_PerformSetClassMetadataOutput: {} - guest_image_PerformSetUserMetadataOutput: {} - guest_image_PerformStatusOutput: {} - guest_image_PerformUnfreezeOutput: {} - guest_image_ValidateCreateDataOutput: - schema: - properties: - guest_image: - $ref: '#/definitions/GuestImageDetails' - type: object - guest_image_ValidateUpdateDataOutput: - schema: - properties: - guest_image: - $ref: '#/definitions/GuestImageDetails' - type: object - image_CustomizeDeleteOutput: - schema: - properties: - image: - $ref: '#/definitions/ImageDetails' - type: object - image_FetchCustomizeColumnsOutput: - schema: - properties: - image: - $ref: '#/definitions/ImageDetails' - type: object - image_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - image: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - image_GetDetailsClassMetadataOutput: - schema: - properties: - image: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - image_GetDetailsMetadataOutput: - schema: - properties: - image: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - image_GetDetailsStatusOutput: - schema: - properties: - image: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - image_GetDetailsSubformatsOutput: {} - image_GetPropertyDetailOutput: {} - image_GetPropertyDistinctFieldOutput: {} - image_GetPropertyDomainStatisticsOutput: - schema: - properties: - image: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - image_GetPropertyProjectStatisticsOutput: - schema: - properties: - image: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - image_GetPropertyProjectTagValuePairsOutput: {} - image_GetPropertyProjectTagValueTreeOutput: {} - image_GetPropertySplitableExportOutput: {} - image_GetPropertySplitableOutput: {} - image_GetPropertyStatisticsOutput: - schema: - properties: - image: - $ref: '#/definitions/StatusStatistic' - type: object - image_GetPropertyTagValuePairsOutput: {} - image_GetPropertyTagValueTreeOutput: {} - image_ListItemFilterOutput: - schema: - properties: - images: - items: - $ref: '#/definitions/ImageDetails' - 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 - image_PerformCancelDeleteOutput: {} - image_PerformChangeOwnerOutput: {} - image_PerformClassMetadataOutput: {} - image_PerformFreezeOutput: {} - image_PerformMarkStandardOutput: {} - image_PerformPrivateOutput: {} - image_PerformProbeOutput: {} - image_PerformPublicOutput: {} - image_PerformPurgeSplitableOutput: {} - image_PerformSetClassMetadataOutput: {} - image_PerformSetUserMetadataOutput: {} - image_PerformStatusOutput: {} - image_PerformUnfreezeOutput: {} - image_PerformUpdateStatusOutput: {} - image_PerformUpdateTorrentStatusOutput: {} - image_ValidateCreateDataOutput: - schema: - properties: - image: - $ref: '#/definitions/ImageDetails' - type: object - image_ValidateUpdateDataOutput: - schema: - properties: - image: - $ref: '#/definitions/ImageDetails' - type: object - models_GetImageQuotaOutput: - schema: - properties: - image_quotas: - items: - $ref: '#/definitions/SImageQuotaDetail' - type: array - x-go-name: Output - type: object - models_ListImageQuotasOutput: - schema: - properties: - image_quotas: - items: - $ref: '#/definitions/SImageQuotaDetail' - type: array - x-go-name: Output - type: object - models_SetRegionQuotasOutput: - schema: - properties: - image_quotas: - items: - $ref: '#/definitions/SImageQuotaDetail' - type: array - x-go-name: Output - type: object + guest_image_CustomizeDeleteOutput: + description: "" + schema: + properties: + guest_image: + $ref: '#/definitions/GuestImageDetails' + type: object + guest_image_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + guest_image: + $ref: '#/definitions/GuestImageDetails' + type: object + guest_image_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + guest_image: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + guest_image_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_image_GetDetailsMetadataOutput: + description: "" + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_image_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_image_GetDetailsStatusOutput: + description: "" + schema: + properties: + guest_image: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + guest_image_GetPropertyDistinctFieldOutput: + description: "" + guest_image_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + guest_image: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + guest_image_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + guest_image: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + guest_image_GetPropertyProjectTagValuePairsOutput: + description: "" + guest_image_GetPropertyProjectTagValueTreeOutput: + description: "" + guest_image_GetPropertySplitableExportOutput: + description: "" + guest_image_GetPropertySplitableOutput: + description: "" + guest_image_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + guest_image: + $ref: '#/definitions/StatusStatistic' + type: object + guest_image_GetPropertyTagValuePairsOutput: + description: "" + guest_image_GetPropertyTagValueTreeOutput: + description: "" + guest_image_ListItemFilterOutput: + description: "" + schema: + properties: + guest_images: + items: + $ref: '#/definitions/GuestImageDetails' + 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 + guest_image_PerformCancelDeleteOutput: + description: "" + guest_image_PerformChangeOwnerOutput: + description: "" + guest_image_PerformClassMetadataOutput: + description: "" + guest_image_PerformFreezeOutput: + description: "" + guest_image_PerformPrivateOutput: + description: "" + guest_image_PerformPublicOutput: + description: "" + guest_image_PerformPurgeSplitableOutput: + description: "" + guest_image_PerformSetClassMetadataOutput: + description: "" + guest_image_PerformSetOrgMetadataOutput: + description: "" + guest_image_PerformSetUserMetadataOutput: + description: "" + guest_image_PerformStatusOutput: + description: "" + guest_image_PerformUnfreezeOutput: + description: "" + guest_image_ValidateCreateDataOutput: + description: "" + schema: + properties: + guest_image: + $ref: '#/definitions/GuestImageDetails' + type: object + guest_image_ValidateUpdateDataOutput: + description: "" + schema: + properties: + guest_image: + $ref: '#/definitions/GuestImageDetails' + type: object + image_CustomizeDeleteOutput: + description: "" + schema: + properties: + image: + $ref: '#/definitions/ImageDetails' + type: object + image_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + image: + $ref: '#/definitions/ImageDetails' + type: object + image_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + image: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + image_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + image_GetDetailsMetadataOutput: + description: "" + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + image_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + image_GetDetailsStatusOutput: + description: "" + schema: + properties: + image: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + image_GetDetailsSubformatsOutput: + description: "" + image_GetPropertyDetailOutput: + description: "" + image_GetPropertyDistinctFieldOutput: + description: "" + image_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + image: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + image_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + image: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + image_GetPropertyProjectTagValuePairsOutput: + description: "" + image_GetPropertyProjectTagValueTreeOutput: + description: "" + image_GetPropertySplitableExportOutput: + description: "" + image_GetPropertySplitableOutput: + description: "" + image_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + image: + $ref: '#/definitions/StatusStatistic' + type: object + image_GetPropertyTagValuePairsOutput: + description: "" + image_GetPropertyTagValueTreeOutput: + description: "" + image_ListItemFilterOutput: + description: "" + schema: + properties: + images: + items: + $ref: '#/definitions/ImageDetails' + 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 + image_PerformCancelDeleteOutput: + description: "" + image_PerformChangeOwnerOutput: + description: "" + image_PerformClassMetadataOutput: + description: "" + image_PerformFreezeOutput: + description: "" + image_PerformMarkStandardOutput: + description: "" + image_PerformPrivateOutput: + description: "" + image_PerformProbeOutput: + description: "" + image_PerformPublicOutput: + description: "" + image_PerformPurgeSplitableOutput: + description: "" + image_PerformSetClassMetadataOutput: + description: "" + image_PerformSetOrgMetadataOutput: + description: "" + image_PerformSetUserMetadataOutput: + description: "" + image_PerformStatusOutput: + description: "" + image_PerformUnfreezeOutput: + description: "" + image_PerformUpdateStatusOutput: + description: "" + image_PerformUpdateTorrentStatusOutput: + description: "" + image_PerformVmwareAccountAddedOutput: + description: "" + image_ValidateCreateDataOutput: + description: "" + schema: + properties: + image: + $ref: '#/definitions/ImageDetails' + type: object + image_ValidateUpdateDataOutput: + description: "" + schema: + properties: + image: + $ref: '#/definitions/ImageDetails' + type: object + models_GetImageQuotaOutput: + description: "" + schema: + properties: + image_quotas: + items: + $ref: '#/definitions/SImageQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListImageQuotasOutput: + description: "" + schema: + properties: + image_quotas: + items: + $ref: '#/definitions/SImageQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetRegionQuotasOutput: + description: "" + schema: + properties: + image_quotas: + items: + $ref: '#/definitions/SImageQuotaDetail' + type: array + x-go-name: Output + type: object schemes: -- https -- http + - https + - http securityDefinitions: - keystone: - in: header - name: X-Auth-Token - type: apiKey + keystone: + in: header + name: X-Auth-Token + type: apiKey swagger: "2.0" diff --git a/docs/swagger/swagger_monitor.yaml b/docs/swagger/swagger_monitor.yaml index 5288d1e925..d5f51fcc72 100644 --- a/docs/swagger/swagger_monitor.yaml +++ b/docs/swagger/swagger_monitor.yaml @@ -1,18172 +1,19655 @@ basePath: / consumes: -- application/json + - application/json definitions: - AlertCloneDashboardInput: - properties: - clone_name: - type: string - x-go-name: CloneName - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertClonePanelInput: - properties: - clone_panel_name: - type: string - x-go-name: ClonePanelName - panel_id: - type: string - x-go-name: PanelId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertCondition: - properties: - evaluator: - $ref: '#/definitions/Condition' - operator: - type: string - x-go-name: Operator - query: - $ref: '#/definitions/AlertQuery' - reducer: - $ref: '#/definitions/Condition' - type: - type: string - x-go-name: Type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertCreateInput: - properties: - customize_config: - description: customize info + AlertCloneDashboardInput: + properties: + clone_name: + type: string + x-go-name: CloneName type: object - x-go-name: CustomizeConfig - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - level: - description: 报警级别 - type: string - x-go-name: Level - name: - description: 报警名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - settings: - $ref: '#/definitions/AlertSetting' - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertDashBoardCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertClonePanelInput: + properties: + clone_panel_name: + type: string + x-go-name: ClonePanelName + panel_id: + type: string + x-go-name: PanelId 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 - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - refresh: - type: string - x-go-name: Refresh - scope: - type: string - x-go-name: Scope - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertDashBoardDetails: - properties: - alert_panel_details: - items: - $ref: '#/definitions/AlertPanelDetail' - type: array - x-go-name: AlertPanelDetails - 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 - customize_config: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertCondition: + properties: + evaluator: + $ref: '#/definitions/Condition' + operator: + type: string + x-go-name: Operator + query: + $ref: '#/definitions/AlertQuery' + reducer: + $ref: '#/definitions/Condition' + type: + type: string + x-go-name: Type type: object - x-go-name: CustomizeConfig - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertCreateInput: + properties: + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + settings: + $ref: '#/definitions/AlertSetting' + used_by: + type: string + x-go-name: UsedBy type: object - x-go-name: EvalData - execution_error: - description: Silenced bool - type: string - x-go-name: ExecutionError - execution_error_state: - type: string - x-go-name: ExecutionErrorState - for: - description: |- - If an alert rule has a configured `For` and the query violates the configured threshold - it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any - notifications. Once the alert rule has been firing for more than `For` duration, it will - change to `Alerting` and send alert notifications. - format: int64 - type: integer - x-go-name: For - frequency: - description: Frequency is evaluate period - format: int64 - type: integer - x-go-name: Frequency - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - last_state_change: - format: date-time - type: string - x-go-name: LastStateChange - level: - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertDashBoardCreateInput: + 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 + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + refresh: + type: string + x-go-name: Refresh + scope: + type: string + x-go-name: Scope + required: + - name type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - type: string - x-go-name: NoDataState - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - res_type: - type: string - x-go-name: ResType - scope: - type: string - x-go-name: Scope - settings: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertDashBoardDetails: + properties: + alert_panel_details: + items: + $ref: '#/definitions/AlertPanelDetail' + type: array + x-go-name: AlertPanelDetails + 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 + customize_config: + type: object + x-go-name: CustomizeConfig + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + used_by: + type: string + x-go-name: UsedBy type: object - x-go-name: Settings - state: - type: string - x-go-name: State - state_changes: - format: int64 - type: integer - x-go-name: StateChanges - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertDetails: - 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 - customize_config: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertDetails: + 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 + customize_config: + type: object + x-go-name: CustomizeConfig + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + used_by: + type: string + x-go-name: UsedBy type: object - x-go-name: CustomizeConfig - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertPanelCreateInput: + properties: + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + dashboard_id: + type: string + x-go-name: DashboardId + domain_tags: + $ref: '#/definitions/TTagSetList' + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + from: + type: string + x-go-name: From + interval: + type: string + x-go-name: Interval + level: + description: 报警级别 + type: string + x-go-name: Level + metric_query: + items: + $ref: '#/definitions/CommonAlertQuery' + type: array + x-go-name: MetricQuery + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + no_domain_tags: + $ref: '#/definitions/TTagSetList' + no_project_tags: + $ref: '#/definitions/TTagSetList' + order_by_domain: + description: 按domain名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByDomain + order_by_project: + description: 按project名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByProject + policy_project_tags: + $ref: '#/definitions/TTagSetList' + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_domain_ids: + description: 对具有域属性的资源，严格匹配域ID + items: + type: string + type: array + x-go-name: ProjectDomainIds + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_ids: + description: 对具有项目属性的资源，严格匹配项目ID + items: + type: string + type: array + x-go-name: ProjectIds + project_organizations: + description: filter by project organizations + items: + type: string + type: array + x-go-name: ProjectOrganizations + project_tags: + $ref: '#/definitions/TTagSetList' + refresh: + type: string + x-go-name: Refresh + scope: + description: 指定查询的权限范围，可能值为project, domain or system + type: string + x-go-name: Scope + settings: + $ref: '#/definitions/AlertSetting' + to: + type: string + x-go-name: To + used_by: + type: string + x-go-name: UsedBy type: object - x-go-name: EvalData - execution_error: - description: Silenced bool - type: string - x-go-name: ExecutionError - execution_error_state: - type: string - x-go-name: ExecutionErrorState - for: - description: |- - If an alert rule has a configured `For` and the query violates the configured threshold - it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any - notifications. Once the alert rule has been firing for more than `For` duration, it will - change to `Alerting` and send alert notifications. - format: int64 - type: integer - x-go-name: For - frequency: - description: Frequency is evaluate period - format: int64 - type: integer - x-go-name: Frequency - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - last_state_change: - format: date-time - type: string - x-go-name: LastStateChange - level: - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertPanelDetail: + properties: + Setting: + type: object + 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 + common_alert_metric_details: + items: + $ref: '#/definitions/CommonAlertMetricDetails' + type: array + x-go-name: CommonAlertMetricDetails + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + panel_id: + type: string + x-go-name: PanelId + panel_name: + type: string + x-go-name: PanelName + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + refresh: + type: string + x-go-name: Refresh + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + used_by: + type: string + x-go-name: UsedBy type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - type: string - x-go-name: NoDataState - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - res_type: - type: string - x-go-name: ResType - scope: - type: string - x-go-name: Scope - settings: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertPauseInput: + properties: + paused: + type: boolean + x-go-name: Paused type: object - x-go-name: Settings - state: - type: string - x-go-name: State - state_changes: - format: int64 - type: integer - x-go-name: StateChanges - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertPanelCreateInput: - properties: - customize_config: - description: customize info + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertQuery: + properties: + from: + type: string + x-go-name: From + model: + $ref: '#/definitions/MetricQuery' + to: + type: string + x-go-name: To type: object - x-go-name: CustomizeConfig - dashboard_id: - type: string - x-go-name: DashboardId - domain_tags: - $ref: '#/definitions/TTagSetList' - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - from: - type: string - x-go-name: From - interval: - type: string - x-go-name: Interval - level: - description: 报警级别 - type: string - x-go-name: Level - metric_query: - items: - $ref: '#/definitions/CommonAlertQuery' - type: array - x-go-name: MetricQuery - name: - description: 报警名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - no_domain_tags: - $ref: '#/definitions/TTagSetList' - no_project_tags: - $ref: '#/definitions/TTagSetList' - order_by_domain: - description: 按domain名称排序，可能值为asc|desc - pattern: asc|desc - type: string - x-go-name: OrderByDomain - order_by_project: - description: 按project名称排序，可能值为asc|desc - pattern: asc|desc - type: string - x-go-name: OrderByProject - policy_project_tags: - $ref: '#/definitions/TTagSetList' - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_domain_ids: - description: 对具有域属性的资源，严格匹配域ID - items: - type: string - type: array - x-go-name: ProjectDomainIds - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - project_ids: - description: 对具有项目属性的资源，严格匹配项目ID - items: - type: string - type: array - x-go-name: ProjectIds - project_tags: - $ref: '#/definitions/TTagSetList' - refresh: - type: string - x-go-name: Refresh - scope: - description: 指定查询的权限范围，可能值为project, domain or system - type: string - x-go-name: Scope - settings: - $ref: '#/definitions/AlertSetting' - to: - type: string - x-go-name: To - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertPanelDetail: - properties: - Setting: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + AlertRule: + $ref: '#/definitions/AlertRecordRule' + alert_id: + type: string + x-go-name: AlertId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + eval_data: + items: + $ref: '#/definitions/EvalMatch' + type: array + x-go-name: EvalData + 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 + level: + description: 报警级别 + type: string + x-go-name: Level + 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 + res_type: + type: string + x-go-name: ResType + send_state: + type: string + x-go-name: SendState + state: + type: string + x-go-name: State + required: + - name type: object - 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 - common_alert_metric_details: - items: - $ref: '#/definitions/CommonAlertMetricDetails' - type: array - x-go-name: CommonAlertMetricDetails - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - customize_config: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordDetails: + properties: + TriggerTime: + format: date-time + type: string + alert_id: + type: string + x-go-name: AlertId + alert_name: + type: string + x-go-name: AlertName + alert_rule: + type: object + x-go-name: AlertRule + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + level: + type: string + x-go-name: Level + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + res_num: + format: int64 + type: integer + x-go-name: ResNum + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + send_state: + type: string + x-go-name: SendState + state: + type: string + x-go-name: State + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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-name: CustomizeConfig - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordRule: + properties: + alert_duration: + format: int64 + type: integer + x-go-name: AlertDuration + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + condition_type: + type: string + x-go-name: ConditionType + database: + type: string + x-go-name: Database + field: + type: string + x-go-name: Field + field_desc: + type: string + x-go-name: FieldDesc + measurement: + type: string + x-go-name: Measurement + measurement_desc: + type: string + x-go-name: MeasurementDesc + metric: + type: string + x-go-name: Metric + period: + type: string + x-go-name: Period + res_type: + type: string + x-go-name: ResType + silent_period: + description: 静默期 + type: string + x-go-name: SilentPeriod + threshold: + description: 报警阀值 + type: string + x-go-name: Threshold type: object - x-go-name: EvalData - execution_error: - description: Silenced bool - type: string - x-go-name: ExecutionError - execution_error_state: - type: string - x-go-name: ExecutionErrorState - for: - description: |- - If an alert rule has a configured `For` and the query violates the configured threshold - it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any - notifications. Once the alert rule has been firing for more than `For` duration, it will - change to `Alerting` and send alert notifications. - format: int64 - type: integer - x-go-name: For - frequency: - description: Frequency is evaluate period - format: int64 - type: integer - x-go-name: Frequency - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - last_state_change: - format: date-time - type: string - x-go-name: LastStateChange - level: - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordShieldCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + alert_id: + type: string + x-go-name: AlertId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + end_time: + type: string + x-go-name: EndTime + 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 + res_id: + type: string + x-go-name: ResId + res_name: + type: string + x-go-name: ResName + res_type: + type: string + x-go-name: ResType + start_time: + type: string + x-go-name: StartTime + required: + - name type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - type: string - x-go-name: NoDataState - panel_id: - type: string - x-go-name: PanelId - panel_name: - type: string - x-go-name: PanelName - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - refresh: - type: string - x-go-name: Refresh - res_type: - type: string - x-go-name: ResType - scope: - type: string - x-go-name: Scope - settings: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordShieldDetails: + properties: + alert_duration: + description: 报警连续持续周期数 + format: int64 + type: integer + x-go-name: AlertDuration + alert_name: + type: string + x-go-name: AlertName + alert_type: + description: 报警类型 + type: string + x-go-name: AlertType + 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 + channel: + items: + type: string + type: array + x-go-name: Channel + common_alert_metric_details: + items: + $ref: '#/definitions/CommonAlertMetricDetails' + type: array + x-go-name: CommonAlertMetricDetails + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + expired: + type: boolean + x-go-name: Expired + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + recipients: + items: + type: string + type: array + x-go-name: Recipients + res_name: + type: string + x-go-name: ResName + res_type: + type: string + x-go-name: ResType + robot_ids: + items: + type: string + type: array + x-go-name: RobotIds + role_ids: + items: + type: string + type: array + x-go-name: RoleIds + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + silent_period: + description: 静默期 + type: string + x-go-name: SilentPeriod + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + used_by: + type: string + x-go-name: UsedBy type: object - x-go-name: Settings - state: - type: string - x-go-name: State - state_changes: - format: int64 - type: integer - x-go-name: StateChanges - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertPauseInput: - properties: - paused: - type: boolean - x-go-name: Paused - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertQuery: - properties: - data_source_id: - type: string - x-go-name: DataSourceId - from: - type: string - x-go-name: From - model: - $ref: '#/definitions/MetricQuery' - to: - type: string - x-go-name: To - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertRecordCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertResourceDetails: + 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 + count: + format: int64 + type: integer + x-go-name: Count + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + tags: + additionalProperties: + type: string + type: object + x-go-name: Tags + update_fail_reason: + $ref: '#/definitions/Error' type: object - x-go-name: Metadata - AlertRule: - $ref: '#/definitions/AlertRecordRule' - alert_id: - type: string - x-go-name: AlertId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - eval_data: - items: - $ref: '#/definitions/EvalMatch' - type: array - x-go-name: EvalData - 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 - level: - description: 报警级别 - type: string - x-go-name: Level - 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 - res_type: - type: string - x-go-name: ResType - send_state: - type: string - x-go-name: SendState - state: - type: string - x-go-name: State - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertRecordDetails: - properties: - TriggerTime: - format: date-time - type: string - alert_id: - type: string - x-go-name: AlertId - alert_name: - type: string - x-go-name: AlertName - alert_rule: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertSetting: + description: AlertSettings contains alert conditions + properties: + conditions: + items: + $ref: '#/definitions/AlertCondition' + type: array + x-go-name: Conditions type: object - x-go-name: AlertRule - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertTestRunInput: + properties: + is_debug: + type: boolean + x-go-name: IsDebug type: object - x-go-name: EvalData - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - level: - type: string - x-go-name: Level - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertTestRunOutput: + properties: + alert_ok_eval_matches: + items: + $ref: '#/definitions/EvalMatch' + type: array + x-go-name: AlertOKEvalMatches + condition_evals: + type: string + x-go-name: ConditionEvals + end_time: + format: date-time + type: string + x-go-name: EndTime + error: + type: string + x-go-name: Error + eval_matches: + items: + $ref: '#/definitions/EvalMatch' + type: array + x-go-name: EvalMatches + firing: + type: boolean + x-go-name: Firing + is_debug: + type: boolean + x-go-name: IsDebug + is_test_run: + type: boolean + x-go-name: IsTestRun + logs: + items: + $ref: '#/definitions/ResultLogEntry' + type: array + x-go-name: Logs + no_data_found: + type: boolean + x-go-name: NoDataFound + prev_alert_state: + type: string + x-go-name: PrevAlertState + start_time: + format: date-time + type: string + x-go-name: StartTime type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - res_num: - format: int64 - type: integer - x-go-name: ResNum - res_type: - type: string - x-go-name: ResType - scope: - type: string - x-go-name: Scope - send_state: - type: string - x-go-name: SendState - state: - type: string - x-go-name: State - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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/monitor - AlertRecordRule: - properties: - alert_duration: - format: int64 - type: integer - x-go-name: AlertDuration - comparator: - description: '比较运算符, 比如: >, <, >=, <=' - type: string - x-go-name: Comparator - condition_type: - type: string - x-go-name: ConditionType - database: - type: string - x-go-name: Database - field: - type: string - x-go-name: Field - field_desc: - type: string - x-go-name: FieldDesc - measurement: - type: string - x-go-name: Measurement - measurement_desc: - type: string - x-go-name: MeasurementDesc - metric: - type: string - x-go-name: Metric - period: - type: string - x-go-name: Period - res_type: - type: string - x-go-name: ResType - silent_period: - description: 静默期 - type: string - x-go-name: SilentPeriod - threshold: - description: 报警阀值 - type: string - x-go-name: Threshold - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertRecordShieldCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + settings: + $ref: '#/definitions/AlertSetting' type: object - x-go-name: Metadata - alert_id: - type: string - x-go-name: AlertId - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - end_time: - type: string - x-go-name: EndTime - 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 - res_id: - type: string - x-go-name: ResId - res_name: - type: string - x-go-name: ResName - res_type: - type: string - x-go-name: ResType - start_time: - type: string - x-go-name: StartTime - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertRecordShieldDetails: - properties: - alert_duration: - description: 报警连续持续周期数 - format: int64 - type: integer - x-go-name: AlertDuration - alert_name: - type: string - x-go-name: AlertName - alert_type: - description: 报警类型 - type: string - x-go-name: AlertType - 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 - channel: - items: - type: string - type: array - x-go-name: Channel - common_alert_metric_details: - items: - $ref: '#/definitions/CommonAlertMetricDetails' - type: array - x-go-name: CommonAlertMetricDetails - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - customize_config: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertV1Details: + 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 + channel: + type: string + x-go-name: Channel + comparator: + type: string + x-go-name: Comparator + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + db: + type: string + x-go-name: DB + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + field: + type: string + x-go-name: Field + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + measurement: + type: string + x-go-name: Measurement + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + recipients: + type: string + x-go-name: Recipients + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + threshold: + format: double + type: number + x-go-name: Threshold + 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 + used_by: + type: string + x-go-name: UsedBy + window: + type: string + x-go-name: Window type: object - x-go-name: CustomizeConfig - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates type: object - x-go-name: EvalData - execution_error: - description: Silenced bool - type: string - x-go-name: ExecutionError - execution_error_state: - type: string - x-go-name: ExecutionErrorState - expired: - type: boolean - x-go-name: Expired - for: - description: |- - If an alert rule has a configured `For` and the query violates the configured threshold - it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any - notifications. Once the alert rule has been firing for more than `For` duration, it will - change to `Alerting` and send alert notifications. - format: int64 - type: integer - x-go-name: For - frequency: - description: Frequency is evaluate period - format: int64 - type: integer - x-go-name: Frequency - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - last_state_change: - format: date-time - type: string - x-go-name: LastStateChange - level: - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis + CommonAlertCreateInput: + properties: + alert_duration: + description: 报警连续持续周期数 + format: int64 + type: integer + x-go-name: AlertDuration + alert_type: + description: 报警类型 + type: string + x-go-name: AlertType + channel: + description: '通知方式, 比如: email, mobile' + items: + type: string + type: array + x-go-name: Channel + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + description: + type: string + x-go-name: Description + domain_id: + type: string + x-go-name: DomainId + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + from: + type: string + x-go-name: From + get_point_str: + type: boolean + x-go-name: GetPointStr + interval: + type: string + x-go-name: Interval + level: + description: 报警级别 + type: string + x-go-name: Level + meta_name: + type: string + x-go-name: MetaName + metric_query: + items: + $ref: '#/definitions/CommonAlertQuery' + type: array + x-go-name: MetricQuery + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + period: + description: 查询指标周期 + type: string + x-go-name: Period + project_id: + type: string + x-go-name: ProjectId + recipients: + description: 通知接受者 + items: + type: string + type: array + x-go-name: Recipients + robot_ids: + items: + type: string + type: array + x-go-name: RobotIds + roles: + description: 角色 id 或者 name + items: + type: string + type: array + x-go-name: Roles + scope: + description: Scope Resource + type: string + x-go-name: Scope + settings: + $ref: '#/definitions/AlertSetting' + silent_period: + description: 静默期 + type: string + x-go-name: SilentPeriod + to: + type: string + x-go-name: To + used_by: + type: string + x-go-name: UsedBy type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - type: string - x-go-name: NoDataState - notifier_id: - type: string - x-go-name: NotifierId - period: - type: string - x-go-name: Period - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - recipients: - items: - type: string - type: array - x-go-name: Recipients - res_name: - type: string - x-go-name: ResName - res_type: - type: string - x-go-name: ResType - robot_ids: - items: - type: string - type: array - x-go-name: RobotIds - role_ids: - items: - type: string - type: array - x-go-name: RoleIds - scope: - type: string - x-go-name: Scope - settings: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + CommonAlertDetails: + properties: + alert_duration: + description: 报警连续持续周期数 + format: int64 + type: integer + x-go-name: AlertDuration + alert_type: + description: 报警类型 + type: string + x-go-name: AlertType + 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 + channel: + items: + type: string + type: array + x-go-name: Channel + common_alert_metric_details: + items: + $ref: '#/definitions/CommonAlertMetricDetails' + type: array + x-go-name: CommonAlertMetricDetails + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + recipients: + items: + type: string + type: array + x-go-name: Recipients + res_type: + type: string + x-go-name: ResType + robot_ids: + items: + type: string + type: array + x-go-name: RobotIds + role_ids: + items: + type: string + type: array + x-go-name: RoleIds + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + silent_period: + description: 静默期 + type: string + x-go-name: SilentPeriod + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + used_by: + type: string + x-go-name: UsedBy type: object - x-go-name: Settings - silent_period: - description: 静默期 - type: string - x-go-name: SilentPeriod - state: - type: string - x-go-name: State - state_changes: - format: int64 - type: integer - x-go-name: StateChanges - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertResourceDetails: - 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 - count: - format: int64 - type: integer - x-go-name: Count - delete_fail_reason: - $ref: '#/definitions/Error' - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + CommonAlertMetricDetails: + properties: + FieldDescription: + $ref: '#/definitions/MetricFieldDetail' + comparator: + type: string + x-go-name: Comparator + condition_type: + type: string + x-go-name: ConditionType + db: + type: string + x-go-name: DB + field: + type: string + x-go-name: Field + field_opt: + type: string + x-go-name: FieldOpt + filters: + items: + $ref: '#/definitions/MetricQueryTag' + type: array + x-go-name: Filters + get_point_str: + type: boolean + x-go-name: GetPointStr + groupby: + type: string + x-go-name: Groupby + measurement: + type: string + x-go-name: Measurement + measurement_display_name: + type: string + x-go-name: MeasurementDisplayName + reduce: + description: metric points'value的运算方式 + type: string + x-go-name: Reduce + res_type: + type: string + x-go-name: ResType + threshold: + format: double + type: number + x-go-name: Threshold + threshold_str: + type: string + x-go-name: ThresholdStr + within_range: + items: + format: double + type: number + type: array + x-go-name: WithinRange type: object - x-go-name: Metadata - tags: - additionalProperties: - type: string + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + CommonAlertQuery: + properties: + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + condition_type: + type: string + x-go-name: ConditionType + field_opt: + description: field yunsuan + type: string + x-go-name: FieldOpt + from: + type: string + x-go-name: From + model: + $ref: '#/definitions/MetricQuery' + reduce: + description: metric points'value的运算方式 + type: string + x-go-name: Reduce + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold + to: + type: string + x-go-name: To type: object - x-go-name: Tags - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertSetting: - description: AlertSettings contains alert conditions - properties: - conditions: - items: - $ref: '#/definitions/AlertCondition' - type: array - x-go-name: Conditions - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertTestRunInput: - properties: - is_debug: - type: boolean - x-go-name: IsDebug - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertTestRunOutput: - properties: - alert_ok_eval_matches: - items: - $ref: '#/definitions/EvalMatch' - type: array - x-go-name: AlertOKEvalMatches - condition_evals: - type: string - x-go-name: ConditionEvals - end_time: - format: date-time - type: string - x-go-name: EndTime - error: - type: string - x-go-name: Error - eval_matches: - items: - $ref: '#/definitions/EvalMatch' - type: array - x-go-name: EvalMatches - firing: - type: boolean - x-go-name: Firing - is_debug: - type: boolean - x-go-name: IsDebug - is_test_run: - type: boolean - x-go-name: IsTestRun - logs: - items: - $ref: '#/definitions/ResultLogEntry' - type: array - x-go-name: Logs - no_data_found: - type: boolean - x-go-name: NoDataFound - prev_alert_state: - type: string - x-go-name: PrevAlertState - start_time: - format: date-time - type: string - x-go-name: StartTime - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - level: - description: 报警级别 - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - settings: - $ref: '#/definitions/AlertSetting' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - AlertV1Details: - 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 - channel: - type: string - x-go-name: Channel - comparator: - type: string - x-go-name: Comparator - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - customize_config: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + Condition: + properties: + operators: + items: + type: string + type: array + x-go-name: Operators + params: + items: + format: double + type: number + type: array + x-go-name: Params + type: + type: string + x-go-name: Type type: object - x-go-name: CustomizeConfig - db: - type: string - x-go-name: DB - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + Duration: + description: |- + A Duration represents the elapsed time between two instants + as an int64 nanosecond count. The representation limits the + largest representable duration to approximately 290 years. + format: int64 + type: integer + x-go-package: time + 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-name: EvalData - execution_error: - description: Silenced bool - type: string - x-go-name: ExecutionError - execution_error_state: - type: string - x-go-name: ExecutionErrorState - field: - type: string - x-go-name: Field - for: - description: |- - If an alert rule has a configured `For` and the query violates the configured threshold - it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any - notifications. Once the alert rule has been firing for more than `For` duration, it will - change to `Alerting` and send alert notifications. - format: int64 - type: integer - x-go-name: For - frequency: - description: Frequency is evaluate period - format: int64 - type: integer - x-go-name: Frequency - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - last_state_change: - format: date-time - type: string - x-go-name: LastStateChange - level: - type: string - x-go-name: Level - measurement: - type: string - x-go-name: Measurement - message: - type: string - x-go-name: Message - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/httperrors + EvalMatch: + properties: + condition: + type: string + x-go-name: Condition + metric: + type: string + x-go-name: Metric + tags: + additionalProperties: + type: string + type: object + x-go-name: Tags + unit: + type: string + x-go-name: Unit + value: + format: double + type: number + x-go-name: Value + value_str: + type: string + x-go-name: ValueStr + title: EvalMatch represents the series violating the threshold. type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - type: string - x-go-name: NoDataState - notifier_id: - type: string - x-go-name: NotifierId - period: - type: string - x-go-name: Period - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - recipients: - type: string - x-go-name: Recipients - res_type: - type: string - x-go-name: ResType - scope: - type: string - x-go-name: Scope - settings: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status type: object - x-go-name: Settings - state: - type: string - x-go-name: State - state_changes: - format: int64 - type: integer - x-go-name: StateChanges - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - threshold: - format: double - type: number - x-go-name: Threshold - 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 - used_by: - type: string - x-go-name: UsedBy - window: - type: string - x-go-name: Window - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - ChangeOwnerCandidateDomainsOutput: - properties: - candidates: - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: Candidates - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - CommonAlertCreateInput: - properties: - alert_duration: - description: 报警连续持续周期数 - format: int64 - type: integer - x-go-name: AlertDuration - alert_type: - description: 报警类型 - type: string - x-go-name: AlertType - channel: - description: '通知方式, 比如: email, mobile' - items: - type: string - type: array - x-go-name: Channel - customize_config: - description: customize info + x-go-package: yunion.io/x/onecloud/pkg/apis + JoinResourceBaseCreateInput: type: object - x-go-name: CustomizeConfig - description: - type: string - x-go-name: Description - domain_id: - type: string - x-go-name: DomainId - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - from: - type: string - x-go-name: From - get_point_str: - type: boolean - x-go-name: GetPointStr - interval: - type: string - x-go-name: Interval - level: - description: 报警级别 - type: string - x-go-name: Level - meta_name: - type: string - x-go-name: MetaName - metric_query: - items: - $ref: '#/definitions/CommonAlertQuery' - type: array - x-go-name: MetricQuery - name: - description: 报警名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - period: - description: 查询指标周期 - type: string - x-go-name: Period - project_id: - type: string - x-go-name: ProjectId - recipients: - description: 通知接受者 - items: - type: string - type: array - x-go-name: Recipients - robot_ids: - items: - type: string - type: array - x-go-name: RobotIds - roles: - description: 角色 id 或者 name - items: - type: string - type: array - x-go-name: Roles - scope: - description: Scope Resource - type: string - x-go-name: Scope - settings: - $ref: '#/definitions/AlertSetting' - silent_period: - description: 静默期 - type: string - x-go-name: SilentPeriod - to: - type: string - x-go-name: To - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - CommonAlertDetails: - properties: - alert_duration: - description: 报警连续持续周期数 - format: int64 - type: integer - x-go-name: AlertDuration - alert_type: - description: 报警类型 - type: string - x-go-name: AlertType - 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 - channel: - items: - type: string - type: array - x-go-name: Channel - common_alert_metric_details: - items: - $ref: '#/definitions/CommonAlertMetricDetails' - type: array - x-go-name: CommonAlertMetricDetails - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - customize_config: + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseDetails: + 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-name: CustomizeConfig - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseUpdateInput: type: object - x-go-name: EvalData - execution_error: - description: Silenced bool - type: string - x-go-name: ExecutionError - execution_error_state: - type: string - x-go-name: ExecutionErrorState - for: - description: |- - If an alert rule has a configured `For` and the query violates the configured threshold - it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any - notifications. Once the alert rule has been firing for more than `For` duration, it will - change to `Alerting` and send alert notifications. - format: int64 - type: integer - x-go-name: For - frequency: - description: Frequency is evaluate period - format: int64 - type: integer - x-go-name: Frequency - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - last_state_change: - format: date-time - type: string - x-go-name: LastStateChange - level: - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis + MeterAlertCreateInput: + properties: + account_id: + description: 云账号 Id + type: string + x-go-name: AccountId + channel: + description: '通知方式, 比如: email, mobile' + type: string + x-go-name: Channel + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + period: + description: 查询指标周期 + type: string + x-go-name: Period + project_id: + description: 项目 Id string + type: string + x-go-name: ProjectId + provider: + description: 云平台类型 + type: string + x-go-name: Provider + recipients: + description: 通知接受者 + type: string + x-go-name: Recipients + settings: + $ref: '#/definitions/AlertSetting' + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold + type: + description: '监控资源类型, 比如: balance, resFree, monthFee' + type: string + x-go-name: Type + used_by: + type: string + x-go-name: UsedBy + window: + description: 每隔多久查询一次 + type: string + x-go-name: Window type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - type: string - x-go-name: NoDataState - notifier_id: - type: string - x-go-name: NotifierId - period: - type: string - x-go-name: Period - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - recipients: - items: - type: string - type: array - x-go-name: Recipients - res_type: - type: string - x-go-name: ResType - robot_ids: - items: - type: string - type: array - x-go-name: RobotIds - role_ids: - items: - type: string - type: array - x-go-name: RoleIds - scope: - type: string - x-go-name: Scope - settings: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MeterAlertDetails: + properties: + account_id: + type: string + x-go-name: AccountId + 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 + channel: + type: string + x-go-name: Channel + comparator: + type: string + x-go-name: Comparator + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + db: + type: string + x-go-name: DB + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + field: + type: string + x-go-name: Field + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + measurement: + type: string + x-go-name: Measurement + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: ProjectId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + type: string + x-go-name: Provider + recipients: + type: string + x-go-name: Recipients + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + threshold: + format: double + type: number + x-go-name: Threshold + 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 + used_by: + type: string + x-go-name: UsedBy + window: + type: string + x-go-name: Window type: object - x-go-name: Settings - silent_period: - description: 静默期 - type: string - x-go-name: SilentPeriod - state: - type: string - x-go-name: State - state_changes: - format: int64 - type: integer - x-go-name: StateChanges - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - CommonAlertMetricDetails: - properties: - FieldDescription: - $ref: '#/definitions/MetricFieldDetail' - comparator: - type: string - x-go-name: Comparator - condition_type: - type: string - x-go-name: ConditionType - db: - type: string - x-go-name: DB - field: - type: string - x-go-name: Field - field_opt: - type: string - x-go-name: FieldOpt - filters: - items: - $ref: '#/definitions/MetricQueryTag' - type: array - x-go-name: Filters - get_point_str: - type: boolean - x-go-name: GetPointStr - groupby: - type: string - x-go-name: Groupby - measurement: - type: string - x-go-name: Measurement - measurement_display_name: - type: string - x-go-name: MeasurementDisplayName - reduce: - description: metric points'value的运算方式 - type: string - x-go-name: Reduce - res_type: - type: string - x-go-name: ResType - threshold: - format: double - type: number - x-go-name: Threshold - threshold_str: - type: string - x-go-name: ThresholdStr - within_range: - items: - format: double - type: number - type: array - x-go-name: WithinRange - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - CommonAlertQuery: - properties: - comparator: - description: '比较运算符, 比如: >, <, >=, <=' - type: string - x-go-name: Comparator - condition_type: - type: string - x-go-name: ConditionType - data_source_id: - type: string - x-go-name: DataSourceId - field_opt: - description: field yunsuan - type: string - x-go-name: FieldOpt - from: - type: string - x-go-name: From - model: - $ref: '#/definitions/MetricQuery' - reduce: - description: metric points'value的运算方式 - type: string - x-go-name: Reduce - threshold: - description: 报警阀值 - format: double - type: number - x-go-name: Threshold - to: - type: string - x-go-name: To - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - Condition: - properties: - operators: - items: - type: string - type: array - x-go-name: Operators - params: - items: - format: double - type: number - type: array - x-go-name: Params - type: - type: string - x-go-name: Type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - Duration: - description: |- - A Duration represents the elapsed time between two instants - as an int64 nanosecond count. The representation limits the - largest representable duration to approximately 290 years. - format: int64 - type: integer - x-go-package: time - 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 - EvalMatch: - properties: - condition: - type: string - x-go-name: Condition - metric: - type: string - x-go-name: Metric - tags: - additionalProperties: - type: string + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MeterAlertUpdateInput: + properties: + channel: + description: '通知方式, 比如: email, mobile' + type: string + x-go-name: Channel + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + description: + description: 资源描述 + type: string + x-go-name: Description + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + project_id: + description: 项目 Id + type: string + x-go-name: ProjectId + recipients: + description: 通知接受者 + type: string + x-go-name: Recipients + settings: + $ref: '#/definitions/AlertSetting' + status: + type: string + x-go-name: Status + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold type: object - x-go-name: Tags - unit: - type: string - x-go-name: Unit - value: - format: double - type: number - x-go-name: Value - value_str: - type: string - x-go-name: ValueStr - title: EvalMatch represents the series violating the threshold. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - GetDetailsStatusOutput: - properties: - status: - description: 状态 - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - JoinResourceBaseCreateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - JointResourceBaseDetails: - 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 - JointResourceBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - MeterAlertCreateInput: - properties: - account_id: - description: 云账号 Id - type: string - x-go-name: AccountId - channel: - description: '通知方式, 比如: email, mobile' - type: string - x-go-name: Channel - comparator: - description: '比较运算符, 比如: >, <, >=, <=' - type: string - x-go-name: Comparator - customize_config: - description: customize info + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricCreateInput: + properties: + measurement: + $ref: '#/definitions/MetricMeasurementCreateInput' + metric_fields: + items: + $ref: '#/definitions/MetricFieldCreateInput' + type: array + x-go-name: MetricFields + scope: + type: string + x-go-name: Scope type: object - x-go-name: CustomizeConfig - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - level: - description: 报警级别 - type: string - x-go-name: Level - name: - description: 报警名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - period: - description: 查询指标周期 - type: string - x-go-name: Period - project_id: - description: 项目 Id string - type: string - x-go-name: ProjectId - provider: - description: 云平台类型 - type: string - x-go-name: Provider - recipients: - description: 通知接受者 - type: string - x-go-name: Recipients - settings: - $ref: '#/definitions/AlertSetting' - threshold: - description: 报警阀值 - format: double - type: number - x-go-name: Threshold - type: - description: '监控资源类型, 比如: balance, resFree, monthFee' - type: string - x-go-name: Type - used_by: - type: string - x-go-name: UsedBy - window: - description: 每隔多久查询一次 - type: string - x-go-name: Window - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MeterAlertDetails: - properties: - account_id: - type: string - x-go-name: AccountId - 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 - channel: - type: string - x-go-name: Channel - comparator: - type: string - x-go-name: Comparator - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - customize_config: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricDetails: + 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 + metric_fields: + items: + $ref: '#/definitions/MetricFieldDetail' + type: array + x-go-name: MetricFields + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + scope: + type: string + x-go-name: Scope + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' type: object - x-go-name: CustomizeConfig - db: - type: string - x-go-name: DB - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricFieldCreateInput: + 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 + 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 + score: + format: int64 + type: integer + x-go-name: Score + unit: + type: string + x-go-name: Unit + value_type: + type: string + x-go-name: ValueType + required: + - name type: object - x-go-name: EvalData - execution_error: - description: Silenced bool - type: string - x-go-name: ExecutionError - execution_error_state: - type: string - x-go-name: ExecutionErrorState - field: - type: string - x-go-name: Field - for: - description: |- - If an alert rule has a configured `For` and the query violates the configured threshold - it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any - notifications. Once the alert rule has been firing for more than `For` duration, it will - change to `Alerting` and send alert notifications. - format: int64 - type: integer - x-go-name: For - frequency: - description: Frequency is evaluate period - format: int64 - type: integer - x-go-name: Frequency - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - last_state_change: - format: date-time - type: string - x-go-name: LastStateChange - level: - type: string - x-go-name: Level - measurement: - type: string - x-go-name: Measurement - message: - type: string - x-go-name: Message - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricFieldDetail: + properties: + display_name: + type: string + x-go-name: DisplayName + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + unit: + type: string + x-go-name: Unit type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - type: string - x-go-name: NoDataState - notifier_id: - type: string - x-go-name: NotifierId - period: - type: string - x-go-name: Period - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: ProjectId - provider: - type: string - x-go-name: Provider - recipients: - type: string - x-go-name: Recipients - res_type: - type: string - x-go-name: ResType - scope: - type: string - x-go-name: Scope - settings: - type: object - x-go-name: Settings - state: - type: string - x-go-name: State - state_changes: - format: int64 - type: integer - x-go-name: StateChanges - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - threshold: - format: double - type: number - x-go-name: Threshold - 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 - used_by: - type: string - x-go-name: UsedBy - window: - type: string - x-go-name: Window - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MeterAlertUpdateInput: - properties: - channel: - description: '通知方式, 比如: email, mobile' - type: string - x-go-name: Channel - comparator: - description: '比较运算符, 比如: >, <, >=, <=' - type: string - x-go-name: Comparator - description: - description: 资源描述 - type: string - x-go-name: Description - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - level: - description: 报警级别 - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - project_id: - description: 项目 Id - type: string - x-go-name: ProjectId - recipients: - description: 通知接受者 - type: string - x-go-name: Recipients - settings: - $ref: '#/definitions/AlertSetting' - status: - type: string - x-go-name: Status - threshold: - description: 报警阀值 - format: double - type: number - x-go-name: Threshold - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricCreateInput: - properties: - measurement: - $ref: '#/definitions/MetricMeasurementCreateInput' - metric_fields: - items: - $ref: '#/definitions/MetricFieldCreateInput' - type: array - x-go-name: MetricFields - scope: - type: string - x-go-name: Scope - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricDetails: - 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 - metric_fields: - items: - $ref: '#/definitions/MetricFieldDetail' - type: array - x-go-name: MetricFields - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - scope: - type: string - x-go-name: Scope - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricFieldCreateInput: - 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 - 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 - score: - format: int64 - type: integer - x-go-name: Score - unit: - type: string - x-go-name: Unit - value_type: - type: string - x-go-name: ValueType - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricFieldDetail: - properties: - display_name: - type: string - x-go-name: DisplayName - id: - type: string - x-go-name: Id - name: - type: string - x-go-name: Name - unit: - type: string - x-go-name: Unit - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricFieldListInput: - properties: - belong_scope: - description: 指定匹配的范围，可能值为project, domain or system - type: string - x-go-name: BelongScope - details: - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - type: boolean - x-go-name: Details - display_name: - type: string - x-go-name: DisplayName - domain_tags: - $ref: '#/definitions/TTagSetList' - enabled: - description: 以资源是否启用/禁用过滤列表 - type: boolean - x-go-name: Enabled - export_keys: - description: 用于数据导出，指定导出的数据字段 - type: string - x-go-name: ExportKeys - field: - description: 返回结果只包含指定的字段 - items: - type: string - type: array - x-go-name: Field - filter: - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricFieldListInput: + properties: + belong_scope: + description: 指定匹配的范围，可能值为project, domain or system + type: string + x-go-name: BelongScope + details: + description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + type: boolean + x-go-name: Details + display_name: + type: string + x-go-name: DisplayName + domain_tags: + $ref: '#/definitions/TTagSetList' + enabled: + description: 以资源是否启用/禁用过滤列表 + type: boolean + x-go-name: Enabled + export_keys: + description: 用于数据导出，指定导出的数据字段 + type: string + x-go-name: ExportKeys + field: + description: 返回结果只包含指定的字段 + items: + type: string + type: array + x-go-name: Field + filter: + 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或者空字符串 | - items: - type: string - type: array - x-go-name: Filter - filter_any: - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - type: boolean - x-go-name: FilterAny - id: - description: 以资源ID过滤列表 - items: - type: string - type: array - x-go-name: Ids - joint_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') - items: - type: string - type: array - x-go-name: JointFilter - limit: - default: 20 - description: 查询限制量 - format: int64 - type: integer - x-go-name: Limit - name: - description: 以资源名称过滤列表 - items: - type: string - type: array - x-go-name: Names - no_domain_tags: - $ref: '#/definitions/TTagSetList' - no_obj_tags: - $ref: '#/definitions/TTagSetList' - no_project_tags: - $ref: '#/definitions/TTagSetList' - no_tags: - $ref: '#/definitions/TTagSet' - obj_tags: - $ref: '#/definitions/TTagSetList' - offset: - default: 0 - description: 查询偏移量 - format: int64 - type: integer - x-go-name: Offset - order: - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - type: string - x-go-name: Order - order_by: - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - items: - type: string - type: array - x-go-name: OrderBy - order_by_domain: - description: 按domain名称排序，可能值为asc|desc - pattern: asc|desc - type: string - x-go-name: OrderByDomain - order_by_project: - description: 按project名称排序，可能值为asc|desc - pattern: asc|desc - type: string - x-go-name: OrderByProject - order_by_tag: - description: 通过标签排序 - type: string - x-go-name: OrderByTag - policy_project_tags: - $ref: '#/definitions/TTagSetList' - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_domain_ids: - description: 对具有域属性的资源，严格匹配域ID - items: - type: string - type: array - x-go-name: ProjectDomainIds - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - project_ids: - description: 对具有项目属性的资源，严格匹配项目ID - items: - type: string - type: array - x-go-name: ProjectIds - project_tags: - $ref: '#/definitions/TTagSetList' - scope: - description: 指定查询的权限范围，可能值为project, domain or system - type: string - x-go-name: Scope - search: - description: 模糊搜索所有字段 - type: string - x-go-name: Search - show_emulated: - description: 显示所有的资源，包括模拟的资源 - type: boolean - x-go-name: ShowEmulated - show_fail_reason: - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - type: boolean - x-go-name: ShowFailReason - status: - description: 以资源的状态过滤列表 - items: - type: string - type: array - x-go-name: Status - tags: - $ref: '#/definitions/TTagSet' - unit: - type: string - x-go-name: Unit - with_any_meta: - description: 返回包含任意标签的资源 - type: boolean - x-go-name: WithAnyMeta - with_cloud_meta: - description: 返回包含外部标签的资源 - type: boolean - x-go-name: WithCloudMeta - with_meta: - description: 返回列表数据中包含资源的标签数据（Metadata） - type: boolean - x-go-name: WithMeta - with_user_meta: - description: 返回包含用户标签的资源 - type: boolean - x-go-name: WithUserMeta - without_user_meta: - description: |- - deprecated - 返回资源的标签不包含用户标签 - type: boolean - x-go-name: WithoutUserMeta - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricFieldUpdateInput: - properties: - Id: - type: string - description: - description: 资源描述 - type: string - x-go-name: Description - display_name: - type: string - x-go-name: DisplayName - name: - description: 资源名称 - type: string - x-go-name: Name - score: - format: int64 - type: integer - x-go-name: Score - unit: - type: string - x-go-name: Unit - value_type: - type: string - x-go-name: ValueType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricMeasurementCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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或者空字符串 | + items: + type: string + type: array + x-go-name: Filter + filter_any: + description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + type: boolean + x-go-name: FilterAny + id: + description: 以资源ID过滤列表 + items: + type: string + type: array + x-go-name: Ids + joint_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') + items: + type: string + type: array + x-go-name: JointFilter + limit: + default: 20 + description: 查询限制量 + format: int64 + type: integer + x-go-name: Limit + name: + description: 以资源名称过滤列表 + items: + type: string + type: array + x-go-name: Names + no_domain_tags: + $ref: '#/definitions/TTagSetList' + no_obj_tags: + $ref: '#/definitions/TTagSetList' + no_project_tags: + $ref: '#/definitions/TTagSetList' + no_tags: + $ref: '#/definitions/TTagSet' + obj_tags: + $ref: '#/definitions/TTagSetList' + offset: + default: 0 + description: 查询偏移量 + format: int64 + type: integer + x-go-name: Offset + order: + description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + type: string + x-go-name: Order + order_by: + description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + items: + type: string + type: array + x-go-name: OrderBy + order_by_domain: + description: 按domain名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByDomain + order_by_project: + description: 按project名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByProject + order_by_tag: + description: 通过标签排序 + type: string + x-go-name: OrderByTag + policy_project_tags: + $ref: '#/definitions/TTagSetList' + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_domain_ids: + description: 对具有域属性的资源，严格匹配域ID + items: + type: string + type: array + x-go-name: ProjectDomainIds + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_ids: + description: 对具有项目属性的资源，严格匹配项目ID + items: + type: string + type: array + x-go-name: ProjectIds + project_organizations: + description: filter by project organizations + items: + type: string + type: array + x-go-name: ProjectOrganizations + project_tags: + $ref: '#/definitions/TTagSetList' + scope: + description: 指定查询的权限范围，可能值为project, domain or system + type: string + x-go-name: Scope + search: + description: 模糊搜索所有字段 + type: string + x-go-name: Search + show_emulated: + description: 显示所有的资源，包括模拟的资源 + type: boolean + x-go-name: ShowEmulated + show_fail_reason: + description: 返回结果携带delete_fail_reason和update_fail_reason字段 + type: boolean + x-go-name: ShowFailReason + status: + description: 以资源的状态过滤列表 + items: + type: string + type: array + x-go-name: Status + tags: + $ref: '#/definitions/TTagSet' + unit: + type: string + x-go-name: Unit + with_any_meta: + description: 返回包含任意标签的资源 + type: boolean + x-go-name: WithAnyMeta + with_cloud_meta: + description: 返回包含外部标签的资源 + type: boolean + x-go-name: WithCloudMeta + with_meta: + description: 返回列表数据中包含资源的标签数据（Metadata） + type: boolean + x-go-name: WithMeta + with_user_meta: + description: 返回包含用户标签的资源 + type: boolean + x-go-name: WithUserMeta + without_user_meta: + description: |- + deprecated + 返回资源的标签不包含用户标签 + type: boolean + x-go-name: WithoutUserMeta type: object - x-go-name: Metadata - database: - type: string - x-go-name: Database - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - display_name: - 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 - res_type: - type: string - x-go-name: ResType - score: - format: int64 - type: integer - x-go-name: Score - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricMeasurementListInput: - properties: - belong_scope: - description: 指定匹配的范围，可能值为project, domain or system - type: string - x-go-name: BelongScope - details: - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - type: boolean - x-go-name: Details - display_name: - type: string - x-go-name: DisplayName - domain_tags: - $ref: '#/definitions/TTagSetList' - enabled: - description: 以资源是否启用/禁用过滤列表 - type: boolean - x-go-name: Enabled - export_keys: - description: 用于数据导出，指定导出的数据字段 - type: string - x-go-name: ExportKeys - field: - description: 返回结果只包含指定的字段 - items: - type: string - type: array - x-go-name: Field - filter: - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricFieldUpdateInput: + properties: + Id: + type: string + description: + description: 资源描述 + type: string + x-go-name: Description + display_name: + type: string + x-go-name: DisplayName + name: + description: 资源名称 + type: string + x-go-name: Name + score: + format: int64 + type: integer + x-go-name: Score + unit: + type: string + x-go-name: Unit + value_type: + type: string + x-go-name: ValueType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricMeasurementCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + database: + type: string + x-go-name: Database + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + display_name: + 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 + res_type: + type: string + x-go-name: ResType + score: + format: int64 + type: integer + x-go-name: Score + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricMeasurementListInput: + properties: + belong_scope: + description: 指定匹配的范围，可能值为project, domain or system + type: string + x-go-name: BelongScope + details: + description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + type: boolean + x-go-name: Details + display_name: + type: string + x-go-name: DisplayName + domain_tags: + $ref: '#/definitions/TTagSetList' + enabled: + description: 以资源是否启用/禁用过滤列表 + type: boolean + x-go-name: Enabled + export_keys: + description: 用于数据导出，指定导出的数据字段 + type: string + x-go-name: ExportKeys + field: + description: 返回结果只包含指定的字段 + items: + type: string + type: array + x-go-name: Field + filter: + 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或者空字符串 | - items: - type: string - type: array - x-go-name: Filter - filter_any: - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - type: boolean - x-go-name: FilterAny - id: - description: 以资源ID过滤列表 - items: - type: string - type: array - x-go-name: Ids - joint_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') - items: - type: string - type: array - x-go-name: JointFilter - limit: - default: 20 - description: 查询限制量 - format: int64 - type: integer - x-go-name: Limit - name: - description: 以资源名称过滤列表 - items: - type: string - type: array - x-go-name: Names - no_domain_tags: - $ref: '#/definitions/TTagSetList' - no_obj_tags: - $ref: '#/definitions/TTagSetList' - no_project_tags: - $ref: '#/definitions/TTagSetList' - no_tags: - $ref: '#/definitions/TTagSet' - obj_tags: - $ref: '#/definitions/TTagSetList' - offset: - default: 0 - description: 查询偏移量 - format: int64 - type: integer - x-go-name: Offset - order: - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - type: string - x-go-name: Order - order_by: - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - items: - type: string - type: array - x-go-name: OrderBy - order_by_domain: - description: 按domain名称排序，可能值为asc|desc - pattern: asc|desc - type: string - x-go-name: OrderByDomain - order_by_project: - description: 按project名称排序，可能值为asc|desc - pattern: asc|desc - type: string - x-go-name: OrderByProject - order_by_tag: - description: 通过标签排序 - type: string - x-go-name: OrderByTag - policy_project_tags: - $ref: '#/definitions/TTagSetList' - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_domain_ids: - description: 对具有域属性的资源，严格匹配域ID - items: - type: string - type: array - x-go-name: ProjectDomainIds - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - project_ids: - description: 对具有项目属性的资源，严格匹配项目ID - items: - type: string - type: array - x-go-name: ProjectIds - project_tags: - $ref: '#/definitions/TTagSetList' - res_type: - type: string - x-go-name: ResType - scope: - description: 指定查询的权限范围，可能值为project, domain or system - type: string - x-go-name: Scope - search: - description: 模糊搜索所有字段 - type: string - x-go-name: Search - show_emulated: - description: 显示所有的资源，包括模拟的资源 - type: boolean - x-go-name: ShowEmulated - show_fail_reason: - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - type: boolean - x-go-name: ShowFailReason - status: - description: 以资源的状态过滤列表 - items: - type: string - type: array - x-go-name: Status - tags: - $ref: '#/definitions/TTagSet' - with_any_meta: - description: 返回包含任意标签的资源 - type: boolean - x-go-name: WithAnyMeta - with_cloud_meta: - description: 返回包含外部标签的资源 - type: boolean - x-go-name: WithCloudMeta - with_meta: - description: 返回列表数据中包含资源的标签数据（Metadata） - type: boolean - x-go-name: WithMeta - with_user_meta: - description: 返回包含用户标签的资源 - type: boolean - x-go-name: WithUserMeta - without_user_meta: - description: |- - deprecated - 返回资源的标签不包含用户标签 - type: boolean - x-go-name: WithoutUserMeta - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricMeasurementUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - display_name: - type: string - x-go-name: DisplayName - name: - description: 资源名称 - type: string - x-go-name: Name - res_type: - type: string - x-go-name: ResType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricQuery: - properties: - alias: - type: string - x-go-name: Alias - database: - type: string - x-go-name: Database - group_by: - items: - $ref: '#/definitions/MetricQueryPart' - type: array - x-go-name: GroupBy - interval: - type: string - x-go-name: Interval - measurement: - type: string - x-go-name: Measurement - policy: - type: string - x-go-name: Policy - result_format: - type: string - x-go-name: ResultFormat - select: - items: - $ref: '#/definitions/MetricQuerySelect' - type: array - x-go-name: Selects - tags: - items: - $ref: '#/definitions/MetricQueryTag' - type: array - x-go-name: Tags - tz: - type: string - x-go-name: Tz - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricQueryPart: - properties: - params: - items: - type: string - type: array - x-go-name: Params - type: - type: string - x-go-name: Type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricQuerySelect: - items: - $ref: '#/definitions/MetricQueryPart' - type: array - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricQueryTag: - properties: - condition: - type: string - x-go-name: Condition - key: - type: string - x-go-name: Key - operator: - type: string - x-go-name: Operator - value: - type: string - x-go-name: Value - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MetricUpdateInput: - properties: - measurement: - $ref: '#/definitions/MetricMeasurementUpdateInput' - metric_fields: - items: - $ref: '#/definitions/MetricFieldUpdateInput' - type: array - x-go-name: MetricFields - scope: - type: string - x-go-name: Scope - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MigrationAlertCreateInput: - properties: - customize_config: - description: customize info + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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或者空字符串 | + items: + type: string + type: array + x-go-name: Filter + filter_any: + description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + type: boolean + x-go-name: FilterAny + id: + description: 以资源ID过滤列表 + items: + type: string + type: array + x-go-name: Ids + joint_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') + items: + type: string + type: array + x-go-name: JointFilter + limit: + default: 20 + description: 查询限制量 + format: int64 + type: integer + x-go-name: Limit + name: + description: 以资源名称过滤列表 + items: + type: string + type: array + x-go-name: Names + no_domain_tags: + $ref: '#/definitions/TTagSetList' + no_obj_tags: + $ref: '#/definitions/TTagSetList' + no_project_tags: + $ref: '#/definitions/TTagSetList' + no_tags: + $ref: '#/definitions/TTagSet' + obj_tags: + $ref: '#/definitions/TTagSetList' + offset: + default: 0 + description: 查询偏移量 + format: int64 + type: integer + x-go-name: Offset + order: + description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + type: string + x-go-name: Order + order_by: + description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + items: + type: string + type: array + x-go-name: OrderBy + order_by_domain: + description: 按domain名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByDomain + order_by_project: + description: 按project名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByProject + order_by_tag: + description: 通过标签排序 + type: string + x-go-name: OrderByTag + policy_project_tags: + $ref: '#/definitions/TTagSetList' + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_domain_ids: + description: 对具有域属性的资源，严格匹配域ID + items: + type: string + type: array + x-go-name: ProjectDomainIds + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_ids: + description: 对具有项目属性的资源，严格匹配项目ID + items: + type: string + type: array + x-go-name: ProjectIds + project_organizations: + description: filter by project organizations + items: + type: string + type: array + x-go-name: ProjectOrganizations + project_tags: + $ref: '#/definitions/TTagSetList' + res_type: + type: string + x-go-name: ResType + scope: + description: 指定查询的权限范围，可能值为project, domain or system + type: string + x-go-name: Scope + search: + description: 模糊搜索所有字段 + type: string + x-go-name: Search + show_emulated: + description: 显示所有的资源，包括模拟的资源 + type: boolean + x-go-name: ShowEmulated + show_fail_reason: + description: 返回结果携带delete_fail_reason和update_fail_reason字段 + type: boolean + x-go-name: ShowFailReason + status: + description: 以资源的状态过滤列表 + items: + type: string + type: array + x-go-name: Status + tags: + $ref: '#/definitions/TTagSet' + with_any_meta: + description: 返回包含任意标签的资源 + type: boolean + x-go-name: WithAnyMeta + with_cloud_meta: + description: 返回包含外部标签的资源 + type: boolean + x-go-name: WithCloudMeta + with_meta: + description: 返回列表数据中包含资源的标签数据（Metadata） + type: boolean + x-go-name: WithMeta + with_user_meta: + description: 返回包含用户标签的资源 + type: boolean + x-go-name: WithUserMeta + without_user_meta: + description: |- + deprecated + 返回资源的标签不包含用户标签 + type: boolean + x-go-name: WithoutUserMeta type: object - x-go-name: CustomizeConfig - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - level: - description: 报警级别 - type: string - x-go-name: Level - metric_type: - $ref: '#/definitions/MigrationAlertMetricType' - migration_settings: - $ref: '#/definitions/MigrationAlertSettings' - name: - description: 报警名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - period: - description: Period of querying metrics - type: string - x-go-name: Period - settings: - $ref: '#/definitions/AlertSetting' - threshold: - description: Threshold is the value to trigger migration - format: double - type: number - x-go-name: Threshold - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MigrationAlertMetricType: - type: string - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MigrationAlertSettings: - properties: - source: - $ref: '#/definitions/MigrationAlertSettingsSource' - target: - $ref: '#/definitions/MigrationAlertSettingsTarget' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MigrationAlertSettingsSource: - properties: - guest_ids: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricMeasurementUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + display_name: + type: string + x-go-name: DisplayName + name: + description: 资源名称 + type: string + x-go-name: Name + res_type: + type: string + x-go-name: ResType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricQuery: + properties: + alias: + type: string + x-go-name: Alias + database: + type: string + x-go-name: Database + group_by: + items: + $ref: '#/definitions/MetricQueryPart' + type: array + x-go-name: GroupBy + interval: + type: string + x-go-name: Interval + measurement: + type: string + x-go-name: Measurement + policy: + type: string + x-go-name: Policy + result_format: + type: string + x-go-name: ResultFormat + select: + items: + $ref: '#/definitions/MetricQuerySelect' + type: array + x-go-name: Selects + tags: + items: + $ref: '#/definitions/MetricQueryTag' + type: array + x-go-name: Tags + tz: + type: string + x-go-name: Tz + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricQueryPart: + properties: + params: + items: + type: string + type: array + x-go-name: Params + type: + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricQuerySelect: items: - type: string + $ref: '#/definitions/MetricQueryPart' type: array - x-go-name: GuestIds - host_ids: + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricQueryTag: + properties: + condition: + type: string + x-go-name: Condition + key: + type: string + x-go-name: Key + operator: + type: string + x-go-name: Operator + value: + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricUpdateInput: + properties: + measurement: + $ref: '#/definitions/MetricMeasurementUpdateInput' + metric_fields: + items: + $ref: '#/definitions/MetricFieldUpdateInput' + type: array + x-go-name: MetricFields + scope: + type: string + x-go-name: Scope + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertCreateInput: + properties: + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + metric_type: + $ref: '#/definitions/MigrationAlertMetricType' + migration_settings: + $ref: '#/definitions/MigrationAlertSettings' + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + period: + description: Period of querying metrics + type: string + x-go-name: Period + settings: + $ref: '#/definitions/AlertSetting' + threshold: + description: Threshold is the value to trigger migration + format: double + type: number + x-go-name: Threshold + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertMetricType: + type: string + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertSettings: + properties: + source: + $ref: '#/definitions/MigrationAlertSettingsSource' + target: + $ref: '#/definitions/MigrationAlertSettingsTarget' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertSettingsSource: + properties: + guest_ids: + items: + type: string + type: array + x-go-name: GuestIds + host_ids: + items: + type: string + type: array + x-go-name: HostIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertSettingsTarget: + properties: + host_ids: + items: + type: string + type: array + x-go-name: HostIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MonitorResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + alert_status: + type: string + x-go-name: AlertStatus + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + is_system: + description: 'description: indicate the resource is a system resource, which is not visible to user' + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + res_id: + type: string + x-go-name: ResId + res_type: + type: string + x-go-name: ResType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MonitorResourceDetails: + properties: + access_ip: + type: string + x-go-name: AccessIp + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_health_status: + description: 云账号监控状态 + type: string + x-go-name: AccountHealthStatus + account_read_only: + type: boolean + x-go-name: AccountReadOnly + account_status: + description: 云账号状态 + type: string + x-go-name: AccountStatus + attach_alert_count: + format: int64 + type: integer + x-go-name: AttachAlertCount + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + hypervisor: + type: string + x-go-name: Hypervisor + ips: + type: string + x-go-name: Ips + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MonitorResourceJointDetails: + properties: + alert_name: + type: string + x-go-name: AlertName + alert_rule: + type: object + x-go-name: AlertRule + is_set_shield: + type: boolean + x-go-name: IsSetShield + level: + type: string + x-go-name: Level + res_id: + type: string + x-go-name: ResId + res_name: + type: string + x-go-name: ResName + res_type: + type: string + x-go-name: ResType + send_state: + type: string + x-go-name: SendState + state: + type: string + x-go-name: State + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + NodeAlertCreateInput: + properties: + channel: + description: '通知方式, 比如: email, mobile' + type: string + x-go-name: Channel + common_alert_create_input: + $ref: '#/definitions/CommonAlertCreateInput' + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + metric: + description: 监控指标名称 + type: string + x-go-name: Metric + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + node_id: + description: 监控资源 Id + type: string + x-go-name: NodeId + node_name: + description: 监控资源名称 + type: string + x-go-name: NodeName + period: + description: 查询指标周期 + type: string + x-go-name: Period + recipients: + description: 通知接受者 + type: string + x-go-name: Recipients + settings: + $ref: '#/definitions/AlertSetting' + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold + type: + description: '监控资源类型, 比如: guest, host' + type: string + x-go-name: Type + used_by: + type: string + x-go-name: UsedBy + window: + description: 每隔多久查询一次 + type: string + x-go-name: Window + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + NodeAlertDetails: + 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 + channel: + type: string + x-go-name: Channel + comparator: + type: string + x-go-name: Comparator + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + db: + type: string + x-go-name: DB + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + field: + type: string + x-go-name: Field + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + measurement: + type: string + x-go-name: Measurement + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + metric: + type: string + x-go-name: Metric + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + node_id: + type: string + x-go-name: NodeId + node_name: + type: string + x-go-name: NodeName + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + recipients: + type: string + x-go-name: Recipients + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + threshold: + format: double + type: number + x-go-name: Threshold + 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 + used_by: + type: string + x-go-name: UsedBy + window: + type: string + x-go-name: Window + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + NodeAlertUpdateInput: + properties: + channel: + description: '通知方式, 比如: email, mobile' + type: string + x-go-name: Channel + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + description: + description: 资源描述 + type: string + x-go-name: Description + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metric: + description: 监控指标名称 + type: string + x-go-name: Metric + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + node_id: + description: 监控资源 Id + type: string + x-go-name: NodeId + node_name: + description: 监控资源名称 + type: string + x-go-name: NodeName + period: + description: 查询指标周期 + type: string + x-go-name: Period + recipients: + description: 通知接受者 + type: string + x-go-name: Recipients + settings: + $ref: '#/definitions/AlertSetting' + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold + type: + description: '监控资源类型, 比如: guest, host' + type: string + x-go-name: Type + window: + description: 每隔多久查询一次 + type: string + x-go-name: Window + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + NotificationCreateInput: + properties: + disable_resolve_message: + description: 是否禁用报警恢复提醒 + type: boolean + x-go-name: DisableResolveMessage + frequency: + $ref: '#/definitions/Duration' + is_default: + description: 是否为默认通知配置 + type: boolean + x-go-name: IsDefault + name: + description: 报警通知名称 + type: string + x-go-name: Name + send_reminder: + description: 是否一直提醒 + type: boolean + x-go-name: SendReminder + settings: + description: 通知配置 + type: object + x-go-name: Settings + type: + description: 类型 + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + PanelDetails: + 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 + common_alert_metric_details: + items: + $ref: '#/definitions/CommonAlertMetricDetails' + type: array + x-go-name: CommonAlertMetricDetails + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + 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 + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + 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 + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + PerformChangeProjectOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformFreezeInput: + 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 + PerformUnfreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ProjectStatistic: + properties: + Count: + format: int64 + type: integer + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResultLogEntry: + properties: + data: + x-go-name: Data + message: + type: string + x-go-name: Message + title: ResultLogEntry represents log data for the alert evaluation. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + 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 + 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 + 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 + StatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TTagSet: items: - type: string + $ref: '#/definitions/STag' type: array - x-go-name: HostIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MigrationAlertSettingsTarget: - properties: - host_ids: + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: items: - type: string + $ref: '#/definitions/TTagSet' type: array - x-go-name: HostIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MonitorResourceCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + V1AlertUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + settings: + $ref: '#/definitions/AlertSetting' type: object - x-go-name: Metadata - alert_status: - type: string - x-go-name: AlertStatus - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - res_id: - type: string - x-go-name: ResId - res_type: - type: string - x-go-name: ResType - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MonitorResourceDetails: - properties: - access_ip: - type: string - x-go-name: AccessIp - account: - description: 云账号名称 - example: google-account - type: string - x-go-name: Account - attach_alert_count: - format: int64 - type: integer - x-go-name: AttachAlertCount - brand: - description: 云平台品牌 - example: Google - type: string - x-go-name: Brand - can_delete: - description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 - example: true - type: boolean - x-go-name: CanDelete - can_update: - description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 - example: true - type: boolean - x-go-name: CanUpdate - cloud_env: - description: 云环境 - example: public - type: string - x-go-name: CloudEnv - cloudregion: - description: 区域的名称 - type: string - x-go-name: Cloudregion - delete_fail_reason: - $ref: '#/definitions/Error' - environment: - description: Environment - type: string - x-go-name: Environment - hypervisor: - type: string - x-go-name: Hypervisor - ips: - type: string - x-go-name: Ips - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + VirtualJointResourceBaseUpdateInput: type: object - x-go-name: Metadata - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - provider: - description: 云平台名称 - example: Google - type: string - x-go-name: Provider - region: - description: 区域的名称 - example: Default - type: string - x-go-name: Region - region_ext_id: - description: 纳管云区域的Id - example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExtId - region_external_id: - description: 纳管云区域的组合Id(平台+Id) - example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 - type: string - x-go-name: RegionExternalId - region_id: - description: 区域的Id - example: default - type: string - x-go-name: RegionId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - MonitorResourceJointDetails: - properties: - alert_name: - type: string - x-go-name: AlertName - alert_rule: + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress type: object - x-go-name: AlertRule - is_set_shield: - type: boolean - x-go-name: IsSetShield - level: - type: string - x-go-name: Level - res_id: - type: string - x-go-name: ResId - res_name: - type: string - x-go-name: ResName - res_type: - type: string - x-go-name: ResType - send_state: - type: string - x-go-name: SendState - state: - type: string - x-go-name: State - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - NodeAlertCreateInput: - properties: - channel: - description: '通知方式, 比如: email, mobile' - type: string - x-go-name: Channel - common_alert_create_input: - $ref: '#/definitions/CommonAlertCreateInput' - comparator: - description: '比较运算符, 比如: >, <, >=, <=' - type: string - x-go-name: Comparator - customize_config: - description: customize info + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualResourceDetails: + 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 + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' type: object - x-go-name: CustomizeConfig - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - level: - description: 报警级别 - type: string - x-go-name: Level - metric: - description: 监控指标名称 - type: string - x-go-name: Metric - name: - description: 报警名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - node_id: - description: 监控资源 Id - type: string - x-go-name: NodeId - node_name: - description: 监控资源名称 - type: string - x-go-name: NodeName - period: - description: 查询指标周期 - type: string - x-go-name: Period - recipients: - description: 通知接受者 - type: string - x-go-name: Recipients - settings: - $ref: '#/definitions/AlertSetting' - threshold: - description: 报警阀值 - format: double - type: number - x-go-name: Threshold - type: - description: '监控资源类型, 比如: guest, host' - type: string - x-go-name: Type - used_by: - type: string - x-go-name: UsedBy - window: - description: 每隔多久查询一次 - type: string - x-go-name: Window - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - NodeAlertDetails: - 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 - channel: - type: string - x-go-name: Channel - comparator: - type: string - x-go-name: Comparator - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - customize_config: - type: object - x-go-name: CustomizeConfig - db: - type: string - x-go-name: DB - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: - type: object - x-go-name: EvalData - execution_error: - description: Silenced bool - type: string - x-go-name: ExecutionError - execution_error_state: - type: string - x-go-name: ExecutionErrorState - field: - type: string - x-go-name: Field - for: - description: |- - If an alert rule has a configured `For` and the query violates the configured threshold - it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any - notifications. Once the alert rule has been firing for more than `For` duration, it will - change to `Alerting` and send alert notifications. - format: int64 - type: integer - x-go-name: For - frequency: - description: Frequency is evaluate period - format: int64 - type: integer - x-go-name: Frequency - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - last_state_change: - format: date-time - type: string - x-go-name: LastStateChange - level: - type: string - x-go-name: Level - measurement: - type: string - x-go-name: Measurement - message: - type: string - x-go-name: Message - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - metric: - type: string - x-go-name: Metric - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - type: string - x-go-name: NoDataState - node_id: - type: string - x-go-name: NodeId - node_name: - type: string - x-go-name: NodeName - notifier_id: - type: string - x-go-name: NotifierId - period: - type: string - x-go-name: Period - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - recipients: - type: string - x-go-name: Recipients - res_type: - type: string - x-go-name: ResType - scope: - type: string - x-go-name: Scope - settings: - type: object - x-go-name: Settings - state: - type: string - x-go-name: State - state_changes: - format: int64 - type: integer - x-go-name: StateChanges - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - threshold: - format: double - type: number - x-go-name: Threshold - 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 - used_by: - type: string - x-go-name: UsedBy - window: - type: string - x-go-name: Window - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - NodeAlertUpdateInput: - properties: - channel: - description: '通知方式, 比如: email, mobile' - type: string - x-go-name: Channel - comparator: - description: '比较运算符, 比如: >, <, >=, <=' - type: string - x-go-name: Comparator - description: - description: 资源描述 - type: string - x-go-name: Description - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - level: - description: 报警级别 - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - metric: - description: 监控指标名称 - type: string - x-go-name: Metric - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - node_id: - description: 监控资源 Id - type: string - x-go-name: NodeId - node_name: - description: 监控资源名称 - type: string - x-go-name: NodeName - period: - description: 查询指标周期 - type: string - x-go-name: Period - recipients: - description: 通知接受者 - type: string - x-go-name: Recipients - settings: - $ref: '#/definitions/AlertSetting' - threshold: - description: 报警阀值 - format: double - type: number - x-go-name: Threshold - type: - description: '监控资源类型, 比如: guest, host' - type: string - x-go-name: Type - window: - description: 每隔多久查询一次 - type: string - x-go-name: Window - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - NotificationCreateInput: - properties: - disable_resolve_message: - description: 是否禁用报警恢复提醒 - type: boolean - x-go-name: DisableResolveMessage - frequency: - $ref: '#/definitions/Duration' - is_default: - description: 是否为默认通知配置 - type: boolean - x-go-name: IsDefault - name: - description: 报警通知名称 - type: string - x-go-name: Name - send_reminder: - description: 是否一直提醒 - type: boolean - x-go-name: SendReminder - settings: - description: 通知配置 - type: object - x-go-name: Settings - type: - description: 类型 - type: string - x-go-name: Type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - PanelDetails: - 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 - common_alert_metric_details: - items: - $ref: '#/definitions/CommonAlertMetricDetails' - type: array - x-go-name: CommonAlertMetricDetails - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - customize_config: - type: object - x-go-name: CustomizeConfig - 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 - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - eval_data: - type: object - x-go-name: EvalData - execution_error: - description: Silenced bool - type: string - x-go-name: ExecutionError - execution_error_state: - type: string - x-go-name: ExecutionErrorState - for: - description: |- - If an alert rule has a configured `For` and the query violates the configured threshold - it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any - notifications. Once the alert rule has been firing for more than `For` duration, it will - change to `Alerting` and send alert notifications. - format: int64 - type: integer - x-go-name: For - frequency: - description: Frequency is evaluate period - format: int64 - type: integer - x-go-name: Frequency - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - last_state_change: - format: date-time - type: string - x-go-name: LastStateChange - level: - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - metadata: - additionalProperties: - type: string - description: 标签 - type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - type: string - x-go-name: NoDataState - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - res_type: - type: string - x-go-name: ResType - scope: - type: string - x-go-name: Scope - settings: - type: object - x-go-name: Settings - state: - type: string - x-go-name: State - state_changes: - format: int64 - type: integer - x-go-name: StateChanges - status: - description: 资源状态 - type: string - x-go-name: Status - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - tenant_id: - description: 项目Id - type: string - x-go-name: ProjectId - 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 - used_by: - type: string - x-go-name: UsedBy - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - PerformChangeProjectOwnerInput: - properties: - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformDisableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformEnableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformFreezeInput: - 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 - PerformUnfreezeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ProjectStatistic: - properties: - Count: - format: int64 - type: integer - Id: - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PurgeSplitTableInput: - properties: - tables: - items: - type: string - type: array - x-go-name: Tables - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ResultLogEntry: - properties: - data: - type: object - x-go-name: Data - message: - type: string - x-go-name: Message - title: ResultLogEntry represents log data for the alert evaluation. - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - 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 - 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 - 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 - StatusStandaloneResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStatistic: - properties: - TotalCpuCount: - description: CPU总量 - format: int64 - type: integer - TotalDiskSizeMb: - description: 存储总量 - format: int64 - type: integer - TotalMemSizeMb: - description: 内存总量 - format: int64 - type: integer - status_info: - items: - $ref: '#/definitions/StatusStatisticStatusInfo' - type: array - x-go-name: StatusInfo - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStatisticStatusInfo: - properties: - Status: - type: string - pending_deleted_count: - description: |- - 回收站数量 - 需要指定pending_delete=all - format: int64 - type: integer - x-go-name: PendingDeletedCount - total_count: - description: 资源总数 - format: int64 - type: integer - x-go-name: TotalCount - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - TTagSet: - items: - $ref: '#/definitions/STag' - type: array - x-go-package: yunion.io/x/onecloud/pkg/util/tagutils - TTagSetList: - items: - $ref: '#/definitions/TTagSet' - type: array - x-go-package: yunion.io/x/onecloud/pkg/util/tagutils - V1AlertUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - enabled: - description: 启用报警 - type: boolean - x-go-name: Enabled - execution_error_state: - description: 报警执行错误将当前报警状态设置为对应的状态 - type: string - x-go-name: ExecutionErrorState - for: - description: 报警持续时间 - format: int64 - type: integer - x-go-name: For - frequency: - description: 报警执行频率 - format: int64 - type: integer - x-go-name: Frequency - level: - description: 报警级别 - type: string - x-go-name: Level - message: - type: string - x-go-name: Message - name: - description: 资源名称 - type: string - x-go-name: Name - no_data_state: - description: 没有收到监控指标时将当前报警状态设置为对应的状态 - type: string - x-go-name: NoDataState - settings: - $ref: '#/definitions/AlertSetting' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/monitor - VirtualJointResourceBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - VirtualResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - VirtualResourceDetails: - 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 - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis + x-go-package: yunion.io/x/onecloud/pkg/apis host: '"127.0.0.1:8889"' info: - contact: - email: lizexi@yunion.cn - name: Zexi Li - description: Monitor API - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html - version: "1.0" + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Cloudprovider API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" paths: - /alert_dash_boards: - get: - description: 列表 - operationId: alert_dash_board_ListItemFilter - parameters: - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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') - 支持的操作符如下： + /alert_dash_boards: + get: + description: 列表 + operationId: alert_dash_board_ListItemFilter + parameters: + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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 - responses: - "200": - $ref: '#/responses/alert_dash_board_ListItemFilterOutput' - summary: 列表 - tags: - - alert_dash_board - post: - description: 新建 - operationId: alert_dash_board_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - alert_dash_board: - $ref: '#/definitions/AlertDashBoardCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dash_board_ValidateCreateDataOutput' - summary: 新建 - tags: - - alert_dash_board - /alert_dash_boards/{id}: - delete: - description: 删除 - operationId: alert_dash_board_CustomizeDelete - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_dash_board_CustomizeDeleteOutput' - summary: 删除 - tags: - - alert_dash_board - get: - description: 获取详情 - operationId: alert_dash_board_FetchCustomizeColumns - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_dash_board_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - alert_dash_board - put: - description: 更新 - operationId: alert_dash_board_ValidateUpdateData - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_dash_board_ValidateUpdateDataOutput' - summary: 更新 - tags: - - alert_dash_board - /alert_dash_boards/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: alert_dash_board_GetDetailsClassMetadata - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_dash_board_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - alert_dash_board - post: - description: 执行操作ClassMetadata - operationId: alert_dash_board_PerformClassMetadata - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_dash_board: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dash_board_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - alert_dash_board - /alert_dash_boards/{id}/clone-dashboard: - post: - description: 执行操作CloneDashboard - operationId: alert_dash_board_PerformCloneDashboard - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_dash_board: - $ref: '#/definitions/AlertCloneDashboardInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dash_board_PerformCloneDashboardOutput' - summary: 执行操作CloneDashboard - tags: - - alert_dash_board - /alert_dash_boards/{id}/clone-panel: - post: - description: 执行操作ClonePanel - operationId: alert_dash_board_PerformClonePanel - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_dash_board: - $ref: '#/definitions/AlertClonePanelInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dash_board_PerformClonePanelOutput' - summary: 执行操作ClonePanel - tags: - - alert_dash_board - /alert_dash_boards/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: alert_dash_board_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 + responses: + "200": + $ref: '#/responses/alert_dash_board_ListItemFilterOutput' + summary: 列表 + tags: + - alert_dash_board + post: + description: 新建 + operationId: alert_dash_board_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_dash_board + /alert_dash_boards/{id}: + delete: + description: 删除 + operationId: alert_dash_board_CustomizeDelete + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_dash_board + get: + description: 获取详情 + operationId: alert_dash_board_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_dash_board + put: + description: 更新 + operationId: alert_dash_board_ValidateUpdateData + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_dash_board + /alert_dash_boards/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_dash_board_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_dash_board + post: + description: 执行操作ClassMetadata + operationId: alert_dash_board_PerformClassMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_dash_board + /alert_dash_boards/{id}/clone-dashboard: + post: + description: 执行操作CloneDashboard + operationId: alert_dash_board_PerformCloneDashboard + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertCloneDashboardInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformCloneDashboardOutput' + summary: 执行操作CloneDashboard + tags: + - alert_dash_board + /alert_dash_boards/{id}/clone-panel: + post: + description: 执行操作ClonePanel + operationId: alert_dash_board_PerformClonePanel + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertClonePanelInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformClonePanelOutput' + summary: 执行操作ClonePanel + tags: + - alert_dash_board + /alert_dash_boards/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_dash_board_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 alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_dash_board_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - alert_dash_board - /alert_dash_boards/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: alert_dash_board_PerformSetClassMetadata - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_dash_board: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dash_board_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - alert_dash_board - /alert_dash_boards/{id}/set-scope: - post: - description: 执行操作SetScope - operationId: alert_dash_board_PerformSetScope - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_dash_board_PerformSetScopeOutput' - summary: 执行操作SetScope - tags: - - alert_dash_board - /alert_dash_boards/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: alert_dash_board_PerformSetUserMetadata - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_dash_board: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dash_board_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - alert_dash_board - /alert_dash_boards/{id}/status: - get: - description: 获取指定信息Status - operationId: alert_dash_board_GetDetailsStatus - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_dash_board_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - alert_dash_board - post: - description: 执行操作Status - operationId: alert_dash_board_PerformStatus - parameters: - - description: The Id or Name of alert_dash_board - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_dash_board: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dash_board_PerformStatusOutput' - summary: 更新资源状态 - tags: - - alert_dash_board - /alert_dash_boards/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: alert_dash_board_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/alert_dash_board_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - alert_dash_board - /alert_dash_boards/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: alert_dash_board_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - alert_dash_board: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dash_board_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - alert_dash_board - /alert_dash_boards/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: alert_dash_board_GetPropertySplitable - responses: - "200": - $ref: '#/responses/alert_dash_board_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - alert_dash_board - /alert_dash_boards/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: alert_dash_board_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/alert_dash_board_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - alert_dash_board - /alert_dash_boards/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: alert_dash_board_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/alert_dash_board_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - alert_dash_board - /alert_dash_boards/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: alert_dash_board_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/alert_dash_board_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - alert_dash_board - /alert_dash_boards/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: alert_dash_board_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/alert_dash_board_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - alert_dash_board - /alert_dashboard_panels: - get: - description: 列表 - operationId: alert_dashboard_panel_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_dash_board + /alert_dash_boards/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: alert_dash_board_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - alert_dash_board + /alert_dash_boards/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_dash_board_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_dash_board + /alert_dash_boards/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: alert_dash_board_PerformSetOrgMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_dash_board + /alert_dash_boards/{id}/set-scope: + post: + description: 执行操作SetScope + operationId: alert_dash_board_PerformSetScope + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformSetScopeOutput' + summary: 执行操作SetScope + tags: + - alert_dash_board + /alert_dash_boards/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_dash_board_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_dash_board + /alert_dash_boards/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_dash_board_GetDetailsStatus + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_dash_board + post: + description: 执行操作Status + operationId: alert_dash_board_PerformStatus + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_dash_board + /alert_dash_boards/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_dash_board_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_dash_board + /alert_dash_boards/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_dash_board_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_dash_board + /alert_dash_boards/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_dash_board_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_dash_board + /alert_dash_boards/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_dash_board_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/alert_dash_board_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_dash_board + /alert_dash_boards/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_dash_board_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_dash_board + /alert_dash_boards/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_dash_board_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_dash_board + /alert_dash_boards/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_dash_board_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_dash_board + /alert_dashboard_panels: + get: + description: 列表 + operationId: alert_dashboard_panel_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/alert_dashboard_panel_ListItemFilterOutput' - summary: 列表 - tags: - - alert_dashboard_panel - post: - description: 新建 - operationId: alert_dashboard_panel_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - alert_dashboard_panel: - $ref: '#/definitions/JoinResourceBaseCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dashboard_panel_ValidateCreateDataOutput' - summary: 新建 - tags: - - alert_dashboard_panel - /alert_dashboard_panels/{id}: - delete: - description: 删除 - operationId: alert_dashboard_panel_CustomizeDelete - parameters: - - description: The Id or Name of alert_dashboard_panel - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_dashboard_panel_CustomizeDeleteOutput' - summary: 删除 - tags: - - alert_dashboard_panel - get: - description: 获取详情 - operationId: alert_dashboard_panel_FetchCustomizeColumns - parameters: - - description: The Id or Name of alert_dashboard_panel - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_dashboard_panel_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - alert_dashboard_panel - put: - description: 更新 - operationId: alert_dashboard_panel_ValidateUpdateData - parameters: - - description: The Id or Name of alert_dashboard_panel - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_dashboard_panel: - $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dashboard_panel_ValidateUpdateDataOutput' - summary: 更新 - tags: - - alert_dashboard_panel - /alert_dashboard_panels/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: alert_dashboard_panel_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/alert_dashboard_panel_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - alert_dashboard_panel - /alert_dashboard_panels/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: alert_dashboard_panel_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - alert_dashboard_panel: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_dashboard_panel_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - alert_dashboard_panel - /alert_dashboard_panels/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: alert_dashboard_panel_GetPropertySplitable - responses: - "200": - $ref: '#/responses/alert_dashboard_panel_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - alert_dashboard_panel - /alert_dashboard_panels/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: alert_dashboard_panel_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/alert_dashboard_panel_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - alert_dashboard_panel - /alert_notifications: - get: - description: 列表 - operationId: alert_notification_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/alert_dashboard_panel_ListItemFilterOutput' + summary: 列表 + tags: + - alert_dashboard_panel + post: + description: 新建 + operationId: alert_dashboard_panel_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JoinResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_dashboard_panel + /alert_dashboard_panels/{id}: + delete: + description: 删除 + operationId: alert_dashboard_panel_CustomizeDelete + parameters: + - description: The Id or Name of alert_dashboard_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_dashboard_panel + get: + description: 获取详情 + operationId: alert_dashboard_panel_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_dashboard_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_dashboard_panel + put: + description: 更新 + operationId: alert_dashboard_panel_ValidateUpdateData + parameters: + - description: The Id or Name of alert_dashboard_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_dashboard_panel + /alert_dashboard_panels/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_dashboard_panel_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_dashboard_panel + /alert_dashboard_panels/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_dashboard_panel_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_dashboard_panel + /alert_dashboard_panels/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_dashboard_panel_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_dashboard_panel + /alert_dashboard_panels/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_dashboard_panel_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/alert_dashboard_panel_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_dashboard_panel + /alert_notifications: + get: + description: 列表 + operationId: alert_notification_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - description: 类型 - in: query - name: type - type: string - x-go-name: Type - responses: - "200": - $ref: '#/responses/alert_notification_ListItemFilterOutput' - summary: 列表 - tags: - - alert_notification - post: - description: 新建 - operationId: alert_notification_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - alert_notification: - $ref: '#/definitions/NotificationCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_ValidateCreateDataOutput' - summary: 新建 - tags: - - alert_notification - /alert_notifications/{id}: - delete: - description: 删除 - operationId: alert_notification_CustomizeDelete - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_notification_CustomizeDeleteOutput' - summary: 删除 - tags: - - alert_notification - get: - description: 获取详情 - operationId: alert_notification_FetchCustomizeColumns - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_notification_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - alert_notification - put: - description: 更新 - operationId: alert_notification_ValidateUpdateData - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_notification: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_ValidateUpdateDataOutput' - summary: 更新 - tags: - - alert_notification - /alert_notifications/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: alert_notification_PerformCancelDelete - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_notification_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - alert_notification - /alert_notifications/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: alert_notification_PerformChangeOwner - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_notification: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - alert_notification - /alert_notifications/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: alert_notification_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_notification_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - alert_notification - /alert_notifications/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: alert_notification_GetDetailsClassMetadata - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_notification_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - alert_notification - post: - description: 执行操作ClassMetadata - operationId: alert_notification_PerformClassMetadata - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_notification: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - alert_notification - /alert_notifications/{id}/freeze: - post: - description: 执行操作Freeze - operationId: alert_notification_PerformFreeze - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_notification: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - alert_notification - /alert_notifications/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: alert_notification_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 类型 + in: query + name: type + type: string + x-go-name: Type + responses: + "200": + $ref: '#/responses/alert_notification_ListItemFilterOutput' + summary: 列表 + tags: + - alert_notification + post: + description: 新建 + operationId: alert_notification_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/NotificationCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_notification + /alert_notifications/{id}: + delete: + description: 删除 + operationId: alert_notification_CustomizeDelete + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_notification + get: + description: 获取详情 + operationId: alert_notification_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_notification + put: + description: 更新 + operationId: alert_notification_ValidateUpdateData + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_notification + /alert_notifications/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: alert_notification_PerformCancelDelete + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - alert_notification + /alert_notifications/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: alert_notification_PerformChangeOwner + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - alert_notification + /alert_notifications/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: alert_notification_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - alert_notification + /alert_notifications/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_notification_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_notification + post: + description: 执行操作ClassMetadata + operationId: alert_notification_PerformClassMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_notification + /alert_notifications/{id}/freeze: + post: + description: 执行操作Freeze + operationId: alert_notification_PerformFreeze + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - alert_notification + /alert_notifications/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_notification_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 alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_notification_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - alert_notification - /alert_notifications/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: alert_notification_PerformSetClassMetadata - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_notification: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - alert_notification - /alert_notifications/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: alert_notification_PerformSetUserMetadata - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_notification: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - alert_notification - /alert_notifications/{id}/status: - get: - description: 获取指定信息Status - operationId: alert_notification_GetDetailsStatus - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_notification_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - alert_notification - post: - description: 执行操作Status - operationId: alert_notification_PerformStatus - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_notification: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_PerformStatusOutput' - summary: 更新资源状态 - tags: - - alert_notification - /alert_notifications/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: alert_notification_PerformUnfreeze - parameters: - - description: The Id or Name of alert_notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_notification: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - alert_notification - /alert_notifications/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: alert_notification_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/alert_notification_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - alert_notification - /alert_notifications/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: alert_notification_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/alert_notification_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - alert_notification - /alert_notifications/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: alert_notification_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/alert_notification_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - alert_notification - /alert_notifications/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: alert_notification_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/alert_notification_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - alert_notification - /alert_notifications/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: alert_notification_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/alert_notification_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - alert_notification - /alert_notifications/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: alert_notification_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - alert_notification: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_notification_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - alert_notification - /alert_notifications/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: alert_notification_GetPropertySplitable - responses: - "200": - $ref: '#/responses/alert_notification_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - alert_notification - /alert_notifications/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: alert_notification_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/alert_notification_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - alert_notification - /alert_notifications/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: alert_notification_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/alert_notification_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - alert_notification - /alert_notifications/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: alert_notification_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/alert_notification_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - alert_notification - /alert_notifications/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: alert_notification_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/alert_notification_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - alert_notification - /alert_panels: - get: - description: 列表 - operationId: alert_panel_ListItemFilter - parameters: - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_notification + /alert_notifications/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: alert_notification_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - alert_notification + /alert_notifications/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_notification_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_notification + /alert_notifications/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: alert_notification_PerformSetOrgMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_notification + /alert_notifications/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_notification_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_notification + /alert_notifications/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_notification_GetDetailsStatus + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_notification + post: + description: 执行操作Status + operationId: alert_notification_PerformStatus + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_notification + /alert_notifications/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: alert_notification_PerformUnfreeze + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - alert_notification + /alert_notifications/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_notification_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_notification + /alert_notifications/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: alert_notification_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - alert_notification + /alert_notifications/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: alert_notification_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - alert_notification + /alert_notifications/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: alert_notification_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - alert_notification + /alert_notifications/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: alert_notification_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - alert_notification + /alert_notifications/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_notification_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_notification + /alert_notifications/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_notification_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_notification + /alert_notifications/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_notification_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/alert_notification_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_notification + /alert_notifications/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_notification_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_notification + /alert_notifications/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_notification_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_notification + /alert_notifications/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_notification_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_notification + /alert_panels: + get: + description: 列表 + operationId: alert_panel_ListItemFilter + parameters: + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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 - - in: query - name: dashboard_id - type: string - x-go-name: DashboardId - responses: - "200": - $ref: '#/responses/alert_panel_ListItemFilterOutput' - summary: 列表 - tags: - - alert_panel - post: - description: 新建 - operationId: alert_panel_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - alert_panel: - $ref: '#/definitions/AlertPanelCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_panel_ValidateCreateDataOutput' - summary: 新建 - tags: - - alert_panel - /alert_panels/{id}: - delete: - description: 删除 - operationId: alert_panel_CustomizeDelete - parameters: - - description: The Id or Name of alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_panel_CustomizeDeleteOutput' - summary: 删除 - tags: - - alert_panel - get: - description: 获取详情 - operationId: alert_panel_FetchCustomizeColumns - parameters: - - description: The Id or Name of alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_panel_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - alert_panel - put: - description: 更新 - operationId: alert_panel_ValidateUpdateData - parameters: - - description: The Id or Name of alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_panel_ValidateUpdateDataOutput' - summary: 更新 - tags: - - alert_panel - /alert_panels/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: alert_panel_GetDetailsClassMetadata - parameters: - - description: The Id or Name of alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_panel_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - alert_panel - post: - description: 执行操作ClassMetadata - operationId: alert_panel_PerformClassMetadata - parameters: - - description: The Id or Name of alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_panel: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_panel_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - alert_panel - /alert_panels/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: alert_panel_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 + - in: query + name: dashboard_id + type: string + x-go-name: DashboardId + responses: + "200": + $ref: '#/responses/alert_panel_ListItemFilterOutput' + summary: 列表 + tags: + - alert_panel + post: + description: 新建 + operationId: alert_panel_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_panel: + $ref: '#/definitions/AlertPanelCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_panel + /alert_panels/{id}: + delete: + description: 删除 + operationId: alert_panel_CustomizeDelete + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_panel + get: + description: 获取详情 + operationId: alert_panel_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_panel + put: + description: 更新 + operationId: alert_panel_ValidateUpdateData + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_panel + /alert_panels/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_panel_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_panel + post: + description: 执行操作ClassMetadata + operationId: alert_panel_PerformClassMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_panel + /alert_panels/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_panel_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 alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_panel_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - alert_panel - /alert_panels/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: alert_panel_PerformSetClassMetadata - parameters: - - description: The Id or Name of alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_panel: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_panel_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - alert_panel - /alert_panels/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: alert_panel_PerformSetUserMetadata - parameters: - - description: The Id or Name of alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_panel: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_panel_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - alert_panel - /alert_panels/{id}/status: - get: - description: 获取指定信息Status - operationId: alert_panel_GetDetailsStatus - parameters: - - description: The Id or Name of alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_panel_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - alert_panel - post: - description: 执行操作Status - operationId: alert_panel_PerformStatus - parameters: - - description: The Id or Name of alert_panel - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_panel: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_panel_PerformStatusOutput' - summary: 更新资源状态 - tags: - - alert_panel - /alert_panels/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: alert_panel_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/alert_panel_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - alert_panel - /alert_panels/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: alert_panel_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - alert_panel: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_panel_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - alert_panel - /alert_panels/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: alert_panel_GetPropertySplitable - responses: - "200": - $ref: '#/responses/alert_panel_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - alert_panel - /alert_panels/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: alert_panel_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/alert_panel_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - alert_panel - /alert_panels/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: alert_panel_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/alert_panel_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - alert_panel - /alert_panels/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: alert_panel_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/alert_panel_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - alert_panel - /alert_panels/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: alert_panel_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/alert_panel_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - alert_panel - /alert_record_shields: - get: - description: 列表 - operationId: alert_record_shield_ListItemFilter - parameters: - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_panel + /alert_panels/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: alert_panel_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - alert_panel + /alert_panels/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_panel_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_panel + /alert_panels/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: alert_panel_PerformSetOrgMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_panel + /alert_panels/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_panel_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_panel + /alert_panels/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_panel_GetDetailsStatus + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_panel + post: + description: 执行操作Status + operationId: alert_panel_PerformStatus + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_panel: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_panel + /alert_panels/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_panel_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_panel + /alert_panels/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_panel_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_panel: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_panel + /alert_panels/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_panel_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_panel + /alert_panels/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_panel_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/alert_panel_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_panel + /alert_panels/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_panel_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_panel + /alert_panels/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_panel_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_panel + /alert_panels/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_panel_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_panel + /alert_record_shields: + get: + description: 列表 + operationId: alert_record_shield_ListItemFilter + parameters: + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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 - - in: query - name: alert_name - type: string - x-go-name: AlertName - - in: query - name: res_type - type: string - x-go-name: ResType - - in: query - name: res_name - type: string - x-go-name: ResName - - in: query - name: res_id - type: string - x-go-name: ResId - - in: query - name: alert_id - type: string - x-go-name: AlertId - - format: date-time - in: query - name: start_time - type: string - x-go-name: StartTime - - format: date-time - in: query - name: end_time - type: string - x-go-name: EndTime - responses: - "200": - $ref: '#/responses/alert_record_shield_ListItemFilterOutput' - summary: 列表 - tags: - - alert_record_shield - post: - description: 新建 - operationId: alert_record_shield_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - alert_record_shield: - $ref: '#/definitions/AlertRecordShieldCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_shield_ValidateCreateDataOutput' - summary: 新建 - tags: - - alert_record_shield - /alert_record_shields/{id}: - delete: - description: 删除 - operationId: alert_record_shield_CustomizeDelete - parameters: - - description: The Id or Name of alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_shield_CustomizeDeleteOutput' - summary: 删除 - tags: - - alert_record_shield - get: - description: 获取详情 - operationId: alert_record_shield_FetchCustomizeColumns - parameters: - - description: The Id or Name of alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_shield_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - alert_record_shield - put: - description: 更新 - operationId: alert_record_shield_ValidateUpdateData - parameters: - - description: The Id or Name of alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record_shield: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_shield_ValidateUpdateDataOutput' - summary: 更新 - tags: - - alert_record_shield - /alert_record_shields/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: alert_record_shield_GetDetailsClassMetadata - parameters: - - description: The Id or Name of alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_shield_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - alert_record_shield - post: - description: 执行操作ClassMetadata - operationId: alert_record_shield_PerformClassMetadata - parameters: - - description: The Id or Name of alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record_shield: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_shield_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - alert_record_shield - /alert_record_shields/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: alert_record_shield_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 + - in: query + name: alert_name + type: string + x-go-name: AlertName + - in: query + name: res_type + type: string + x-go-name: ResType + - in: query + name: res_name + type: string + x-go-name: ResName + - in: query + name: res_id + type: string + x-go-name: ResId + - in: query + name: alert_id + type: string + x-go-name: AlertId + - format: date-time + in: query + name: start_time + type: string + x-go-name: StartTime + - format: date-time + in: query + name: end_time + type: string + x-go-name: EndTime + responses: + "200": + $ref: '#/responses/alert_record_shield_ListItemFilterOutput' + summary: 列表 + tags: + - alert_record_shield + post: + description: 新建 + operationId: alert_record_shield_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_record_shield + /alert_record_shields/{id}: + delete: + description: 删除 + operationId: alert_record_shield_CustomizeDelete + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_record_shield + get: + description: 获取详情 + operationId: alert_record_shield_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_record_shield + put: + description: 更新 + operationId: alert_record_shield_ValidateUpdateData + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_record_shield + /alert_record_shields/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_record_shield_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_record_shield + post: + description: 执行操作ClassMetadata + operationId: alert_record_shield_PerformClassMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_record_shield + /alert_record_shields/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_record_shield_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 alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_shield_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - alert_record_shield - /alert_record_shields/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: alert_record_shield_PerformSetClassMetadata - parameters: - - description: The Id or Name of alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record_shield: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_shield_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - alert_record_shield - /alert_record_shields/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: alert_record_shield_PerformSetUserMetadata - parameters: - - description: The Id or Name of alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record_shield: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_shield_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - alert_record_shield - /alert_record_shields/{id}/status: - get: - description: 获取指定信息Status - operationId: alert_record_shield_GetDetailsStatus - parameters: - - description: The Id or Name of alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_shield_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - alert_record_shield - post: - description: 执行操作Status - operationId: alert_record_shield_PerformStatus - parameters: - - description: The Id or Name of alert_record_shield - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record_shield: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_shield_PerformStatusOutput' - summary: 更新资源状态 - tags: - - alert_record_shield - /alert_record_shields/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: alert_record_shield_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/alert_record_shield_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - alert_record_shield - /alert_record_shields/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: alert_record_shield_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - alert_record_shield: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_shield_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - alert_record_shield - /alert_record_shields/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: alert_record_shield_GetPropertySplitable - responses: - "200": - $ref: '#/responses/alert_record_shield_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - alert_record_shield - /alert_record_shields/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: alert_record_shield_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/alert_record_shield_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - alert_record_shield - /alert_record_shields/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: alert_record_shield_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/alert_record_shield_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - alert_record_shield - /alert_record_shields/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: alert_record_shield_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/alert_record_shield_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - alert_record_shield - /alert_record_shields/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: alert_record_shield_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/alert_record_shield_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - alert_record_shield - /alert_records: - get: - description: 列表 - operationId: alert_record_ListItemFilter - parameters: - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_record_shield + /alert_record_shields/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: alert_record_shield_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - alert_record_shield + /alert_record_shields/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_record_shield_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_record_shield + /alert_record_shields/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: alert_record_shield_PerformSetOrgMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_record_shield + /alert_record_shields/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_record_shield_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_record_shield + /alert_record_shields/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_record_shield_GetDetailsStatus + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_record_shield + post: + description: 执行操作Status + operationId: alert_record_shield_PerformStatus + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_record_shield + /alert_record_shields/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_record_shield_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_record_shield + /alert_record_shields/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_record_shield_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_record_shield: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_record_shield + /alert_record_shields/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_record_shield_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_record_shield + /alert_record_shields/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_record_shield_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/alert_record_shield_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_record_shield + /alert_record_shields/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_record_shield_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_record_shield + /alert_record_shields/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_record_shield_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_record_shield + /alert_record_shields/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_record_shield_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_record_shield + /alert_records: + get: + description: 列表 + operationId: alert_record_ListItemFilter + parameters: + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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 - - in: query - name: alert_id - type: string - x-go-name: AlertId - - in: query - name: level - type: string - x-go-name: Level - - in: query - name: state - type: string - x-go-name: State - - in: query - name: res_type - type: string - x-go-name: ResType - - in: query - name: alerting - type: boolean - x-go-name: Alerting - - in: query - name: res_name - type: string - x-go-name: ResName - responses: - "200": - $ref: '#/responses/alert_record_ListItemFilterOutput' - summary: 列表 - tags: - - alert_record - post: - description: 新建 - operationId: alert_record_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - alert_record: - $ref: '#/definitions/AlertRecordCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_ValidateCreateDataOutput' - summary: 新建 - tags: - - alert_record - /alert_records/{id}: - delete: - description: 删除 - operationId: alert_record_CustomizeDelete - parameters: - - description: The Id or Name of alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_CustomizeDeleteOutput' - summary: 删除 - tags: - - alert_record - get: - description: 获取详情 - operationId: alert_record_FetchCustomizeColumns - parameters: - - description: The Id or Name of alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - alert_record - put: - description: 更新 - operationId: alert_record_ValidateUpdateData - parameters: - - description: The Id or Name of alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_ValidateUpdateDataOutput' - summary: 更新 - tags: - - alert_record - /alert_records/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: alert_record_GetDetailsClassMetadata - parameters: - - description: The Id or Name of alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - alert_record - post: - description: 执行操作ClassMetadata - operationId: alert_record_PerformClassMetadata - parameters: - - description: The Id or Name of alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - alert_record - /alert_records/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: alert_record_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 + - in: query + name: alert_id + type: string + x-go-name: AlertId + - in: query + name: level + type: string + x-go-name: Level + - in: query + name: state + type: string + x-go-name: State + - in: query + name: res_type + type: string + x-go-name: ResType + - in: query + name: alerting + type: boolean + x-go-name: Alerting + - in: query + name: res_name + type: string + x-go-name: ResName + responses: + "200": + $ref: '#/responses/alert_record_ListItemFilterOutput' + summary: 列表 + tags: + - alert_record + post: + description: 新建 + operationId: alert_record_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_record + /alert_records/{id}: + delete: + description: 删除 + operationId: alert_record_CustomizeDelete + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_record + get: + description: 获取详情 + operationId: alert_record_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_record + put: + description: 更新 + operationId: alert_record_ValidateUpdateData + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_record + /alert_records/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_record_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_record + post: + description: 执行操作ClassMetadata + operationId: alert_record_PerformClassMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_record + /alert_records/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_record_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 alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - alert_record - /alert_records/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: alert_record_PerformSetClassMetadata - parameters: - - description: The Id or Name of alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - alert_record - /alert_records/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: alert_record_PerformSetUserMetadata - parameters: - - description: The Id or Name of alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - alert_record - /alert_records/{id}/status: - get: - description: 获取指定信息Status - operationId: alert_record_GetDetailsStatus - parameters: - - description: The Id or Name of alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_record_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - alert_record - post: - description: 执行操作Status - operationId: alert_record_PerformStatus - parameters: - - description: The Id or Name of alert_record - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_record: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_PerformStatusOutput' - summary: 更新资源状态 - tags: - - alert_record - /alert_records/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: alert_record_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/alert_record_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - alert_record - /alert_records/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: alert_record_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - alert_record: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_record_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - alert_record - /alert_records/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: alert_record_GetPropertySplitable - responses: - "200": - $ref: '#/responses/alert_record_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - alert_record - /alert_records/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: alert_record_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/alert_record_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - alert_record - /alert_records/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: alert_record_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/alert_record_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - alert_record - /alert_records/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: alert_record_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/alert_record_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - alert_record - /alert_records/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: alert_record_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/alert_record_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - alert_record - /alert_records/total-alert: - get: - description: 获取指定资源类的信息TotalAlert - operationId: alert_record_GetPropertyTotalAlert - responses: - "200": - $ref: '#/responses/alert_record_GetPropertyTotalAlertOutput' - summary: 获取指定资源类的信息TotalAlert - tags: - - alert_record - /alert_resource_alerts: - get: - description: 列表 - operationId: alert_resource_alert_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_record + /alert_records/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: alert_record_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - alert_record + /alert_records/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_record_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_record + /alert_records/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: alert_record_PerformSetOrgMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_record + /alert_records/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_record_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_record + /alert_records/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_record_GetDetailsStatus + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_record + post: + description: 执行操作Status + operationId: alert_record_PerformStatus + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_record + /alert_records/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_record_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_record + /alert_records/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_record_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_record: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_record + /alert_records/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_record_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_record_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_record + /alert_records/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_record_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/alert_record_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_record + /alert_records/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_record_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_record + /alert_records/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_record_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_record + /alert_records/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_record_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_record + /alert_records/total-alert: + get: + description: 获取指定资源类的信息TotalAlert + operationId: alert_record_GetPropertyTotalAlert + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyTotalAlertOutput' + summary: 获取指定资源类的信息TotalAlert + tags: + - alert_record + /alert_resource_alerts: + get: + description: 列表 + operationId: alert_resource_alert_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 - name: alert_resource_id - type: string - x-go-name: AlertResourceId - - in: query - name: alert_id - type: string - x-go-name: AlertId - responses: - "200": - $ref: '#/responses/alert_resource_alert_ListItemFilterOutput' - summary: 列表 - tags: - - alert_resource_alert - post: - description: 新建 - operationId: alert_resource_alert_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - alert_resource_alert: - $ref: '#/definitions/JoinResourceBaseCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_resource_alert_ValidateCreateDataOutput' - summary: 新建 - tags: - - alert_resource_alert - /alert_resource_alerts/{id}: - delete: - description: 删除 - operationId: alert_resource_alert_CustomizeDelete - parameters: - - description: The Id or Name of alert_resource_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_resource_alert_CustomizeDeleteOutput' - summary: 删除 - tags: - - alert_resource_alert - get: - description: 获取详情 - operationId: alert_resource_alert_FetchCustomizeColumns - parameters: - - description: The Id or Name of alert_resource_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_resource_alert_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - alert_resource_alert - put: - description: 更新 - operationId: alert_resource_alert_ValidateUpdateData - parameters: - - description: The Id or Name of alert_resource_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_resource_alert: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_resource_alert_ValidateUpdateDataOutput' - summary: 更新 - tags: - - alert_resource_alert - /alert_resource_alerts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: alert_resource_alert_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/alert_resource_alert_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - alert_resource_alert - /alert_resource_alerts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: alert_resource_alert_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - alert_resource_alert: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_resource_alert_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - alert_resource_alert - /alert_resource_alerts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: alert_resource_alert_GetPropertySplitable - responses: - "200": - $ref: '#/responses/alert_resource_alert_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - alert_resource_alert - /alert_resource_alerts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: alert_resource_alert_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/alert_resource_alert_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - alert_resource_alert - /alert_resources: - get: - description: 列表 - operationId: alert_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 + - in: query + name: alert_resource_id + type: string + x-go-name: AlertResourceId + - in: query + name: alert_id + type: string + x-go-name: AlertId + responses: + "200": + $ref: '#/responses/alert_resource_alert_ListItemFilterOutput' + summary: 列表 + tags: + - alert_resource_alert + post: + description: 新建 + operationId: alert_resource_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_resource_alert: + $ref: '#/definitions/JoinResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_resource_alert + /alert_resource_alerts/{id}: + delete: + description: 删除 + operationId: alert_resource_alert_CustomizeDelete + parameters: + - description: The Id or Name of alert_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_resource_alert + get: + description: 获取详情 + operationId: alert_resource_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_resource_alert + put: + description: 更新 + operationId: alert_resource_alert_ValidateUpdateData + parameters: + - description: The Id or Name of alert_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource_alert: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_resource_alert + /alert_resource_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_resource_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_resource_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_resource_alert + /alert_resource_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_resource_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_resource_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_resource_alert + /alert_resource_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_resource_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_resource_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_resource_alert + /alert_resource_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_resource_alert_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/alert_resource_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_resource_alert + /alert_resources: + get: + description: 列表 + operationId: alert_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 - - $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: type - type: string - x-go-name: Type - responses: - "200": - $ref: '#/responses/alert_resource_ListItemFilterOutput' - summary: 列表 - tags: - - alert_resource - post: - description: 新建 - operationId: alert_resource_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - alert_resource: - $ref: '#/definitions/StandaloneResourceCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_resource_ValidateCreateDataOutput' - summary: 新建 - tags: - - alert_resource - /alert_resources/{id}: - delete: - description: 删除 - operationId: alert_resource_CustomizeDelete - parameters: - - description: The Id or Name of alert_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_resource_CustomizeDeleteOutput' - summary: 删除 - tags: - - alert_resource - get: - description: 获取详情 - operationId: alert_resource_FetchCustomizeColumns - parameters: - - description: The Id or Name of alert_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_resource_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - alert_resource - put: - description: 更新 - operationId: alert_resource_ValidateUpdateData - parameters: - - description: The Id or Name of alert_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_resource: - $ref: '#/definitions/StandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_resource_ValidateUpdateDataOutput' - summary: 更新 - tags: - - alert_resource - /alert_resources/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: alert_resource_GetDetailsClassMetadata - parameters: - - description: The Id or Name of alert_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_resource_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - alert_resource - post: - description: 执行操作ClassMetadata - operationId: alert_resource_PerformClassMetadata - parameters: - - description: The Id or Name of alert_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_resource: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_resource_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - alert_resource - /alert_resources/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: alert_resource_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: type + type: string + x-go-name: Type + responses: + "200": + $ref: '#/responses/alert_resource_ListItemFilterOutput' + summary: 列表 + tags: + - alert_resource + post: + description: 新建 + operationId: alert_resource_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_resource: + $ref: '#/definitions/StandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_resource + /alert_resources/{id}: + delete: + description: 删除 + operationId: alert_resource_CustomizeDelete + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_resource + get: + description: 获取详情 + operationId: alert_resource_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_resource + put: + description: 更新 + operationId: alert_resource_ValidateUpdateData + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_resource + /alert_resources/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_resource_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_resource + post: + description: 执行操作ClassMetadata + operationId: alert_resource_PerformClassMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_resource + /alert_resources/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_resource_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 alert_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_resource_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - alert_resource - /alert_resources/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: alert_resource_PerformSetClassMetadata - parameters: - - description: The Id or Name of alert_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_resource: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_resource_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - alert_resource - /alert_resources/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: alert_resource_PerformSetUserMetadata - parameters: - - description: The Id or Name of alert_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert_resource: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_resource_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - alert_resource - /alert_resources/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: alert_resource_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/alert_resource_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - alert_resource - /alert_resources/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: alert_resource_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - alert_resource: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_resource_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - alert_resource - /alert_resources/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: alert_resource_GetPropertySplitable - responses: - "200": - $ref: '#/responses/alert_resource_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - alert_resource - /alert_resources/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: alert_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/alert_resource_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - alert_resource - /alert_resources/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: alert_resource_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/alert_resource_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - alert_resource - /alert_resources/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: alert_resource_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/alert_resource_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - alert_resource - /alerts: - get: - description: 列表 - operationId: alert_ListItemFilter - parameters: - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_resource + /alert_resources/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: alert_resource_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - alert_resource + /alert_resources/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_resource_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_resource + /alert_resources/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: alert_resource_PerformSetOrgMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_resource + /alert_resources/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_resource_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_resource + /alert_resources/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_resource_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_resource_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_resource + /alert_resources/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_resource_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_resource: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_resource + /alert_resources/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_resource_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_resource_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_resource + /alert_resources/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_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/alert_resource_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_resource + /alert_resources/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_resource_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_resource_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_resource + /alert_resources/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_resource_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_resource_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_resource + /alerts: + get: + description: 列表 + operationId: alert_ListItemFilter + parameters: + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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 - responses: - "200": - $ref: '#/responses/alert_ListItemFilterOutput' - summary: 列表 - tags: - - alert - post: - description: 新建 - operationId: alert_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - alert: - $ref: '#/definitions/AlertCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_ValidateCreateDataOutput' - summary: 新建 - tags: - - alert - /alerts/{id}: - delete: - description: 删除 - operationId: alert_CustomizeDelete - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_CustomizeDeleteOutput' - summary: 删除 - tags: - - alert - get: - description: 获取详情 - operationId: alert_FetchCustomizeColumns - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - alert - put: - description: 更新 - operationId: alert_ValidateUpdateData - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert: - $ref: '#/definitions/AlertUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_ValidateUpdateDataOutput' - summary: 更新 - tags: - - alert - /alerts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: alert_GetDetailsClassMetadata - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - alert - post: - description: 执行操作ClassMetadata - operationId: alert_PerformClassMetadata - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - alert - /alerts/{id}/disable: - post: - description: 执行操作Disable - operationId: alert_PerformDisable - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_PerformDisableOutput' - summary: 执行操作Disable - tags: - - alert - /alerts/{id}/enable: - post: - description: 执行操作Enable - operationId: alert_PerformEnable - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_PerformEnableOutput' - summary: 执行操作Enable - tags: - - alert - /alerts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: alert_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 + responses: + "200": + $ref: '#/responses/alert_ListItemFilterOutput' + summary: 列表 + tags: + - alert + post: + description: 新建 + operationId: alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/AlertCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert + /alerts/{id}: + delete: + description: 删除 + operationId: alert_CustomizeDelete + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert + get: + description: 获取详情 + operationId: alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert + put: + description: 更新 + operationId: alert_ValidateUpdateData + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/AlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert + /alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert + post: + description: 执行操作ClassMetadata + operationId: alert_PerformClassMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert + /alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: alert_PerformDisable + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - alert + /alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: alert_PerformEnable + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - alert + /alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_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 alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - alert - /alerts/{id}/pause: - post: - description: 执行操作Pause - operationId: alert_PerformPause - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert: - $ref: '#/definitions/AlertPauseInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_PerformPauseOutput' - summary: 执行操作Pause - tags: - - alert - /alerts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: alert_PerformSetClassMetadata - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - alert - /alerts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: alert_PerformSetUserMetadata - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - alert - /alerts/{id}/status: - get: - description: 获取指定信息Status - operationId: alert_GetDetailsStatus - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/alert_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - alert - post: - description: 执行操作Status - operationId: alert_PerformStatus - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_PerformStatusOutput' - summary: 更新资源状态 - tags: - - alert - /alerts/{id}/test-run: - post: - description: 执行操作TestRun - operationId: alert_PerformTestRun - parameters: - - description: The Id or Name of alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - alert: - $ref: '#/definitions/AlertTestRunInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_PerformTestRunOutput' - summary: 执行操作TestRun - tags: - - alert - /alerts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: alert_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/alert_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - alert - /alerts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: alert_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - alert: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/alert_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - alert - /alerts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: alert_GetPropertySplitable - responses: - "200": - $ref: '#/responses/alert_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - alert - /alerts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: alert_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/alert_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - alert - /alerts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: alert_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/alert_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - alert - /alerts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: alert_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/alert_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - alert - /alerts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: alert_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/alert_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - alert - /common_alerts: - get: - description: 列表 - operationId: common_alert_ListItemFilter - parameters: - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert + /alerts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: alert_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - alert + /alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: alert_PerformPause + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - alert + /alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert + /alerts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: alert_PerformSetOrgMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert + /alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert + /alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_GetDetailsStatus + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert + post: + description: 执行操作Status + operationId: alert_PerformStatus + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert + /alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: alert_PerformTestRun + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - alert + /alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert + /alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert + /alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert + /alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_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/alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert + /alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert + /alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert + /alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert + /common_alerts: + get: + description: 列表 + operationId: common_alert_ListItemFilter + parameters: + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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: status - type: array - x-go-name: Status - - description: |- - V1AlertListInput - 报警类型 - in: query - name: alert_type - type: string - x-go-name: AlertType - - description: 监控指标名称 - in: query - name: metric - type: string - x-go-name: Metric - - in: query - name: level - type: string - x-go-name: Level - - in: query - items: - type: string - name: res_type - type: array - x-go-name: ResType - - in: query - name: used_by - type: string - x-go-name: UsedBy - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: string - x-go-name: Name - responses: - "200": - $ref: '#/responses/common_alert_ListItemFilterOutput' - summary: 列表 - tags: - - common_alert - post: - description: 新建 - operationId: common_alert_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - common_alert: - $ref: '#/definitions/CommonAlertCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_ValidateCreateDataOutput' - summary: 新建 - tags: - - common_alert - /common_alerts/{id}: - delete: - description: 删除 - operationId: common_alert_CustomizeDelete - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/common_alert_CustomizeDeleteOutput' - summary: 删除 - tags: - - common_alert - get: - description: 获取详情 - operationId: common_alert_FetchCustomizeColumns - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/common_alert_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - common_alert - put: - description: 更新 - operationId: common_alert_ValidateUpdateData - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/common_alert_ValidateUpdateDataOutput' - summary: 更新 - tags: - - common_alert - /common_alerts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: common_alert_GetDetailsClassMetadata - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/common_alert_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - common_alert - post: - description: 执行操作ClassMetadata - operationId: common_alert_PerformClassMetadata - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - common_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - common_alert - /common_alerts/{id}/config: - post: - description: 执行操作Config - operationId: common_alert_PerformConfig - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/common_alert_PerformConfigOutput' - summary: 执行操作Config - tags: - - common_alert - /common_alerts/{id}/disable: - post: - description: 执行操作Disable - operationId: common_alert_PerformDisable - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - common_alert: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_PerformDisableOutput' - summary: 执行操作Disable - tags: - - common_alert - /common_alerts/{id}/enable: - post: - description: 执行操作Enable - operationId: common_alert_PerformEnable - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - common_alert: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_PerformEnableOutput' - summary: 执行操作Enable - tags: - - common_alert - /common_alerts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: common_alert_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: status + type: array + x-go-name: Status + - description: |- + V1AlertListInput + 报警类型 + in: query + name: alert_type + type: string + x-go-name: AlertType + - description: 监控指标名称 + in: query + name: metric + type: string + x-go-name: Metric + - in: query + name: level + type: string + x-go-name: Level + - in: query + items: + type: string + name: res_type + type: array + x-go-name: ResType + - in: query + name: used_by + type: string + x-go-name: UsedBy + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: string + x-go-name: Name + responses: + "200": + $ref: '#/responses/common_alert_ListItemFilterOutput' + summary: 列表 + tags: + - common_alert + post: + description: 新建 + operationId: common_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - common_alert + /common_alerts/{id}: + delete: + description: 删除 + operationId: common_alert_CustomizeDelete + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - common_alert + get: + description: 获取详情 + operationId: common_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - common_alert + put: + description: 更新 + operationId: common_alert_ValidateUpdateData + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - common_alert + /common_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: common_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - common_alert + post: + description: 执行操作ClassMetadata + operationId: common_alert_PerformClassMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - common_alert + /common_alerts/{id}/config: + post: + description: 执行操作Config + operationId: common_alert_PerformConfig + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_PerformConfigOutput' + summary: 执行操作Config + tags: + - common_alert + /common_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: common_alert_PerformDisable + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - common_alert + /common_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: common_alert_PerformEnable + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - common_alert + /common_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: common_alert_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 common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/common_alert_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - common_alert - /common_alerts/{id}/pause: - post: - description: 执行操作Pause - operationId: common_alert_PerformPause - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - common_alert: - $ref: '#/definitions/AlertPauseInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_PerformPauseOutput' - summary: 执行操作Pause - tags: - - common_alert - /common_alerts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: common_alert_PerformSetClassMetadata - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - common_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - common_alert - /common_alerts/{id}/set-scope: - post: - description: 执行操作SetScope - operationId: common_alert_PerformSetScope - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/common_alert_PerformSetScopeOutput' - summary: 执行操作SetScope - tags: - - common_alert - /common_alerts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: common_alert_PerformSetUserMetadata - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - common_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - common_alert - /common_alerts/{id}/status: - get: - description: 获取指定信息Status - operationId: common_alert_GetDetailsStatus - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/common_alert_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - common_alert - post: - description: 执行操作Status - operationId: common_alert_PerformStatus - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - common_alert: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_PerformStatusOutput' - summary: 更新资源状态 - tags: - - common_alert - /common_alerts/{id}/test-run: - post: - description: 执行操作TestRun - operationId: common_alert_PerformTestRun - parameters: - - description: The Id or Name of common_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - common_alert: - $ref: '#/definitions/AlertTestRunInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_PerformTestRunOutput' - summary: 执行操作TestRun - tags: - - common_alert - /common_alerts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: common_alert_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/common_alert_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - common_alert - /common_alerts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: common_alert_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - common_alert: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/common_alert_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - common_alert - /common_alerts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: common_alert_GetPropertySplitable - responses: - "200": - $ref: '#/responses/common_alert_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - common_alert - /common_alerts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: common_alert_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/common_alert_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - common_alert - /common_alerts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: common_alert_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/common_alert_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - common_alert - /common_alerts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: common_alert_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/common_alert_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - common_alert - /common_alerts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: common_alert_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/common_alert_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - common_alert - /data_sources: - get: - description: 列表 - operationId: data_source_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - common_alert + /common_alerts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: common_alert_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - common_alert + /common_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: common_alert_PerformPause + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - common_alert + /common_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: common_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - common_alert + /common_alerts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: common_alert_PerformSetOrgMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - common_alert + /common_alerts/{id}/set-scope: + post: + description: 执行操作SetScope + operationId: common_alert_PerformSetScope + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_PerformSetScopeOutput' + summary: 执行操作SetScope + tags: + - common_alert + /common_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: common_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - common_alert + /common_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: common_alert_GetDetailsStatus + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - common_alert + post: + description: 执行操作Status + operationId: common_alert_PerformStatus + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - common_alert + /common_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: common_alert_PerformTestRun + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - common_alert + /common_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: common_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/common_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - common_alert + /common_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: common_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - common_alert + /common_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: common_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/common_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - common_alert + /common_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: common_alert_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/common_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - common_alert + /common_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: common_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/common_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - common_alert + /common_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: common_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/common_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - common_alert + /common_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: common_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/common_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - common_alert + /data_sources: + get: + description: 列表 + operationId: data_source_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/data_source_ListItemFilterOutput' - summary: 列表 - tags: - - data_source - post: - description: 新建 - operationId: data_source_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - data_source: - $ref: '#/definitions/StandaloneResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/data_source_ValidateCreateDataOutput' - summary: 新建 - tags: - - data_source - /data_sources/{id}: - delete: - description: 删除 - operationId: data_source_CustomizeDelete - parameters: - - description: The Id or Name of data_source - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/data_source_CustomizeDeleteOutput' - summary: 删除 - tags: - - data_source - get: - description: 获取详情 - operationId: data_source_FetchCustomizeColumns - parameters: - - description: The Id or Name of data_source - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/data_source_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - data_source - put: - description: 更新 - operationId: data_source_ValidateUpdateData - parameters: - - description: The Id or Name of data_source - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - data_source: - $ref: '#/definitions/StandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/data_source_ValidateUpdateDataOutput' - summary: 更新 - tags: - - data_source - /data_sources/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: data_source_GetDetailsClassMetadata - parameters: - - description: The Id or Name of data_source - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/data_source_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - data_source - post: - description: 执行操作ClassMetadata - operationId: data_source_PerformClassMetadata - parameters: - - description: The Id or Name of data_source - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - data_source: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/data_source_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - data_source - /data_sources/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: data_source_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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/data_source_ListItemFilterOutput' + summary: 列表 + tags: + - data_source + post: + description: 新建 + operationId: data_source_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + data_source: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_ValidateCreateDataOutput' + summary: 新建 + tags: + - data_source + /data_sources/{id}: + delete: + description: 删除 + operationId: data_source_CustomizeDelete + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/data_source_CustomizeDeleteOutput' + summary: 删除 + tags: + - data_source + get: + description: 获取详情 + operationId: data_source_FetchCustomizeColumns + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/data_source_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - data_source + put: + description: 更新 + operationId: data_source_ValidateUpdateData + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_ValidateUpdateDataOutput' + summary: 更新 + tags: + - data_source + /data_sources/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: data_source_GetDetailsClassMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/data_source_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - data_source + post: + description: 执行操作ClassMetadata + operationId: data_source_PerformClassMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - data_source + /data_sources/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: data_source_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 data_source - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/data_source_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - data_source - /data_sources/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: data_source_PerformSetClassMetadata - parameters: - - description: The Id or Name of data_source - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - data_source: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/data_source_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - data_source - /data_sources/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: data_source_PerformSetUserMetadata - parameters: - - description: The Id or Name of data_source - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - data_source: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/data_source_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - data_source - /data_sources/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: data_source_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/data_source_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - data_source - /data_sources/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: data_source_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - data_source: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/data_source_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - data_source - /data_sources/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: data_source_GetPropertySplitable - responses: - "200": - $ref: '#/responses/data_source_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - data_source - /data_sources/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: data_source_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/data_source_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - data_source - /data_sources/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: data_source_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/data_source_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - data_source - /data_sources/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: data_source_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/data_source_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - data_source - /meter_alerts: - get: - description: 列表 - operationId: meter_alert_ListItemFilter - parameters: - - 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: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 data_source + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/data_source_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - data_source + /data_sources/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: data_source_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/data_source_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - data_source + /data_sources/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: data_source_PerformSetClassMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - data_source + /data_sources/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: data_source_PerformSetOrgMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - data_source + /data_sources/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: data_source_PerformSetUserMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - data_source + /data_sources/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: data_source_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/data_source_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - data_source + /data_sources/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: data_source_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + data_source: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - data_source + /data_sources/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: data_source_GetPropertySplitable + responses: + "200": + $ref: '#/responses/data_source_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - data_source + /data_sources/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: data_source_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/data_source_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - data_source + /data_sources/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: data_source_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/data_source_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - data_source + /data_sources/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: data_source_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/data_source_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - data_source + /meter_alerts: + get: + description: 列表 + operationId: meter_alert_ListItemFilter + parameters: + - 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: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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: '监控资源类型, 比如: balance, resFree, monthFee' - in: query - name: type - type: string - x-go-name: Type - - description: 云平台类型 - in: query - name: provider - type: string - x-go-name: Provider - - description: 云账号 Id - in: query - name: account_id - type: string - x-go-name: AccountId - - description: 项目 Id - in: query - name: project_id - type: string - x-go-name: ProjectId - responses: - "200": - $ref: '#/responses/meter_alert_ListItemFilterOutput' - summary: 列表 - tags: - - meter_alert - post: - description: 新建 - operationId: meter_alert_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - meter_alert: - $ref: '#/definitions/MeterAlertCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_ValidateCreateDataOutput' - summary: 新建 - tags: - - meter_alert - /meter_alerts/{id}: - delete: - description: 删除 - operationId: meter_alert_CustomizeDelete - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/meter_alert_CustomizeDeleteOutput' - summary: 删除 - tags: - - meter_alert - get: - description: 获取详情 - operationId: meter_alert_FetchCustomizeColumns - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/meter_alert_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - meter_alert - put: - description: 更新 - operationId: meter_alert_ValidateUpdateData - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - meter_alert: - $ref: '#/definitions/MeterAlertUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_ValidateUpdateDataOutput' - summary: 更新 - tags: - - meter_alert - /meter_alerts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: meter_alert_GetDetailsClassMetadata - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/meter_alert_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - meter_alert - post: - description: 执行操作ClassMetadata - operationId: meter_alert_PerformClassMetadata - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - meter_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - meter_alert - /meter_alerts/{id}/disable: - post: - description: 执行操作Disable - operationId: meter_alert_PerformDisable - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - meter_alert: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_PerformDisableOutput' - summary: 执行操作Disable - tags: - - meter_alert - /meter_alerts/{id}/enable: - post: - description: 执行操作Enable - operationId: meter_alert_PerformEnable - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - meter_alert: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_PerformEnableOutput' - summary: 执行操作Enable - tags: - - meter_alert - /meter_alerts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: meter_alert_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: '监控资源类型, 比如: balance, resFree, monthFee' + in: query + name: type + type: string + x-go-name: Type + - description: 云平台类型 + in: query + name: provider + type: string + x-go-name: Provider + - description: 云账号 Id + in: query + name: account_id + type: string + x-go-name: AccountId + - description: 项目 Id + in: query + name: project_id + type: string + x-go-name: ProjectId + responses: + "200": + $ref: '#/responses/meter_alert_ListItemFilterOutput' + summary: 列表 + tags: + - meter_alert + post: + description: 新建 + operationId: meter_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + meter_alert: + $ref: '#/definitions/MeterAlertCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - meter_alert + /meter_alerts/{id}: + delete: + description: 删除 + operationId: meter_alert_CustomizeDelete + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - meter_alert + get: + description: 获取详情 + operationId: meter_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - meter_alert + put: + description: 更新 + operationId: meter_alert_ValidateUpdateData + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - meter_alert + /meter_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: meter_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - meter_alert + post: + description: 执行操作ClassMetadata + operationId: meter_alert_PerformClassMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - meter_alert + /meter_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: meter_alert_PerformDisable + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - meter_alert + /meter_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: meter_alert_PerformEnable + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - meter_alert + /meter_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: meter_alert_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 meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/meter_alert_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - meter_alert - /meter_alerts/{id}/pause: - post: - description: 执行操作Pause - operationId: meter_alert_PerformPause - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - meter_alert: - $ref: '#/definitions/AlertPauseInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_PerformPauseOutput' - summary: 执行操作Pause - tags: - - meter_alert - /meter_alerts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: meter_alert_PerformSetClassMetadata - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - meter_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - meter_alert - /meter_alerts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: meter_alert_PerformSetUserMetadata - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - meter_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - meter_alert - /meter_alerts/{id}/status: - get: - description: 获取指定信息Status - operationId: meter_alert_GetDetailsStatus - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/meter_alert_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - meter_alert - post: - description: 执行操作Status - operationId: meter_alert_PerformStatus - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - meter_alert: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_PerformStatusOutput' - summary: 更新资源状态 - tags: - - meter_alert - /meter_alerts/{id}/test-run: - post: - description: 执行操作TestRun - operationId: meter_alert_PerformTestRun - parameters: - - description: The Id or Name of meter_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - meter_alert: - $ref: '#/definitions/AlertTestRunInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_PerformTestRunOutput' - summary: 执行操作TestRun - tags: - - meter_alert - /meter_alerts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: meter_alert_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/meter_alert_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - meter_alert - /meter_alerts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: meter_alert_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - meter_alert: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/meter_alert_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - meter_alert - /meter_alerts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: meter_alert_GetPropertySplitable - responses: - "200": - $ref: '#/responses/meter_alert_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - meter_alert - /meter_alerts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: meter_alert_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/meter_alert_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - meter_alert - /meter_alerts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: meter_alert_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/meter_alert_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - meter_alert - /meter_alerts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: meter_alert_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/meter_alert_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - meter_alert - /meter_alerts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: meter_alert_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/meter_alert_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - meter_alert - /metric_fields: - get: - description: 列表 - operationId: metric_field_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - meter_alert + /meter_alerts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: meter_alert_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - meter_alert + /meter_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: meter_alert_PerformPause + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - meter_alert + /meter_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: meter_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - meter_alert + /meter_alerts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: meter_alert_PerformSetOrgMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - meter_alert + /meter_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: meter_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - meter_alert + /meter_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: meter_alert_GetDetailsStatus + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - meter_alert + post: + description: 执行操作Status + operationId: meter_alert_PerformStatus + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - meter_alert + /meter_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: meter_alert_PerformTestRun + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - meter_alert + /meter_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: meter_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - meter_alert + /meter_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: meter_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - meter_alert + /meter_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: meter_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - meter_alert + /meter_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: meter_alert_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/meter_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - meter_alert + /meter_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: meter_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - meter_alert + /meter_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: meter_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - meter_alert + /meter_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: meter_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - meter_alert + /metric_fields: + get: + description: 列表 + operationId: metric_field_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: 指定项目归属域名称或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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - in: query - name: display_name - type: string - x-go-name: DisplayName - - in: query - name: unit - type: string - x-go-name: Unit - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/metric_field_ListItemFilterOutput' - summary: 列表 - tags: - - metric_field - post: - description: 新建 - operationId: metric_field_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - metric_field: - $ref: '#/definitions/MetricFieldCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_field_ValidateCreateDataOutput' - summary: 新建 - tags: - - metric_field - /metric_fields/{id}: - delete: - description: 删除 - operationId: metric_field_CustomizeDelete - parameters: - - description: The Id or Name of metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_field_CustomizeDeleteOutput' - summary: 删除 - tags: - - metric_field - get: - description: 获取详情 - operationId: metric_field_FetchCustomizeColumns - parameters: - - description: The Id or Name of metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_field_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - metric_field - put: - description: 更新 - operationId: metric_field_ValidateUpdateData - parameters: - - description: The Id or Name of metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_field: - $ref: '#/definitions/MetricFieldUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_field_ValidateUpdateDataOutput' - summary: 更新 - tags: - - metric_field - /metric_fields/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: metric_field_GetDetailsClassMetadata - parameters: - - description: The Id or Name of metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_field_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - metric_field - post: - description: 执行操作ClassMetadata - operationId: metric_field_PerformClassMetadata - parameters: - - description: The Id or Name of metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_field: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_field_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - metric_field - /metric_fields/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: metric_field_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: 指定项目归属域名称或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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - in: query + name: display_name + type: string + x-go-name: DisplayName + - in: query + name: unit + type: string + x-go-name: Unit + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/metric_field_ListItemFilterOutput' + summary: 列表 + tags: + - metric_field + post: + description: 新建 + operationId: metric_field_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + metric_field: + $ref: '#/definitions/MetricFieldCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_ValidateCreateDataOutput' + summary: 新建 + tags: + - metric_field + /metric_fields/{id}: + delete: + description: 删除 + operationId: metric_field_CustomizeDelete + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_CustomizeDeleteOutput' + summary: 删除 + tags: + - metric_field + get: + description: 获取详情 + operationId: metric_field_FetchCustomizeColumns + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - metric_field + put: + description: 更新 + operationId: metric_field_ValidateUpdateData + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_ValidateUpdateDataOutput' + summary: 更新 + tags: + - metric_field + /metric_fields/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: metric_field_GetDetailsClassMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - metric_field + post: + description: 执行操作ClassMetadata + operationId: metric_field_PerformClassMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - metric_field + /metric_fields/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: metric_field_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 metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_field_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - metric_field - /metric_fields/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: metric_field_PerformSetClassMetadata - parameters: - - description: The Id or Name of metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_field: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_field_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - metric_field - /metric_fields/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: metric_field_PerformSetUserMetadata - parameters: - - description: The Id or Name of metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_field: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_field_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - metric_field - /metric_fields/{id}/status: - get: - description: 获取指定信息Status - operationId: metric_field_GetDetailsStatus - parameters: - - description: The Id or Name of metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_field_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - metric_field - post: - description: 执行操作Status - operationId: metric_field_PerformStatus - parameters: - - description: The Id or Name of metric_field - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_field: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_field_PerformStatusOutput' - summary: 更新资源状态 - tags: - - metric_field - /metric_fields/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: metric_field_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/metric_field_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - metric_field - /metric_fields/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: metric_field_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - metric_field: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_field_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - metric_field - /metric_fields/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: metric_field_GetPropertySplitable - responses: - "200": - $ref: '#/responses/metric_field_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - metric_field - /metric_fields/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: metric_field_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/metric_field_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - metric_field - /metric_fields/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: metric_field_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/metric_field_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - metric_field - /metric_fields/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: metric_field_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/metric_field_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - metric_field - /metric_fields/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: metric_field_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/metric_field_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - metric_field - /metric_measurements: - get: - description: 列表 - operationId: metric_measurement_ListItemFilter - parameters: - - $ref: '#/definitions/MetricMeasurementListInput' - in: query - name: measurement - x-go-name: Measurement - - $ref: '#/definitions/MetricFieldListInput' - in: query - name: metric_fields - x-go-name: MetricFields - - in: query - name: scope - type: string - x-go-name: Scope - responses: - "200": - $ref: '#/responses/metric_measurement_ListItemFilterOutput' - summary: 列表 - tags: - - metric_measurement - post: - description: 新建 - operationId: metric_measurement_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - metric_measurement: - $ref: '#/definitions/MetricCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_measurement_ValidateCreateDataOutput' - summary: 新建 - tags: - - metric_measurement - /metric_measurements/{id}: - delete: - description: 删除 - operationId: metric_measurement_CustomizeDelete - parameters: - - description: The Id or Name of metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_measurement_CustomizeDeleteOutput' - summary: 删除 - tags: - - metric_measurement - get: - description: 获取详情 - operationId: metric_measurement_FetchCustomizeColumns - parameters: - - description: The Id or Name of metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_measurement_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - metric_measurement - put: - description: 更新 - operationId: metric_measurement_ValidateUpdateData - parameters: - - description: The Id or Name of metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_measurement: - $ref: '#/definitions/MetricUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_measurement_ValidateUpdateDataOutput' - summary: 更新 - tags: - - metric_measurement - /metric_measurements/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: metric_measurement_GetDetailsClassMetadata - parameters: - - description: The Id or Name of metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_measurement_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - metric_measurement - post: - description: 执行操作ClassMetadata - operationId: metric_measurement_PerformClassMetadata - parameters: - - description: The Id or Name of metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_measurement: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_measurement_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - metric_measurement - /metric_measurements/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: metric_measurement_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 metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - metric_field + /metric_fields/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: metric_field_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - metric_field + /metric_fields/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: metric_field_PerformSetClassMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - metric_field + /metric_fields/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: metric_field_PerformSetOrgMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - metric_field + /metric_fields/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: metric_field_PerformSetUserMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - metric_field + /metric_fields/{id}/status: + get: + description: 获取指定信息Status + operationId: metric_field_GetDetailsStatus + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - metric_field + post: + description: 执行操作Status + operationId: metric_field_PerformStatus + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformStatusOutput' + summary: 更新资源状态 + tags: + - metric_field + /metric_fields/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: metric_field_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/metric_field_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - metric_field + /metric_fields/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: metric_field_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + metric_field: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - metric_field + /metric_fields/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: metric_field_GetPropertySplitable + responses: + "200": + $ref: '#/responses/metric_field_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - metric_field + /metric_fields/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: metric_field_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/metric_field_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - metric_field + /metric_fields/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: metric_field_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/metric_field_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - metric_field + /metric_fields/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: metric_field_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/metric_field_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - metric_field + /metric_fields/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: metric_field_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/metric_field_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - metric_field + /metric_measurements: + get: + description: 列表 + operationId: metric_measurement_ListItemFilter + parameters: + - $ref: '#/definitions/MetricMeasurementListInput' + in: query + name: measurement + x-go-name: Measurement + - $ref: '#/definitions/MetricFieldListInput' + in: query + name: metric_fields + x-go-name: MetricFields + - in: query + name: scope + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/metric_measurement_ListItemFilterOutput' + summary: 列表 + tags: + - metric_measurement + post: + description: 新建 + operationId: metric_measurement_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + metric_measurement: + $ref: '#/definitions/MetricCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_ValidateCreateDataOutput' + summary: 新建 + tags: + - metric_measurement + /metric_measurements/{id}: + delete: + description: 删除 + operationId: metric_measurement_CustomizeDelete + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_CustomizeDeleteOutput' + summary: 删除 + tags: + - metric_measurement + get: + description: 获取详情 + operationId: metric_measurement_FetchCustomizeColumns + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - metric_measurement + put: + description: 更新 + operationId: metric_measurement_ValidateUpdateData + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_ValidateUpdateDataOutput' + summary: 更新 + tags: + - metric_measurement + /metric_measurements/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: metric_measurement_GetDetailsClassMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - metric_measurement + post: + description: 执行操作ClassMetadata + operationId: metric_measurement_PerformClassMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - metric_measurement + /metric_measurements/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: metric_measurement_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 metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_measurement_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - metric_measurement - /metric_measurements/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: metric_measurement_PerformSetClassMetadata - parameters: - - description: The Id or Name of metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_measurement: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_measurement_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - metric_measurement - /metric_measurements/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: metric_measurement_PerformSetUserMetadata - parameters: - - description: The Id or Name of metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_measurement: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_measurement_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - metric_measurement - /metric_measurements/{id}/status: - get: - description: 获取指定信息Status - operationId: metric_measurement_GetDetailsStatus - parameters: - - description: The Id or Name of metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_measurement_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - metric_measurement - post: - description: 执行操作Status - operationId: metric_measurement_PerformStatus - parameters: - - description: The Id or Name of metric_measurement - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric_measurement: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_measurement_PerformStatusOutput' - summary: 更新资源状态 - tags: - - metric_measurement - /metric_measurements/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: metric_measurement_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/metric_measurement_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - metric_measurement - /metric_measurements/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: metric_measurement_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - metric_measurement: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_measurement_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - metric_measurement - /metric_measurements/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: metric_measurement_GetPropertySplitable - responses: - "200": - $ref: '#/responses/metric_measurement_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - metric_measurement - /metric_measurements/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: metric_measurement_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/metric_measurement_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - metric_measurement - /metric_measurements/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: metric_measurement_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/metric_measurement_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - metric_measurement - /metric_measurements/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: metric_measurement_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/metric_measurement_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - metric_measurement - /metric_measurements/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: metric_measurement_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/metric_measurement_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - metric_measurement - /metrics: - get: - description: 列表 - operationId: metric_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - metric_measurement + /metric_measurements/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: metric_measurement_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - metric_measurement + /metric_measurements/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: metric_measurement_PerformSetClassMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - metric_measurement + /metric_measurements/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: metric_measurement_PerformSetOrgMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - metric_measurement + /metric_measurements/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: metric_measurement_PerformSetUserMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - metric_measurement + /metric_measurements/{id}/status: + get: + description: 获取指定信息Status + operationId: metric_measurement_GetDetailsStatus + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - metric_measurement + post: + description: 执行操作Status + operationId: metric_measurement_PerformStatus + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformStatusOutput' + summary: 更新资源状态 + tags: + - metric_measurement + /metric_measurements/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: metric_measurement_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - metric_measurement + /metric_measurements/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: metric_measurement_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + metric_measurement: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - metric_measurement + /metric_measurements/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: metric_measurement_GetPropertySplitable + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - metric_measurement + /metric_measurements/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: metric_measurement_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/metric_measurement_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - metric_measurement + /metric_measurements/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: metric_measurement_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - metric_measurement + /metric_measurements/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: metric_measurement_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - metric_measurement + /metric_measurements/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: metric_measurement_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - metric_measurement + /metrics: + get: + description: 列表 + operationId: metric_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/metric_ListItemFilterOutput' - summary: 列表 - tags: - - metric - post: - description: 新建 - operationId: metric_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - metric: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_ValidateCreateDataOutput' - summary: 新建 - tags: - - metric - /metrics/{id}: - delete: - description: 删除 - operationId: metric_CustomizeDelete - parameters: - - description: The Id or Name of metric - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_CustomizeDeleteOutput' - summary: 删除 - tags: - - metric - get: - description: 获取详情 - operationId: metric_FetchCustomizeColumns - parameters: - - description: The Id or Name of metric - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/metric_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - metric - put: - description: 更新 - operationId: metric_ValidateUpdateData - parameters: - - description: The Id or Name of metric - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - metric: - $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_ValidateUpdateDataOutput' - summary: 更新 - tags: - - metric - /metrics/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: metric_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/metric_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - metric - /metrics/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: metric_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - metric: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/metric_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - metric - /metrics/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: metric_GetPropertySplitable - responses: - "200": - $ref: '#/responses/metric_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - metric - /metrics/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: metric_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/metric_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - metric - /migration_alerts: - get: - description: 列表 - operationId: migration_alert_ListItemFilter - parameters: - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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/metric_ListItemFilterOutput' + summary: 列表 + tags: + - metric + post: + description: 新建 + operationId: metric_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + metric: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_ValidateCreateDataOutput' + summary: 新建 + tags: + - metric + /metrics/{id}: + delete: + description: 删除 + operationId: metric_CustomizeDelete + parameters: + - description: The Id or Name of metric + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_CustomizeDeleteOutput' + summary: 删除 + tags: + - metric + get: + description: 获取详情 + operationId: metric_FetchCustomizeColumns + parameters: + - description: The Id or Name of metric + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - metric + put: + description: 更新 + operationId: metric_ValidateUpdateData + parameters: + - description: The Id or Name of metric + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_ValidateUpdateDataOutput' + summary: 更新 + tags: + - metric + /metrics/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: metric_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/metric_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - metric + /metrics/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: metric_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + metric: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - metric + /metrics/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: metric_GetPropertySplitable + responses: + "200": + $ref: '#/responses/metric_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - metric + /metrics/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: metric_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/metric_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - metric + /migration_alerts: + get: + description: 列表 + operationId: migration_alert_ListItemFilter + parameters: + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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 - - in: query - name: metric_type - type: string - x-go-name: MetricType - responses: - "200": - $ref: '#/responses/migration_alert_ListItemFilterOutput' - summary: 列表 - tags: - - migration_alert - post: - description: 新建 - operationId: migration_alert_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - migration_alert: - $ref: '#/definitions/MigrationAlertCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_ValidateCreateDataOutput' - summary: 新建 - tags: - - migration_alert - /migration_alerts/{id}: - delete: - description: 删除 - operationId: migration_alert_CustomizeDelete - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/migration_alert_CustomizeDeleteOutput' - summary: 删除 - tags: - - migration_alert - get: - description: 获取详情 - operationId: migration_alert_FetchCustomizeColumns - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/migration_alert_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - migration_alert - put: - description: 更新 - operationId: migration_alert_ValidateUpdateData - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - migration_alert: - $ref: '#/definitions/AlertUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_ValidateUpdateDataOutput' - summary: 更新 - tags: - - migration_alert - /migration_alerts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: migration_alert_GetDetailsClassMetadata - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/migration_alert_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - migration_alert - post: - description: 执行操作ClassMetadata - operationId: migration_alert_PerformClassMetadata - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - migration_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - migration_alert - /migration_alerts/{id}/disable: - post: - description: 执行操作Disable - operationId: migration_alert_PerformDisable - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - migration_alert: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_PerformDisableOutput' - summary: 执行操作Disable - tags: - - migration_alert - /migration_alerts/{id}/enable: - post: - description: 执行操作Enable - operationId: migration_alert_PerformEnable - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - migration_alert: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_PerformEnableOutput' - summary: 执行操作Enable - tags: - - migration_alert - /migration_alerts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: migration_alert_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 + - in: query + name: metric_type + type: string + x-go-name: MetricType + responses: + "200": + $ref: '#/responses/migration_alert_ListItemFilterOutput' + summary: 列表 + tags: + - migration_alert + post: + description: 新建 + operationId: migration_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + migration_alert: + $ref: '#/definitions/MigrationAlertCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - migration_alert + /migration_alerts/{id}: + delete: + description: 删除 + operationId: migration_alert_CustomizeDelete + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - migration_alert + get: + description: 获取详情 + operationId: migration_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - migration_alert + put: + description: 更新 + operationId: migration_alert_ValidateUpdateData + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - migration_alert + /migration_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: migration_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - migration_alert + post: + description: 执行操作ClassMetadata + operationId: migration_alert_PerformClassMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - migration_alert + /migration_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: migration_alert_PerformDisable + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - migration_alert + /migration_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: migration_alert_PerformEnable + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - migration_alert + /migration_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: migration_alert_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 migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/migration_alert_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - migration_alert - /migration_alerts/{id}/pause: - post: - description: 执行操作Pause - operationId: migration_alert_PerformPause - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - migration_alert: - $ref: '#/definitions/AlertPauseInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_PerformPauseOutput' - summary: 执行操作Pause - tags: - - migration_alert - /migration_alerts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: migration_alert_PerformSetClassMetadata - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - migration_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - migration_alert - /migration_alerts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: migration_alert_PerformSetUserMetadata - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - migration_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - migration_alert - /migration_alerts/{id}/status: - get: - description: 获取指定信息Status - operationId: migration_alert_GetDetailsStatus - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/migration_alert_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - migration_alert - post: - description: 执行操作Status - operationId: migration_alert_PerformStatus - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - migration_alert: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_PerformStatusOutput' - summary: 更新资源状态 - tags: - - migration_alert - /migration_alerts/{id}/test-run: - post: - description: 执行操作TestRun - operationId: migration_alert_PerformTestRun - parameters: - - description: The Id or Name of migration_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - migration_alert: - $ref: '#/definitions/AlertTestRunInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_PerformTestRunOutput' - summary: 执行操作TestRun - tags: - - migration_alert - /migration_alerts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: migration_alert_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/migration_alert_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - migration_alert - /migration_alerts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: migration_alert_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - migration_alert: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/migration_alert_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - migration_alert - /migration_alerts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: migration_alert_GetPropertySplitable - responses: - "200": - $ref: '#/responses/migration_alert_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - migration_alert - /migration_alerts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: migration_alert_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/migration_alert_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - migration_alert - /migration_alerts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: migration_alert_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/migration_alert_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - migration_alert - /migration_alerts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: migration_alert_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/migration_alert_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - migration_alert - /migration_alerts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: migration_alert_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/migration_alert_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - migration_alert - /monitor_resource_alerts: - get: - description: 列表 - operationId: monitor_resource_alert_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - migration_alert + /migration_alerts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: migration_alert_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - migration_alert + /migration_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: migration_alert_PerformPause + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - migration_alert + /migration_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: migration_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - migration_alert + /migration_alerts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: migration_alert_PerformSetOrgMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - migration_alert + /migration_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: migration_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - migration_alert + /migration_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: migration_alert_GetDetailsStatus + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - migration_alert + post: + description: 执行操作Status + operationId: migration_alert_PerformStatus + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - migration_alert + /migration_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: migration_alert_PerformTestRun + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - migration_alert + /migration_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: migration_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - migration_alert + /migration_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: migration_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - migration_alert + /migration_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: migration_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - migration_alert + /migration_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: migration_alert_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/migration_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - migration_alert + /migration_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: migration_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - migration_alert + /migration_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: migration_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - migration_alert + /migration_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: migration_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - migration_alert + /monitor_resource_alerts: + get: + description: 列表 + operationId: monitor_resource_alert_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - in: query - name: monitor_resource_id - type: string - x-go-name: MonitorResourceId - - in: query - name: alert_id - type: string - x-go-name: AlertId - - in: query - items: - format: int64 - type: integer - name: joint_id - type: array - x-go-name: JointId - - in: query - name: alertinng - type: boolean - x-go-name: Alerting - - in: query - name: send_state - type: string - x-go-name: SendState - - in: query - name: res_type - type: string - x-go-name: ResType - - in: query - name: res_name - type: string - x-go-name: ResName - - in: query - name: alert_name - type: string - x-go-name: AlertName - - in: query - name: level - type: string - x-go-name: Level - responses: - "200": - $ref: '#/responses/monitor_resource_alert_ListItemFilterOutput' - summary: 列表 - tags: - - monitor_resource_alert - post: - description: 新建 - operationId: monitor_resource_alert_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - monitor_resource_alert: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_alert_ValidateCreateDataOutput' - summary: 新建 - tags: - - monitor_resource_alert - /monitor_resource_alerts/{id}: - delete: - description: 删除 - operationId: monitor_resource_alert_CustomizeDelete - parameters: - - description: The Id or Name of monitor_resource_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/monitor_resource_alert_CustomizeDeleteOutput' - summary: 删除 - tags: - - monitor_resource_alert - get: - description: 获取详情 - operationId: monitor_resource_alert_FetchCustomizeColumns - parameters: - - description: The Id or Name of monitor_resource_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/monitor_resource_alert_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - monitor_resource_alert - put: - description: 更新 - operationId: monitor_resource_alert_ValidateUpdateData - parameters: - - description: The Id or Name of monitor_resource_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - monitor_resource_alert: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_alert_ValidateUpdateDataOutput' - summary: 更新 - tags: - - monitor_resource_alert - /monitor_resource_alerts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: monitor_resource_alert_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/monitor_resource_alert_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - monitor_resource_alert - /monitor_resource_alerts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: monitor_resource_alert_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - monitor_resource_alert: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_alert_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - monitor_resource_alert - /monitor_resource_alerts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: monitor_resource_alert_GetPropertySplitable - responses: - "200": - $ref: '#/responses/monitor_resource_alert_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - monitor_resource_alert - /monitor_resource_alerts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: monitor_resource_alert_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/monitor_resource_alert_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - monitor_resource_alert - /monitor_resources: - get: - description: 列表 - operationId: monitor_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 + - $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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - in: query + name: monitor_resource_id + type: string + x-go-name: MonitorResourceId + - in: query + name: alert_id + type: string + x-go-name: AlertId + - in: query + items: + format: int64 + type: integer + name: joint_id + type: array + x-go-name: JointId + - in: query + name: alertinng + type: boolean + x-go-name: Alerting + - in: query + name: send_state + type: string + x-go-name: SendState + - in: query + name: res_type + type: string + x-go-name: ResType + - in: query + name: res_name + type: string + x-go-name: ResName + - in: query + name: alert_name + type: string + x-go-name: AlertName + - in: query + name: level + type: string + x-go-name: Level + responses: + "200": + $ref: '#/responses/monitor_resource_alert_ListItemFilterOutput' + summary: 列表 + tags: + - monitor_resource_alert + post: + description: 新建 + operationId: monitor_resource_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + monitor_resource_alert: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - monitor_resource_alert + /monitor_resource_alerts/{id}: + delete: + description: 删除 + operationId: monitor_resource_alert_CustomizeDelete + parameters: + - description: The Id or Name of monitor_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - monitor_resource_alert + get: + description: 获取详情 + operationId: monitor_resource_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of monitor_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - monitor_resource_alert + put: + description: 更新 + operationId: monitor_resource_alert_ValidateUpdateData + parameters: + - description: The Id or Name of monitor_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - monitor_resource_alert + /monitor_resource_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: monitor_resource_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/monitor_resource_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - monitor_resource_alert + /monitor_resource_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: monitor_resource_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - monitor_resource_alert + /monitor_resource_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: monitor_resource_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/monitor_resource_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - monitor_resource_alert + /monitor_resource_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: monitor_resource_alert_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/monitor_resource_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - monitor_resource_alert + /monitor_resources: + get: + description: 列表 + operationId: monitor_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 - - $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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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 | > 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: |- + 列出指定云平台的资源，支持的云平台如下 - Provider | 开始支持版本 | 平台 | - -----------|------------|-------------------------------------| - OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | - VMware | 1.2 | VMware vCenter | - OpenStack | 2.6 | OpenStack M版本以上私有云 | - ZStack | 2.10 | ZStack私有云 | - Aliyun | 2.0 | 阿里云 | - Aws | 2.3 | Amazon AWS | - Azure | 2.2 | Microsoft Azure | - Google | 2.13 | Google Cloud Platform | - Qcloud | 2.3 | 腾讯云 | - Huawei | 2.5 | 华为公有云 | - Ucloud | 2.7 | UCLOUD | - Ctyun | 2.13 | 天翼云 | - S3 | 2.11 | 通用s3对象存储 | - Ceph | 2.11 | Ceph对象存储 | - Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | - enum: - - OneCloud - - VMware - - Aliyun - - Qcloud - - Azure - - Aws - - Huawei - - OpenStack - - Ucloud - - ZStack - - Google - - Ctyun - - S3 - - Ceph - - Xsky" - in: query - items: - type: string - name: providers - type: array - x-go-name: Providers - - description: |- - 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band - Brand | Provider | 说明 | - ----------|----------|------------| - DStack | ZStack | 滴滴云私有云 | - in: query - items: - type: string - name: brands - type: array - x-go-name: Brands - - description: |- - 列出指定云环境的资源，支持云环境如下： + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： - CloudEnv | 说明 | - -----------|--------| - public | 公有云 | - private | 私有云 | - onpremise | 本地IDC | - enum: - - public - - private - - onpremise - in: query - name: cloud_env - type: string - x-go-name: CloudEnv - - description: 以平台名称排序 - in: query - name: order_by_provider - pattern: asc|desc - type: string - x-go-name: OrderByProvider - - description: 以平台品牌排序 - in: query - name: order_by_brand - pattern: asc|desc - type: string - x-go-name: OrderByBrand - - description: 列出关联指定云订阅(ID或Name)的资源 - in: query - name: cloudprovider_id - type: string - x-go-name: CloudproviderId - - description: 列出关联指定云账号(ID或Name)的资源 - in: query - items: - type: string - name: cloudaccount_id - type: array - x-go-name: CloudaccountId - - default: false - description: 过滤资源，是否为非OneCloud内置私有云管理的资源 - in: query - name: is_managed - type: boolean - x-go-name: IsManaged - - description: 以云账号名称排序 - in: query - name: order_by_account - pattern: asc|desc - type: string - x-go-name: OrderByAccount - - description: 以云订阅名称排序 - in: query - name: order_by_manager - pattern: asc|desc - type: string - x-go-name: OrderByManager - - in: query - items: - type: string - name: res_id - type: array - x-go-name: ResId - - in: query - name: res_type - type: string - x-go-name: ResType - - in: query - name: only_res_id - type: boolean - x-go-name: OnlyResId - - in: query - name: res_name - type: string - x-go-name: ResName - responses: - "200": - $ref: '#/responses/monitor_resource_ListItemFilterOutput' - summary: 列表 - tags: - - monitor_resource - post: - description: 新建 - operationId: monitor_resource_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - monitor_resource: - $ref: '#/definitions/MonitorResourceCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_ValidateCreateDataOutput' - summary: 新建 - tags: - - monitor_resource - /monitor_resources/{id}: - delete: - description: 删除 - operationId: monitor_resource_CustomizeDelete - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/monitor_resource_CustomizeDeleteOutput' - summary: 删除 - tags: - - monitor_resource - get: - description: 获取详情 - operationId: monitor_resource_FetchCustomizeColumns - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/monitor_resource_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - monitor_resource - put: - description: 更新 - operationId: monitor_resource_ValidateUpdateData - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - monitor_resource: - $ref: '#/definitions/VirtualResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_ValidateUpdateDataOutput' - summary: 更新 - tags: - - monitor_resource - /monitor_resources/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: monitor_resource_PerformCancelDelete - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/monitor_resource_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - monitor_resource - /monitor_resources/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: monitor_resource_PerformChangeOwner - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - monitor_resource: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - monitor_resource - /monitor_resources/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: monitor_resource_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/monitor_resource_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - monitor_resource - /monitor_resources/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: monitor_resource_GetDetailsClassMetadata - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/monitor_resource_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - monitor_resource - post: - description: 执行操作ClassMetadata - operationId: monitor_resource_PerformClassMetadata - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - monitor_resource: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - monitor_resource - /monitor_resources/{id}/freeze: - post: - description: 执行操作Freeze - operationId: monitor_resource_PerformFreeze - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - monitor_resource: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - monitor_resource - /monitor_resources/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: monitor_resource_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + items: + type: string + name: cloudprovider_id + type: array + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + items: + type: string + name: res_id + type: array + x-go-name: ResId + - in: query + name: res_type + type: string + x-go-name: ResType + - in: query + name: only_res_id + type: boolean + x-go-name: OnlyResId + - in: query + name: res_name + type: string + x-go-name: ResName + responses: + "200": + $ref: '#/responses/monitor_resource_ListItemFilterOutput' + summary: 列表 + tags: + - monitor_resource + post: + description: 新建 + operationId: monitor_resource_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + monitor_resource: + $ref: '#/definitions/MonitorResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_ValidateCreateDataOutput' + summary: 新建 + tags: + - monitor_resource + /monitor_resources/{id}: + delete: + description: 删除 + operationId: monitor_resource_CustomizeDelete + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_CustomizeDeleteOutput' + summary: 删除 + tags: + - monitor_resource + get: + description: 获取详情 + operationId: monitor_resource_FetchCustomizeColumns + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - monitor_resource + put: + description: 更新 + operationId: monitor_resource_ValidateUpdateData + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_ValidateUpdateDataOutput' + summary: 更新 + tags: + - monitor_resource + /monitor_resources/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: monitor_resource_PerformCancelDelete + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - monitor_resource + /monitor_resources/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: monitor_resource_PerformChangeOwner + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - monitor_resource + /monitor_resources/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: monitor_resource_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - monitor_resource + /monitor_resources/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: monitor_resource_GetDetailsClassMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - monitor_resource + post: + description: 执行操作ClassMetadata + operationId: monitor_resource_PerformClassMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - monitor_resource + /monitor_resources/{id}/freeze: + post: + description: 执行操作Freeze + operationId: monitor_resource_PerformFreeze + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - monitor_resource + /monitor_resources/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: monitor_resource_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 monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/monitor_resource_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - monitor_resource - /monitor_resources/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: monitor_resource_PerformSetClassMetadata - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - monitor_resource: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - monitor_resource - /monitor_resources/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: monitor_resource_PerformSetUserMetadata - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - monitor_resource: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - monitor_resource - /monitor_resources/{id}/status: - get: - description: 获取指定信息Status - operationId: monitor_resource_GetDetailsStatus - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/monitor_resource_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - monitor_resource - post: - description: 执行操作Status - operationId: monitor_resource_PerformStatus - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - monitor_resource: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_PerformStatusOutput' - summary: 更新资源状态 - tags: - - monitor_resource - /monitor_resources/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: monitor_resource_PerformUnfreeze - parameters: - - description: The Id or Name of monitor_resource - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - monitor_resource: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - monitor_resource - /monitor_resources/alert: - get: - description: 获取指定资源类的信息Alert - operationId: monitor_resource_GetPropertyAlert - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertyAlertOutput' - summary: 获取指定资源类的信息Alert - tags: - - monitor_resource - /monitor_resources/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: monitor_resource_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - monitor_resource - /monitor_resources/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: monitor_resource_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - monitor_resource - /monitor_resources/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: monitor_resource_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - monitor_resource - /monitor_resources/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: monitor_resource_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - monitor_resource - /monitor_resources/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: monitor_resource_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - monitor_resource - /monitor_resources/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: monitor_resource_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - monitor_resource: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/monitor_resource_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - monitor_resource - /monitor_resources/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: monitor_resource_GetPropertySplitable - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - monitor_resource - /monitor_resources/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: monitor_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/monitor_resource_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - monitor_resource - /monitor_resources/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: monitor_resource_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - monitor_resource - /monitor_resources/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: monitor_resource_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - monitor_resource - /monitor_resources/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: monitor_resource_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/monitor_resource_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - monitor_resource - /node_alerts: - get: - description: 列表 - operationId: node_alert_ListItemFilter - parameters: - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - monitor_resource + /monitor_resources/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: monitor_resource_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - monitor_resource + /monitor_resources/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: monitor_resource_PerformSetClassMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - monitor_resource + /monitor_resources/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: monitor_resource_PerformSetOrgMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - monitor_resource + /monitor_resources/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: monitor_resource_PerformSetUserMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - monitor_resource + /monitor_resources/{id}/status: + get: + description: 获取指定信息Status + operationId: monitor_resource_GetDetailsStatus + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - monitor_resource + post: + description: 执行操作Status + operationId: monitor_resource_PerformStatus + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformStatusOutput' + summary: 更新资源状态 + tags: + - monitor_resource + /monitor_resources/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: monitor_resource_PerformUnfreeze + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - monitor_resource + /monitor_resources/alert: + get: + description: 获取指定资源类的信息Alert + operationId: monitor_resource_GetPropertyAlert + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyAlertOutput' + summary: 获取指定资源类的信息Alert + tags: + - monitor_resource + /monitor_resources/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: monitor_resource_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - monitor_resource + /monitor_resources/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: monitor_resource_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - monitor_resource + /monitor_resources/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: monitor_resource_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - monitor_resource + /monitor_resources/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: monitor_resource_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - monitor_resource + /monitor_resources/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: monitor_resource_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - monitor_resource + /monitor_resources/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: monitor_resource_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - monitor_resource + /monitor_resources/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: monitor_resource_GetPropertySplitable + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - monitor_resource + /monitor_resources/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: monitor_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/monitor_resource_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - monitor_resource + /monitor_resources/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: monitor_resource_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - monitor_resource + /monitor_resources/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: monitor_resource_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - monitor_resource + /monitor_resources/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: monitor_resource_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - monitor_resource + /node_alerts: + get: + description: 列表 + operationId: node_alert_ListItemFilter + parameters: + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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: metric - type: string - x-go-name: Metric - - description: '监控资源类型, 比如: guest, host' - in: query - name: type - type: string - x-go-name: Type - - description: 监控资源名称 - in: query - name: node_name - type: string - x-go-name: NodeName - - description: 监控资源 Id - in: query - name: node_id - type: string - x-go-name: NodeId - responses: - "200": - $ref: '#/responses/node_alert_ListItemFilterOutput' - summary: 列表 - tags: - - node_alert - post: - description: 新建 - operationId: node_alert_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - node_alert: - $ref: '#/definitions/NodeAlertCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_ValidateCreateDataOutput' - summary: 新建 - tags: - - node_alert - /node_alerts/{id}: - delete: - description: 删除 - operationId: node_alert_CustomizeDelete - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/node_alert_CustomizeDeleteOutput' - summary: 删除 - tags: - - node_alert - get: - description: 获取详情 - operationId: node_alert_FetchCustomizeColumns - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/node_alert_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - node_alert - put: - description: 更新 - operationId: node_alert_ValidateUpdateData - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - node_alert: - $ref: '#/definitions/NodeAlertUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_ValidateUpdateDataOutput' - summary: 更新 - tags: - - node_alert - /node_alerts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: node_alert_GetDetailsClassMetadata - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/node_alert_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - node_alert - post: - description: 执行操作ClassMetadata - operationId: node_alert_PerformClassMetadata - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - node_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - node_alert - /node_alerts/{id}/config: - post: - description: 执行操作Config - operationId: node_alert_PerformConfig - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/node_alert_PerformConfigOutput' - summary: 执行操作Config - tags: - - node_alert - /node_alerts/{id}/disable: - post: - description: 执行操作Disable - operationId: node_alert_PerformDisable - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - node_alert: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_PerformDisableOutput' - summary: 执行操作Disable - tags: - - node_alert - /node_alerts/{id}/enable: - post: - description: 执行操作Enable - operationId: node_alert_PerformEnable - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - node_alert: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_PerformEnableOutput' - summary: 执行操作Enable - tags: - - node_alert - /node_alerts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: node_alert_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: metric + type: string + x-go-name: Metric + - description: '监控资源类型, 比如: guest, host' + in: query + name: type + type: string + x-go-name: Type + - description: 监控资源名称 + in: query + name: node_name + type: string + x-go-name: NodeName + - description: 监控资源 Id + in: query + name: node_id + type: string + x-go-name: NodeId + responses: + "200": + $ref: '#/responses/node_alert_ListItemFilterOutput' + summary: 列表 + tags: + - node_alert + post: + description: 新建 + operationId: node_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + node_alert: + $ref: '#/definitions/NodeAlertCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - node_alert + /node_alerts/{id}: + delete: + description: 删除 + operationId: node_alert_CustomizeDelete + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - node_alert + get: + description: 获取详情 + operationId: node_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - node_alert + put: + description: 更新 + operationId: node_alert_ValidateUpdateData + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - node_alert + /node_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: node_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - node_alert + post: + description: 执行操作ClassMetadata + operationId: node_alert_PerformClassMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - node_alert + /node_alerts/{id}/config: + post: + description: 执行操作Config + operationId: node_alert_PerformConfig + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_PerformConfigOutput' + summary: 执行操作Config + tags: + - node_alert + /node_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: node_alert_PerformDisable + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - node_alert + /node_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: node_alert_PerformEnable + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - node_alert + /node_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: node_alert_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 node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/node_alert_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - node_alert - /node_alerts/{id}/pause: - post: - description: 执行操作Pause - operationId: node_alert_PerformPause - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - node_alert: - $ref: '#/definitions/AlertPauseInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_PerformPauseOutput' - summary: 执行操作Pause - tags: - - node_alert - /node_alerts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: node_alert_PerformSetClassMetadata - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - node_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - node_alert - /node_alerts/{id}/set-scope: - post: - description: 执行操作SetScope - operationId: node_alert_PerformSetScope - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/node_alert_PerformSetScopeOutput' - summary: 执行操作SetScope - tags: - - node_alert - /node_alerts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: node_alert_PerformSetUserMetadata - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - node_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - node_alert - /node_alerts/{id}/status: - get: - description: 获取指定信息Status - operationId: node_alert_GetDetailsStatus - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/node_alert_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - node_alert - post: - description: 执行操作Status - operationId: node_alert_PerformStatus - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - node_alert: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_PerformStatusOutput' - summary: 更新资源状态 - tags: - - node_alert - /node_alerts/{id}/test-run: - post: - description: 执行操作TestRun - operationId: node_alert_PerformTestRun - parameters: - - description: The Id or Name of node_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - node_alert: - $ref: '#/definitions/AlertTestRunInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_PerformTestRunOutput' - summary: 执行操作TestRun - tags: - - node_alert - /node_alerts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: node_alert_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/node_alert_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - node_alert - /node_alerts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: node_alert_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - node_alert: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/node_alert_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - node_alert - /node_alerts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: node_alert_GetPropertySplitable - responses: - "200": - $ref: '#/responses/node_alert_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - node_alert - /node_alerts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: node_alert_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/node_alert_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - node_alert - /node_alerts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: node_alert_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/node_alert_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - node_alert - /node_alerts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: node_alert_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/node_alert_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - node_alert - /node_alerts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: node_alert_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/node_alert_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - node_alert - /v1_alerts: - get: - description: 列表 - operationId: v1_alert_ListItemFilter - parameters: - - 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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 指定匹配的范围，可能值为project, domain or system - in: query - name: belong_scope - type: string - x-go-name: BelongScope - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - 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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - node_alert + /node_alerts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: node_alert_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - node_alert + /node_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: node_alert_PerformPause + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - node_alert + /node_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: node_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - node_alert + /node_alerts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: node_alert_PerformSetOrgMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - node_alert + /node_alerts/{id}/set-scope: + post: + description: 执行操作SetScope + operationId: node_alert_PerformSetScope + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_PerformSetScopeOutput' + summary: 执行操作SetScope + tags: + - node_alert + /node_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: node_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - node_alert + /node_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: node_alert_GetDetailsStatus + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - node_alert + post: + description: 执行操作Status + operationId: node_alert_PerformStatus + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - node_alert + /node_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: node_alert_PerformTestRun + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - node_alert + /node_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: node_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/node_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - node_alert + /node_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: node_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - node_alert + /node_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: node_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/node_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - node_alert + /node_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: node_alert_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/node_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - node_alert + /node_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: node_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/node_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - node_alert + /node_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: node_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/node_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - node_alert + /node_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: node_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/node_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - node_alert + /v1_alerts: + get: + description: 列表 + operationId: v1_alert_ListItemFilter + parameters: + - 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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - 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 - responses: - "200": - $ref: '#/responses/v1_alert_ListItemFilterOutput' - summary: 列表 - tags: - - v1_alert - post: - description: 新建 - operationId: v1_alert_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - v1_alert: - $ref: '#/definitions/AlertCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_ValidateCreateDataOutput' - summary: 新建 - tags: - - v1_alert - /v1_alerts/{id}: - delete: - description: 删除 - operationId: v1_alert_CustomizeDelete - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/v1_alert_CustomizeDeleteOutput' - summary: 删除 - tags: - - v1_alert - get: - description: 获取详情 - operationId: v1_alert_FetchCustomizeColumns - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/v1_alert_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - v1_alert - put: - description: 更新 - operationId: v1_alert_ValidateUpdateData - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - v1_alert: - $ref: '#/definitions/V1AlertUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_ValidateUpdateDataOutput' - summary: 更新 - tags: - - v1_alert - /v1_alerts/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: v1_alert_GetDetailsClassMetadata - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/v1_alert_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - v1_alert - post: - description: 执行操作ClassMetadata - operationId: v1_alert_PerformClassMetadata - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - v1_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - v1_alert - /v1_alerts/{id}/disable: - post: - description: 执行操作Disable - operationId: v1_alert_PerformDisable - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - v1_alert: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_PerformDisableOutput' - summary: 执行操作Disable - tags: - - v1_alert - /v1_alerts/{id}/enable: - post: - description: 执行操作Enable - operationId: v1_alert_PerformEnable - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - v1_alert: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_PerformEnableOutput' - summary: 执行操作Enable - tags: - - v1_alert - /v1_alerts/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: v1_alert_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 + responses: + "200": + $ref: '#/responses/v1_alert_ListItemFilterOutput' + summary: 列表 + tags: + - v1_alert + post: + description: 新建 + operationId: v1_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + v1_alert: + $ref: '#/definitions/AlertCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - v1_alert + /v1_alerts/{id}: + delete: + description: 删除 + operationId: v1_alert_CustomizeDelete + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - v1_alert + get: + description: 获取详情 + operationId: v1_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - v1_alert + put: + description: 更新 + operationId: v1_alert_ValidateUpdateData + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/V1AlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - v1_alert + /v1_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: v1_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - v1_alert + post: + description: 执行操作ClassMetadata + operationId: v1_alert_PerformClassMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - v1_alert + /v1_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: v1_alert_PerformDisable + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - v1_alert + /v1_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: v1_alert_PerformEnable + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - v1_alert + /v1_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: v1_alert_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 v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/v1_alert_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - v1_alert - /v1_alerts/{id}/pause: - post: - description: 执行操作Pause - operationId: v1_alert_PerformPause - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - v1_alert: - $ref: '#/definitions/AlertPauseInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_PerformPauseOutput' - summary: 执行操作Pause - tags: - - v1_alert - /v1_alerts/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: v1_alert_PerformSetClassMetadata - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - v1_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - v1_alert - /v1_alerts/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: v1_alert_PerformSetUserMetadata - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - v1_alert: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - v1_alert - /v1_alerts/{id}/status: - get: - description: 获取指定信息Status - operationId: v1_alert_GetDetailsStatus - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/v1_alert_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - v1_alert - post: - description: 执行操作Status - operationId: v1_alert_PerformStatus - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - v1_alert: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_PerformStatusOutput' - summary: 更新资源状态 - tags: - - v1_alert - /v1_alerts/{id}/test-run: - post: - description: 执行操作TestRun - operationId: v1_alert_PerformTestRun - parameters: - - description: The Id or Name of v1_alert - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - v1_alert: - $ref: '#/definitions/AlertTestRunInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_PerformTestRunOutput' - summary: 执行操作TestRun - tags: - - v1_alert - /v1_alerts/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: v1_alert_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/v1_alert_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - v1_alert - /v1_alerts/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: v1_alert_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - v1_alert: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/v1_alert_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - v1_alert - /v1_alerts/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: v1_alert_GetPropertySplitable - responses: - "200": - $ref: '#/responses/v1_alert_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - v1_alert - /v1_alerts/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: v1_alert_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/v1_alert_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - v1_alert - /v1_alerts/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: v1_alert_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/v1_alert_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - v1_alert - /v1_alerts/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: v1_alert_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/v1_alert_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - v1_alert - /v1_alerts/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: v1_alert_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/v1_alert_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - v1_alert + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - v1_alert + /v1_alerts/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: v1_alert_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - v1_alert + /v1_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: v1_alert_PerformPause + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - v1_alert + /v1_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: v1_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - v1_alert + /v1_alerts/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: v1_alert_PerformSetOrgMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - v1_alert + /v1_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: v1_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - v1_alert + /v1_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: v1_alert_GetDetailsStatus + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - v1_alert + post: + description: 执行操作Status + operationId: v1_alert_PerformStatus + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - v1_alert + /v1_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: v1_alert_PerformTestRun + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - v1_alert + /v1_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: v1_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - v1_alert + /v1_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: v1_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - v1_alert + /v1_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: v1_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - v1_alert + /v1_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: v1_alert_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/v1_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - v1_alert + /v1_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: v1_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - v1_alert + /v1_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: v1_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - v1_alert + /v1_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: v1_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - v1_alert produces: -- application/json + - application/json responses: - alert_CustomizeDeleteOutput: - schema: - properties: - alert: - $ref: '#/definitions/AlertDetails' - type: object - alert_FetchCustomizeColumnsOutput: - schema: - properties: - alert: - $ref: '#/definitions/AlertDetails' - type: object - alert_GetDetailsClassMetadataOutput: - schema: - properties: - alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_GetDetailsMetadataOutput: - schema: - properties: - alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_GetDetailsStatusOutput: - schema: - properties: - alert: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - alert_GetPropertyDistinctFieldOutput: {} - alert_GetPropertySplitableExportOutput: {} - alert_GetPropertySplitableOutput: {} - alert_GetPropertyStatisticsOutput: - schema: - properties: - alert: - $ref: '#/definitions/StatusStatistic' - type: object - alert_GetPropertyTagValuePairsOutput: {} - alert_GetPropertyTagValueTreeOutput: {} - alert_ListItemFilterOutput: - schema: - properties: - alerts: - items: - $ref: '#/definitions/AlertDetails' - 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 - alert_PerformClassMetadataOutput: {} - alert_PerformDisableOutput: {} - alert_PerformEnableOutput: {} - alert_PerformPauseOutput: {} - alert_PerformPurgeSplitableOutput: {} - alert_PerformSetClassMetadataOutput: {} - alert_PerformSetUserMetadataOutput: {} - alert_PerformStatusOutput: {} - alert_PerformTestRunOutput: - schema: - properties: - alert: - $ref: '#/definitions/AlertTestRunOutput' - type: object - alert_ValidateCreateDataOutput: - schema: - properties: - alert: - $ref: '#/definitions/AlertDetails' - type: object - alert_ValidateUpdateDataOutput: - schema: - properties: - alert: - $ref: '#/definitions/AlertDetails' - type: object - alert_dash_board_CustomizeDeleteOutput: - schema: - properties: - alert_dash_board: - $ref: '#/definitions/AlertDashBoardDetails' - type: object - alert_dash_board_FetchCustomizeColumnsOutput: - schema: - properties: - alert_dash_board: - $ref: '#/definitions/AlertDashBoardDetails' - type: object - alert_dash_board_GetDetailsClassMetadataOutput: - schema: - properties: - alert_dash_board: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_dash_board_GetDetailsMetadataOutput: - schema: - properties: - alert_dash_board: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_dash_board_GetDetailsStatusOutput: - schema: - properties: - alert_dash_board: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - alert_dash_board_GetPropertyDistinctFieldOutput: {} - alert_dash_board_GetPropertySplitableExportOutput: {} - alert_dash_board_GetPropertySplitableOutput: {} - alert_dash_board_GetPropertyStatisticsOutput: - schema: - properties: - alert_dash_board: - $ref: '#/definitions/StatusStatistic' - type: object - alert_dash_board_GetPropertyTagValuePairsOutput: {} - alert_dash_board_GetPropertyTagValueTreeOutput: {} - alert_dash_board_ListItemFilterOutput: - schema: - properties: - alert_dash_boards: - items: - $ref: '#/definitions/AlertDashBoardDetails' - 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 - alert_dash_board_PerformClassMetadataOutput: {} - alert_dash_board_PerformCloneDashboardOutput: {} - alert_dash_board_PerformClonePanelOutput: {} - alert_dash_board_PerformPurgeSplitableOutput: {} - alert_dash_board_PerformSetClassMetadataOutput: {} - alert_dash_board_PerformSetScopeOutput: {} - alert_dash_board_PerformSetUserMetadataOutput: {} - alert_dash_board_PerformStatusOutput: {} - alert_dash_board_ValidateCreateDataOutput: - schema: - properties: - alert_dash_board: - $ref: '#/definitions/AlertDashBoardDetails' - type: object - alert_dash_board_ValidateUpdateDataOutput: - schema: - properties: - alert_dash_board: - $ref: '#/definitions/AlertDashBoardDetails' - type: object - alert_dashboard_panel_CustomizeDeleteOutput: - schema: - properties: - alert_dashboard_panel: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - alert_dashboard_panel_FetchCustomizeColumnsOutput: - schema: - properties: - alert_dashboard_panel: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - alert_dashboard_panel_GetPropertyDistinctFieldOutput: {} - alert_dashboard_panel_GetPropertySplitableExportOutput: {} - alert_dashboard_panel_GetPropertySplitableOutput: {} - alert_dashboard_panel_ListItemFilterOutput: - schema: - properties: - alert_dashboard_panels: - items: - $ref: '#/definitions/JointResourceBaseDetails' - 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 - alert_dashboard_panel_PerformPurgeSplitableOutput: {} - alert_dashboard_panel_ValidateCreateDataOutput: - schema: - properties: - alert_dashboard_panel: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - alert_dashboard_panel_ValidateUpdateDataOutput: - schema: - properties: - alert_dashboard_panel: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - alert_notification_CustomizeDeleteOutput: - schema: - properties: - alert_notification: - $ref: '#/definitions/VirtualResourceDetails' - type: object - alert_notification_FetchCustomizeColumnsOutput: - schema: - properties: - alert_notification: - $ref: '#/definitions/VirtualResourceDetails' - type: object - alert_notification_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - alert_notification: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - alert_notification_GetDetailsClassMetadataOutput: - schema: - properties: - alert_notification: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_notification_GetDetailsMetadataOutput: - schema: - properties: - alert_notification: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_notification_GetDetailsStatusOutput: - schema: - properties: - alert_notification: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - alert_notification_GetPropertyDistinctFieldOutput: {} - alert_notification_GetPropertyDomainStatisticsOutput: - schema: - properties: - alert_notification: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - alert_notification_GetPropertyProjectStatisticsOutput: - schema: - properties: - alert_notification: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - alert_notification_GetPropertyProjectTagValuePairsOutput: {} - alert_notification_GetPropertyProjectTagValueTreeOutput: {} - alert_notification_GetPropertySplitableExportOutput: {} - alert_notification_GetPropertySplitableOutput: {} - alert_notification_GetPropertyStatisticsOutput: - schema: - properties: - alert_notification: - $ref: '#/definitions/StatusStatistic' - type: object - alert_notification_GetPropertyTagValuePairsOutput: {} - alert_notification_GetPropertyTagValueTreeOutput: {} - alert_notification_ListItemFilterOutput: - schema: - properties: - alert_notifications: - items: - $ref: '#/definitions/VirtualResourceDetails' - 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 - alert_notification_PerformCancelDeleteOutput: {} - alert_notification_PerformChangeOwnerOutput: {} - alert_notification_PerformClassMetadataOutput: {} - alert_notification_PerformFreezeOutput: {} - alert_notification_PerformPurgeSplitableOutput: {} - alert_notification_PerformSetClassMetadataOutput: {} - alert_notification_PerformSetUserMetadataOutput: {} - alert_notification_PerformStatusOutput: {} - alert_notification_PerformUnfreezeOutput: {} - alert_notification_ValidateCreateDataOutput: - schema: - properties: - alert_notification: - $ref: '#/definitions/VirtualResourceDetails' - type: object - alert_notification_ValidateUpdateDataOutput: - schema: - properties: - alert_notification: - $ref: '#/definitions/VirtualResourceDetails' - type: object - alert_panel_CustomizeDeleteOutput: - schema: - properties: - alert_panel: - $ref: '#/definitions/PanelDetails' - type: object - alert_panel_FetchCustomizeColumnsOutput: - schema: - properties: - alert_panel: - $ref: '#/definitions/PanelDetails' - type: object - alert_panel_GetDetailsClassMetadataOutput: - schema: - properties: - alert_panel: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_panel_GetDetailsMetadataOutput: - schema: - properties: - alert_panel: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_panel_GetDetailsStatusOutput: - schema: - properties: - alert_panel: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - alert_panel_GetPropertyDistinctFieldOutput: {} - alert_panel_GetPropertySplitableExportOutput: {} - alert_panel_GetPropertySplitableOutput: {} - alert_panel_GetPropertyStatisticsOutput: - schema: - properties: - alert_panel: - $ref: '#/definitions/StatusStatistic' - type: object - alert_panel_GetPropertyTagValuePairsOutput: {} - alert_panel_GetPropertyTagValueTreeOutput: {} - alert_panel_ListItemFilterOutput: - schema: - properties: - alert_panels: - items: - $ref: '#/definitions/PanelDetails' - 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 - alert_panel_PerformClassMetadataOutput: {} - alert_panel_PerformPurgeSplitableOutput: {} - alert_panel_PerformSetClassMetadataOutput: {} - alert_panel_PerformSetUserMetadataOutput: {} - alert_panel_PerformStatusOutput: {} - alert_panel_ValidateCreateDataOutput: - schema: - properties: - alert_panel: - $ref: '#/definitions/PanelDetails' - type: object - alert_panel_ValidateUpdateDataOutput: - schema: - properties: - alert_panel: - $ref: '#/definitions/PanelDetails' - type: object - alert_record_CustomizeDeleteOutput: - schema: - properties: - alert_record: - $ref: '#/definitions/AlertRecordDetails' - type: object - alert_record_FetchCustomizeColumnsOutput: - schema: - properties: - alert_record: - $ref: '#/definitions/AlertRecordDetails' - type: object - alert_record_GetDetailsClassMetadataOutput: - schema: - properties: - alert_record: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_record_GetDetailsMetadataOutput: - schema: - properties: - alert_record: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_record_GetDetailsStatusOutput: - schema: - properties: - alert_record: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - alert_record_GetPropertyDistinctFieldOutput: {} - alert_record_GetPropertySplitableExportOutput: {} - alert_record_GetPropertySplitableOutput: {} - alert_record_GetPropertyStatisticsOutput: - schema: - properties: - alert_record: - $ref: '#/definitions/StatusStatistic' - type: object - alert_record_GetPropertyTagValuePairsOutput: {} - alert_record_GetPropertyTagValueTreeOutput: {} - alert_record_GetPropertyTotalAlertOutput: {} - alert_record_ListItemFilterOutput: - schema: - properties: - alert_records: - items: - $ref: '#/definitions/AlertRecordDetails' - 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 - alert_record_PerformClassMetadataOutput: {} - alert_record_PerformPurgeSplitableOutput: {} - alert_record_PerformSetClassMetadataOutput: {} - alert_record_PerformSetUserMetadataOutput: {} - alert_record_PerformStatusOutput: {} - alert_record_ValidateCreateDataOutput: - schema: - properties: - alert_record: - $ref: '#/definitions/AlertRecordDetails' - type: object - alert_record_ValidateUpdateDataOutput: - schema: - properties: - alert_record: - $ref: '#/definitions/AlertRecordDetails' - type: object - alert_record_shield_CustomizeDeleteOutput: - schema: - properties: - alert_record_shield: - $ref: '#/definitions/AlertRecordShieldDetails' - type: object - alert_record_shield_FetchCustomizeColumnsOutput: - schema: - properties: - alert_record_shield: - $ref: '#/definitions/AlertRecordShieldDetails' - type: object - alert_record_shield_GetDetailsClassMetadataOutput: - schema: - properties: - alert_record_shield: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_record_shield_GetDetailsMetadataOutput: - schema: - properties: - alert_record_shield: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_record_shield_GetDetailsStatusOutput: - schema: - properties: - alert_record_shield: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - alert_record_shield_GetPropertyDistinctFieldOutput: {} - alert_record_shield_GetPropertySplitableExportOutput: {} - alert_record_shield_GetPropertySplitableOutput: {} - alert_record_shield_GetPropertyStatisticsOutput: - schema: - properties: - alert_record_shield: - $ref: '#/definitions/StatusStatistic' - type: object - alert_record_shield_GetPropertyTagValuePairsOutput: {} - alert_record_shield_GetPropertyTagValueTreeOutput: {} - alert_record_shield_ListItemFilterOutput: - schema: - properties: - alert_record_shields: - items: - $ref: '#/definitions/AlertRecordShieldDetails' - 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 - alert_record_shield_PerformClassMetadataOutput: {} - alert_record_shield_PerformPurgeSplitableOutput: {} - alert_record_shield_PerformSetClassMetadataOutput: {} - alert_record_shield_PerformSetUserMetadataOutput: {} - alert_record_shield_PerformStatusOutput: {} - alert_record_shield_ValidateCreateDataOutput: - schema: - properties: - alert_record_shield: - $ref: '#/definitions/AlertRecordShieldDetails' - type: object - alert_record_shield_ValidateUpdateDataOutput: - schema: - properties: - alert_record_shield: - $ref: '#/definitions/AlertRecordShieldDetails' - type: object - alert_resource_CustomizeDeleteOutput: - schema: - properties: - alert_resource: - $ref: '#/definitions/AlertResourceDetails' - type: object - alert_resource_FetchCustomizeColumnsOutput: - schema: - properties: - alert_resource: - $ref: '#/definitions/AlertResourceDetails' - type: object - alert_resource_GetDetailsClassMetadataOutput: - schema: - properties: - alert_resource: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_resource_GetDetailsMetadataOutput: - schema: - properties: - alert_resource: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - alert_resource_GetPropertyDistinctFieldOutput: {} - alert_resource_GetPropertySplitableExportOutput: {} - alert_resource_GetPropertySplitableOutput: {} - alert_resource_GetPropertyTagValuePairsOutput: {} - alert_resource_GetPropertyTagValueTreeOutput: {} - alert_resource_ListItemFilterOutput: - schema: - properties: - alert_resources: - items: - $ref: '#/definitions/AlertResourceDetails' - 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 - alert_resource_PerformClassMetadataOutput: {} - alert_resource_PerformPurgeSplitableOutput: {} - alert_resource_PerformSetClassMetadataOutput: {} - alert_resource_PerformSetUserMetadataOutput: {} - alert_resource_ValidateCreateDataOutput: - schema: - properties: - alert_resource: - $ref: '#/definitions/AlertResourceDetails' - type: object - alert_resource_ValidateUpdateDataOutput: - schema: - properties: - alert_resource: - $ref: '#/definitions/AlertResourceDetails' - type: object - alert_resource_alert_CustomizeDeleteOutput: {} - alert_resource_alert_FetchCustomizeColumnsOutput: {} - alert_resource_alert_GetPropertyDistinctFieldOutput: {} - alert_resource_alert_GetPropertySplitableExportOutput: {} - alert_resource_alert_GetPropertySplitableOutput: {} - alert_resource_alert_ListItemFilterOutput: {} - alert_resource_alert_PerformPurgeSplitableOutput: {} - alert_resource_alert_ValidateCreateDataOutput: {} - alert_resource_alert_ValidateUpdateDataOutput: {} - common_alert_CustomizeDeleteOutput: - schema: - properties: - common_alert: - $ref: '#/definitions/CommonAlertDetails' - type: object - common_alert_FetchCustomizeColumnsOutput: - schema: - properties: - common_alert: - $ref: '#/definitions/CommonAlertDetails' - type: object - common_alert_GetDetailsClassMetadataOutput: - schema: - properties: - common_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - common_alert_GetDetailsMetadataOutput: - schema: - properties: - common_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - common_alert_GetDetailsStatusOutput: - schema: - properties: - common_alert: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - common_alert_GetPropertyDistinctFieldOutput: {} - common_alert_GetPropertySplitableExportOutput: {} - common_alert_GetPropertySplitableOutput: {} - common_alert_GetPropertyStatisticsOutput: - schema: - properties: - common_alert: - $ref: '#/definitions/StatusStatistic' - type: object - common_alert_GetPropertyTagValuePairsOutput: {} - common_alert_GetPropertyTagValueTreeOutput: {} - common_alert_ListItemFilterOutput: - schema: - properties: - common_alerts: - items: - $ref: '#/definitions/CommonAlertDetails' - 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 - common_alert_PerformClassMetadataOutput: {} - common_alert_PerformConfigOutput: {} - common_alert_PerformDisableOutput: {} - common_alert_PerformEnableOutput: {} - common_alert_PerformPauseOutput: {} - common_alert_PerformPurgeSplitableOutput: {} - common_alert_PerformSetClassMetadataOutput: {} - common_alert_PerformSetScopeOutput: {} - common_alert_PerformSetUserMetadataOutput: {} - common_alert_PerformStatusOutput: {} - common_alert_PerformTestRunOutput: - schema: - properties: - common_alert: - $ref: '#/definitions/AlertTestRunOutput' - type: object - common_alert_ValidateCreateDataOutput: - schema: - properties: - common_alert: - $ref: '#/definitions/CommonAlertDetails' - type: object - common_alert_ValidateUpdateDataOutput: - schema: - properties: - common_alert: - $ref: '#/definitions/CommonAlertDetails' - type: object - data_source_CustomizeDeleteOutput: - schema: - properties: - data_source: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - data_source_FetchCustomizeColumnsOutput: - schema: - properties: - data_source: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - data_source_GetDetailsClassMetadataOutput: - schema: - properties: - data_source: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - data_source_GetDetailsMetadataOutput: - schema: - properties: - data_source: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - data_source_GetPropertyDistinctFieldOutput: {} - data_source_GetPropertySplitableExportOutput: {} - data_source_GetPropertySplitableOutput: {} - data_source_GetPropertyTagValuePairsOutput: {} - data_source_GetPropertyTagValueTreeOutput: {} - data_source_ListItemFilterOutput: - schema: - properties: - data_sources: - items: - $ref: '#/definitions/StandaloneResourceDetails' - 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 - data_source_PerformClassMetadataOutput: {} - data_source_PerformPurgeSplitableOutput: {} - data_source_PerformSetClassMetadataOutput: {} - data_source_PerformSetUserMetadataOutput: {} - data_source_ValidateCreateDataOutput: - schema: - properties: - data_source: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - data_source_ValidateUpdateDataOutput: - schema: - properties: - data_source: - $ref: '#/definitions/StandaloneResourceDetails' - type: object - meter_alert_CustomizeDeleteOutput: - schema: - properties: - meter_alert: - $ref: '#/definitions/MeterAlertDetails' - type: object - meter_alert_FetchCustomizeColumnsOutput: - schema: - properties: - meter_alert: - $ref: '#/definitions/MeterAlertDetails' - type: object - meter_alert_GetDetailsClassMetadataOutput: - schema: - properties: - meter_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - meter_alert_GetDetailsMetadataOutput: - schema: - properties: - meter_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - meter_alert_GetDetailsStatusOutput: - schema: - properties: - meter_alert: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - meter_alert_GetPropertyDistinctFieldOutput: {} - meter_alert_GetPropertySplitableExportOutput: {} - meter_alert_GetPropertySplitableOutput: {} - meter_alert_GetPropertyStatisticsOutput: - schema: - properties: - meter_alert: - $ref: '#/definitions/StatusStatistic' - type: object - meter_alert_GetPropertyTagValuePairsOutput: {} - meter_alert_GetPropertyTagValueTreeOutput: {} - meter_alert_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - meter_alerts: - items: - $ref: '#/definitions/MeterAlertDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - meter_alert_PerformClassMetadataOutput: {} - meter_alert_PerformDisableOutput: {} - meter_alert_PerformEnableOutput: {} - meter_alert_PerformPauseOutput: {} - meter_alert_PerformPurgeSplitableOutput: {} - meter_alert_PerformSetClassMetadataOutput: {} - meter_alert_PerformSetUserMetadataOutput: {} - meter_alert_PerformStatusOutput: {} - meter_alert_PerformTestRunOutput: - schema: - properties: - meter_alert: - $ref: '#/definitions/AlertTestRunOutput' - type: object - meter_alert_ValidateCreateDataOutput: - schema: - properties: - meter_alert: - $ref: '#/definitions/MeterAlertDetails' - type: object - meter_alert_ValidateUpdateDataOutput: - schema: - properties: - meter_alert: - $ref: '#/definitions/MeterAlertDetails' - type: object - metric_CustomizeDeleteOutput: - schema: - properties: - metric: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - metric_FetchCustomizeColumnsOutput: - schema: - properties: - metric: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - metric_GetPropertyDistinctFieldOutput: {} - metric_GetPropertySplitableExportOutput: {} - metric_GetPropertySplitableOutput: {} - metric_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - metrics: - items: - $ref: '#/definitions/JointResourceBaseDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - metric_PerformPurgeSplitableOutput: {} - metric_ValidateCreateDataOutput: - schema: - properties: - metric: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - metric_ValidateUpdateDataOutput: - schema: - properties: - metric: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - metric_field_CustomizeDeleteOutput: - schema: - properties: - metric_field: - $ref: '#/definitions/MetricFieldDetail' - type: object - metric_field_FetchCustomizeColumnsOutput: - schema: - properties: - metric_field: - $ref: '#/definitions/MetricFieldDetail' - type: object - metric_field_GetDetailsClassMetadataOutput: - schema: - properties: - metric_field: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - metric_field_GetDetailsMetadataOutput: - schema: - properties: - metric_field: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - metric_field_GetDetailsStatusOutput: - schema: - properties: - metric_field: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - metric_field_GetPropertyDistinctFieldOutput: {} - metric_field_GetPropertySplitableExportOutput: {} - metric_field_GetPropertySplitableOutput: {} - metric_field_GetPropertyStatisticsOutput: - schema: - properties: - metric_field: - $ref: '#/definitions/StatusStatistic' - type: object - metric_field_GetPropertyTagValuePairsOutput: {} - metric_field_GetPropertyTagValueTreeOutput: {} - metric_field_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - metric_fields: - items: - $ref: '#/definitions/MetricFieldDetail' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - metric_field_PerformClassMetadataOutput: {} - metric_field_PerformPurgeSplitableOutput: {} - metric_field_PerformSetClassMetadataOutput: {} - metric_field_PerformSetUserMetadataOutput: {} - metric_field_PerformStatusOutput: {} - metric_field_ValidateCreateDataOutput: - schema: - properties: - metric_field: - $ref: '#/definitions/MetricFieldDetail' - type: object - metric_field_ValidateUpdateDataOutput: - schema: - properties: - metric_field: - $ref: '#/definitions/MetricFieldDetail' - type: object - metric_measurement_CustomizeDeleteOutput: - schema: - properties: - metric_measurement: - $ref: '#/definitions/MetricDetails' - type: object - metric_measurement_FetchCustomizeColumnsOutput: - schema: - properties: - metric_measurement: - $ref: '#/definitions/MetricDetails' - type: object - metric_measurement_GetDetailsClassMetadataOutput: - schema: - properties: - metric_measurement: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - metric_measurement_GetDetailsMetadataOutput: - schema: - properties: - metric_measurement: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - metric_measurement_GetDetailsStatusOutput: - schema: - properties: - metric_measurement: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - metric_measurement_GetPropertyDistinctFieldOutput: {} - metric_measurement_GetPropertySplitableExportOutput: {} - metric_measurement_GetPropertySplitableOutput: {} - metric_measurement_GetPropertyStatisticsOutput: - schema: - properties: - metric_measurement: - $ref: '#/definitions/StatusStatistic' - type: object - metric_measurement_GetPropertyTagValuePairsOutput: {} - metric_measurement_GetPropertyTagValueTreeOutput: {} - metric_measurement_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - metric_measurements: - items: - $ref: '#/definitions/MetricDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - metric_measurement_PerformClassMetadataOutput: {} - metric_measurement_PerformPurgeSplitableOutput: {} - metric_measurement_PerformSetClassMetadataOutput: {} - metric_measurement_PerformSetUserMetadataOutput: {} - metric_measurement_PerformStatusOutput: {} - metric_measurement_ValidateCreateDataOutput: - schema: - properties: - metric_measurement: - $ref: '#/definitions/MetricDetails' - type: object - metric_measurement_ValidateUpdateDataOutput: - schema: - properties: - metric_measurement: - $ref: '#/definitions/MetricDetails' - type: object - migration_alert_CustomizeDeleteOutput: - schema: - properties: - migration_alert: - $ref: '#/definitions/AlertDetails' - type: object - migration_alert_FetchCustomizeColumnsOutput: - schema: - properties: - migration_alert: - $ref: '#/definitions/AlertDetails' - type: object - migration_alert_GetDetailsClassMetadataOutput: - schema: - properties: - migration_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - migration_alert_GetDetailsMetadataOutput: - schema: - properties: - migration_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - migration_alert_GetDetailsStatusOutput: - schema: - properties: - migration_alert: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - migration_alert_GetPropertyDistinctFieldOutput: {} - migration_alert_GetPropertySplitableExportOutput: {} - migration_alert_GetPropertySplitableOutput: {} - migration_alert_GetPropertyStatisticsOutput: - schema: - properties: - migration_alert: - $ref: '#/definitions/StatusStatistic' - type: object - migration_alert_GetPropertyTagValuePairsOutput: {} - migration_alert_GetPropertyTagValueTreeOutput: {} - migration_alert_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - migration_alerts: - items: - $ref: '#/definitions/AlertDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - migration_alert_PerformClassMetadataOutput: {} - migration_alert_PerformDisableOutput: {} - migration_alert_PerformEnableOutput: {} - migration_alert_PerformPauseOutput: {} - migration_alert_PerformPurgeSplitableOutput: {} - migration_alert_PerformSetClassMetadataOutput: {} - migration_alert_PerformSetUserMetadataOutput: {} - migration_alert_PerformStatusOutput: {} - migration_alert_PerformTestRunOutput: - schema: - properties: - migration_alert: - $ref: '#/definitions/AlertTestRunOutput' - type: object - migration_alert_ValidateCreateDataOutput: - schema: - properties: - migration_alert: - $ref: '#/definitions/AlertDetails' - type: object - migration_alert_ValidateUpdateDataOutput: - schema: - properties: - migration_alert: - $ref: '#/definitions/AlertDetails' - type: object - monitor_resource_CustomizeDeleteOutput: - schema: - properties: - monitor_resource: - $ref: '#/definitions/MonitorResourceDetails' - type: object - monitor_resource_FetchCustomizeColumnsOutput: - schema: - properties: - monitor_resource: - $ref: '#/definitions/MonitorResourceDetails' - type: object - monitor_resource_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - monitor_resource: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - monitor_resource_GetDetailsClassMetadataOutput: - schema: - properties: - monitor_resource: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - monitor_resource_GetDetailsMetadataOutput: - schema: - properties: - monitor_resource: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - monitor_resource_GetDetailsStatusOutput: - schema: - properties: - monitor_resource: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - monitor_resource_GetPropertyAlertOutput: {} - monitor_resource_GetPropertyDistinctFieldOutput: {} - monitor_resource_GetPropertyDomainStatisticsOutput: - schema: - properties: - monitor_resource: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - monitor_resource_GetPropertyProjectStatisticsOutput: - schema: - properties: - monitor_resource: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - monitor_resource_GetPropertyProjectTagValuePairsOutput: {} - monitor_resource_GetPropertyProjectTagValueTreeOutput: {} - monitor_resource_GetPropertySplitableExportOutput: {} - monitor_resource_GetPropertySplitableOutput: {} - monitor_resource_GetPropertyStatisticsOutput: - schema: - properties: - monitor_resource: - $ref: '#/definitions/StatusStatistic' - type: object - monitor_resource_GetPropertyTagValuePairsOutput: {} - monitor_resource_GetPropertyTagValueTreeOutput: {} - monitor_resource_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - monitor_resources: - items: - $ref: '#/definitions/MonitorResourceDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - monitor_resource_PerformCancelDeleteOutput: {} - monitor_resource_PerformChangeOwnerOutput: {} - monitor_resource_PerformClassMetadataOutput: {} - monitor_resource_PerformFreezeOutput: {} - monitor_resource_PerformPurgeSplitableOutput: {} - monitor_resource_PerformSetClassMetadataOutput: {} - monitor_resource_PerformSetUserMetadataOutput: {} - monitor_resource_PerformStatusOutput: {} - monitor_resource_PerformUnfreezeOutput: {} - monitor_resource_ValidateCreateDataOutput: - schema: - properties: - monitor_resource: - $ref: '#/definitions/MonitorResourceDetails' - type: object - monitor_resource_ValidateUpdateDataOutput: - schema: - properties: - monitor_resource: - $ref: '#/definitions/MonitorResourceDetails' - type: object - monitor_resource_alert_CustomizeDeleteOutput: - schema: - properties: - monitor_resource_alert: - $ref: '#/definitions/MonitorResourceJointDetails' - type: object - monitor_resource_alert_FetchCustomizeColumnsOutput: - schema: - properties: - monitor_resource_alert: - $ref: '#/definitions/MonitorResourceJointDetails' - type: object - monitor_resource_alert_GetPropertyDistinctFieldOutput: {} - monitor_resource_alert_GetPropertySplitableExportOutput: {} - monitor_resource_alert_GetPropertySplitableOutput: {} - monitor_resource_alert_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - monitor_resource_alerts: - items: - $ref: '#/definitions/MonitorResourceJointDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - monitor_resource_alert_PerformPurgeSplitableOutput: {} - monitor_resource_alert_ValidateCreateDataOutput: - schema: - properties: - monitor_resource_alert: - $ref: '#/definitions/MonitorResourceJointDetails' - type: object - monitor_resource_alert_ValidateUpdateDataOutput: - schema: - properties: - monitor_resource_alert: - $ref: '#/definitions/MonitorResourceJointDetails' - type: object - node_alert_CustomizeDeleteOutput: - schema: - properties: - node_alert: - $ref: '#/definitions/NodeAlertDetails' - type: object - node_alert_FetchCustomizeColumnsOutput: - schema: - properties: - node_alert: - $ref: '#/definitions/NodeAlertDetails' - type: object - node_alert_GetDetailsClassMetadataOutput: - schema: - properties: - node_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - node_alert_GetDetailsMetadataOutput: - schema: - properties: - node_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - node_alert_GetDetailsStatusOutput: - schema: - properties: - node_alert: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - node_alert_GetPropertyDistinctFieldOutput: {} - node_alert_GetPropertySplitableExportOutput: {} - node_alert_GetPropertySplitableOutput: {} - node_alert_GetPropertyStatisticsOutput: - schema: - properties: - node_alert: - $ref: '#/definitions/StatusStatistic' - type: object - node_alert_GetPropertyTagValuePairsOutput: {} - node_alert_GetPropertyTagValueTreeOutput: {} - node_alert_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - node_alerts: - items: - $ref: '#/definitions/NodeAlertDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - node_alert_PerformClassMetadataOutput: {} - node_alert_PerformConfigOutput: {} - node_alert_PerformDisableOutput: {} - node_alert_PerformEnableOutput: {} - node_alert_PerformPauseOutput: {} - node_alert_PerformPurgeSplitableOutput: {} - node_alert_PerformSetClassMetadataOutput: {} - node_alert_PerformSetScopeOutput: {} - node_alert_PerformSetUserMetadataOutput: {} - node_alert_PerformStatusOutput: {} - node_alert_PerformTestRunOutput: - schema: - properties: - node_alert: - $ref: '#/definitions/AlertTestRunOutput' - type: object - node_alert_ValidateCreateDataOutput: - schema: - properties: - node_alert: - $ref: '#/definitions/NodeAlertDetails' - type: object - node_alert_ValidateUpdateDataOutput: - schema: - properties: - node_alert: - $ref: '#/definitions/NodeAlertDetails' - type: object - v1_alert_CustomizeDeleteOutput: - schema: - properties: - v1_alert: - $ref: '#/definitions/AlertV1Details' - type: object - v1_alert_FetchCustomizeColumnsOutput: - schema: - properties: - v1_alert: - $ref: '#/definitions/AlertV1Details' - type: object - v1_alert_GetDetailsClassMetadataOutput: - schema: - properties: - v1_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - v1_alert_GetDetailsMetadataOutput: - schema: - properties: - v1_alert: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - v1_alert_GetDetailsStatusOutput: - schema: - properties: - v1_alert: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - v1_alert_GetPropertyDistinctFieldOutput: {} - v1_alert_GetPropertySplitableExportOutput: {} - v1_alert_GetPropertySplitableOutput: {} - v1_alert_GetPropertyStatisticsOutput: - schema: - properties: - v1_alert: - $ref: '#/definitions/StatusStatistic' - type: object - v1_alert_GetPropertyTagValuePairsOutput: {} - v1_alert_GetPropertyTagValueTreeOutput: {} - v1_alert_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 - v1_alerts: - items: - $ref: '#/definitions/AlertV1Details' - type: array - x-go-name: Output - type: object - v1_alert_PerformClassMetadataOutput: {} - v1_alert_PerformDisableOutput: {} - v1_alert_PerformEnableOutput: {} - v1_alert_PerformPauseOutput: {} - v1_alert_PerformPurgeSplitableOutput: {} - v1_alert_PerformSetClassMetadataOutput: {} - v1_alert_PerformSetUserMetadataOutput: {} - v1_alert_PerformStatusOutput: {} - v1_alert_PerformTestRunOutput: - schema: - properties: - v1_alert: - $ref: '#/definitions/AlertTestRunOutput' - type: object - v1_alert_ValidateCreateDataOutput: - schema: - properties: - v1_alert: - $ref: '#/definitions/AlertV1Details' - type: object - v1_alert_ValidateUpdateDataOutput: - schema: - properties: - v1_alert: - $ref: '#/definitions/AlertV1Details' - type: object + alert_CustomizeDeleteOutput: + description: "" + schema: + properties: + alert: + $ref: '#/definitions/AlertDetails' + type: object + alert_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + alert: + $ref: '#/definitions/AlertDetails' + type: object + alert_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_GetDetailsMetadataOutput: + description: "" + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_GetDetailsStatusOutput: + description: "" + schema: + properties: + alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_GetPropertyDistinctFieldOutput: + description: "" + alert_GetPropertySplitableExportOutput: + description: "" + alert_GetPropertySplitableOutput: + description: "" + alert_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + alert: + $ref: '#/definitions/StatusStatistic' + type: object + alert_GetPropertyTagValuePairsOutput: + description: "" + alert_GetPropertyTagValueTreeOutput: + description: "" + alert_ListItemFilterOutput: + description: "" + schema: + properties: + alerts: + items: + $ref: '#/definitions/AlertDetails' + 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 + alert_PerformClassMetadataOutput: + description: "" + alert_PerformDisableOutput: + description: "" + alert_PerformEnableOutput: + description: "" + alert_PerformPauseOutput: + description: "" + alert_PerformPurgeSplitableOutput: + description: "" + alert_PerformSetClassMetadataOutput: + description: "" + alert_PerformSetOrgMetadataOutput: + description: "" + alert_PerformSetUserMetadataOutput: + description: "" + alert_PerformStatusOutput: + description: "" + alert_PerformTestRunOutput: + description: "" + schema: + properties: + alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + alert_ValidateCreateDataOutput: + description: "" + schema: + properties: + alert: + $ref: '#/definitions/AlertDetails' + type: object + alert_ValidateUpdateDataOutput: + description: "" + schema: + properties: + alert: + $ref: '#/definitions/AlertDetails' + type: object + alert_dash_board_CustomizeDeleteOutput: + description: "" + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardDetails' + type: object + alert_dash_board_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardDetails' + type: object + alert_dash_board_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_dash_board_GetDetailsMetadataOutput: + description: "" + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_dash_board_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_dash_board_GetDetailsStatusOutput: + description: "" + schema: + properties: + alert_dash_board: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_dash_board_GetPropertyDistinctFieldOutput: + description: "" + alert_dash_board_GetPropertySplitableExportOutput: + description: "" + alert_dash_board_GetPropertySplitableOutput: + description: "" + alert_dash_board_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + alert_dash_board: + $ref: '#/definitions/StatusStatistic' + type: object + alert_dash_board_GetPropertyTagValuePairsOutput: + description: "" + alert_dash_board_GetPropertyTagValueTreeOutput: + description: "" + alert_dash_board_ListItemFilterOutput: + description: "" + schema: + properties: + alert_dash_boards: + items: + $ref: '#/definitions/AlertDashBoardDetails' + 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 + alert_dash_board_PerformClassMetadataOutput: + description: "" + alert_dash_board_PerformCloneDashboardOutput: + description: "" + alert_dash_board_PerformClonePanelOutput: + description: "" + alert_dash_board_PerformPurgeSplitableOutput: + description: "" + alert_dash_board_PerformSetClassMetadataOutput: + description: "" + alert_dash_board_PerformSetOrgMetadataOutput: + description: "" + alert_dash_board_PerformSetScopeOutput: + description: "" + alert_dash_board_PerformSetUserMetadataOutput: + description: "" + alert_dash_board_PerformStatusOutput: + description: "" + alert_dash_board_ValidateCreateDataOutput: + description: "" + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardDetails' + type: object + alert_dash_board_ValidateUpdateDataOutput: + description: "" + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardDetails' + type: object + alert_dashboard_panel_CustomizeDeleteOutput: + description: "" + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + alert_dashboard_panel_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + alert_dashboard_panel_GetPropertyDistinctFieldOutput: + description: "" + alert_dashboard_panel_GetPropertySplitableExportOutput: + description: "" + alert_dashboard_panel_GetPropertySplitableOutput: + description: "" + alert_dashboard_panel_ListItemFilterOutput: + description: "" + schema: + properties: + alert_dashboard_panels: + items: + $ref: '#/definitions/JointResourceBaseDetails' + 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 + alert_dashboard_panel_PerformPurgeSplitableOutput: + description: "" + alert_dashboard_panel_ValidateCreateDataOutput: + description: "" + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + alert_dashboard_panel_ValidateUpdateDataOutput: + description: "" + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + alert_notification_CustomizeDeleteOutput: + description: "" + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceDetails' + type: object + alert_notification_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceDetails' + type: object + alert_notification_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + alert_notification: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + alert_notification_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_notification_GetDetailsMetadataOutput: + description: "" + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_notification_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_notification_GetDetailsStatusOutput: + description: "" + schema: + properties: + alert_notification: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_notification_GetPropertyDistinctFieldOutput: + description: "" + alert_notification_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + alert_notification: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + alert_notification_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + alert_notification: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + alert_notification_GetPropertyProjectTagValuePairsOutput: + description: "" + alert_notification_GetPropertyProjectTagValueTreeOutput: + description: "" + alert_notification_GetPropertySplitableExportOutput: + description: "" + alert_notification_GetPropertySplitableOutput: + description: "" + alert_notification_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + alert_notification: + $ref: '#/definitions/StatusStatistic' + type: object + alert_notification_GetPropertyTagValuePairsOutput: + description: "" + alert_notification_GetPropertyTagValueTreeOutput: + description: "" + alert_notification_ListItemFilterOutput: + description: "" + schema: + properties: + alert_notifications: + items: + $ref: '#/definitions/VirtualResourceDetails' + 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 + alert_notification_PerformCancelDeleteOutput: + description: "" + alert_notification_PerformChangeOwnerOutput: + description: "" + alert_notification_PerformClassMetadataOutput: + description: "" + alert_notification_PerformFreezeOutput: + description: "" + alert_notification_PerformPurgeSplitableOutput: + description: "" + alert_notification_PerformSetClassMetadataOutput: + description: "" + alert_notification_PerformSetOrgMetadataOutput: + description: "" + alert_notification_PerformSetUserMetadataOutput: + description: "" + alert_notification_PerformStatusOutput: + description: "" + alert_notification_PerformUnfreezeOutput: + description: "" + alert_notification_ValidateCreateDataOutput: + description: "" + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceDetails' + type: object + alert_notification_ValidateUpdateDataOutput: + description: "" + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceDetails' + type: object + alert_panel_CustomizeDeleteOutput: + description: "" + schema: + properties: + alert_panel: + $ref: '#/definitions/PanelDetails' + type: object + alert_panel_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + alert_panel: + $ref: '#/definitions/PanelDetails' + type: object + alert_panel_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_panel_GetDetailsMetadataOutput: + description: "" + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_panel_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_panel_GetDetailsStatusOutput: + description: "" + schema: + properties: + alert_panel: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_panel_GetPropertyDistinctFieldOutput: + description: "" + alert_panel_GetPropertySplitableExportOutput: + description: "" + alert_panel_GetPropertySplitableOutput: + description: "" + alert_panel_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + alert_panel: + $ref: '#/definitions/StatusStatistic' + type: object + alert_panel_GetPropertyTagValuePairsOutput: + description: "" + alert_panel_GetPropertyTagValueTreeOutput: + description: "" + alert_panel_ListItemFilterOutput: + description: "" + schema: + properties: + alert_panels: + items: + $ref: '#/definitions/PanelDetails' + 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 + alert_panel_PerformClassMetadataOutput: + description: "" + alert_panel_PerformPurgeSplitableOutput: + description: "" + alert_panel_PerformSetClassMetadataOutput: + description: "" + alert_panel_PerformSetOrgMetadataOutput: + description: "" + alert_panel_PerformSetUserMetadataOutput: + description: "" + alert_panel_PerformStatusOutput: + description: "" + alert_panel_ValidateCreateDataOutput: + description: "" + schema: + properties: + alert_panel: + $ref: '#/definitions/PanelDetails' + type: object + alert_panel_ValidateUpdateDataOutput: + description: "" + schema: + properties: + alert_panel: + $ref: '#/definitions/PanelDetails' + type: object + alert_record_CustomizeDeleteOutput: + description: "" + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordDetails' + type: object + alert_record_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordDetails' + type: object + alert_record_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_GetDetailsMetadataOutput: + description: "" + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_GetDetailsStatusOutput: + description: "" + schema: + properties: + alert_record: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_record_GetPropertyDistinctFieldOutput: + description: "" + alert_record_GetPropertySplitableExportOutput: + description: "" + alert_record_GetPropertySplitableOutput: + description: "" + alert_record_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + alert_record: + $ref: '#/definitions/StatusStatistic' + type: object + alert_record_GetPropertyTagValuePairsOutput: + description: "" + alert_record_GetPropertyTagValueTreeOutput: + description: "" + alert_record_GetPropertyTotalAlertOutput: + description: "" + alert_record_ListItemFilterOutput: + description: "" + schema: + properties: + alert_records: + items: + $ref: '#/definitions/AlertRecordDetails' + 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 + alert_record_PerformClassMetadataOutput: + description: "" + alert_record_PerformPurgeSplitableOutput: + description: "" + alert_record_PerformSetClassMetadataOutput: + description: "" + alert_record_PerformSetOrgMetadataOutput: + description: "" + alert_record_PerformSetUserMetadataOutput: + description: "" + alert_record_PerformStatusOutput: + description: "" + alert_record_ValidateCreateDataOutput: + description: "" + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordDetails' + type: object + alert_record_ValidateUpdateDataOutput: + description: "" + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordDetails' + type: object + alert_record_shield_CustomizeDeleteOutput: + description: "" + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldDetails' + type: object + alert_record_shield_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldDetails' + type: object + alert_record_shield_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_shield_GetDetailsMetadataOutput: + description: "" + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_shield_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_shield_GetDetailsStatusOutput: + description: "" + schema: + properties: + alert_record_shield: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_record_shield_GetPropertyDistinctFieldOutput: + description: "" + alert_record_shield_GetPropertySplitableExportOutput: + description: "" + alert_record_shield_GetPropertySplitableOutput: + description: "" + alert_record_shield_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + alert_record_shield: + $ref: '#/definitions/StatusStatistic' + type: object + alert_record_shield_GetPropertyTagValuePairsOutput: + description: "" + alert_record_shield_GetPropertyTagValueTreeOutput: + description: "" + alert_record_shield_ListItemFilterOutput: + description: "" + schema: + properties: + alert_record_shields: + items: + $ref: '#/definitions/AlertRecordShieldDetails' + 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 + alert_record_shield_PerformClassMetadataOutput: + description: "" + alert_record_shield_PerformPurgeSplitableOutput: + description: "" + alert_record_shield_PerformSetClassMetadataOutput: + description: "" + alert_record_shield_PerformSetOrgMetadataOutput: + description: "" + alert_record_shield_PerformSetUserMetadataOutput: + description: "" + alert_record_shield_PerformStatusOutput: + description: "" + alert_record_shield_ValidateCreateDataOutput: + description: "" + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldDetails' + type: object + alert_record_shield_ValidateUpdateDataOutput: + description: "" + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldDetails' + type: object + alert_resource_CustomizeDeleteOutput: + description: "" + schema: + properties: + alert_resource: + $ref: '#/definitions/AlertResourceDetails' + type: object + alert_resource_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + alert_resource: + $ref: '#/definitions/AlertResourceDetails' + type: object + alert_resource_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_resource_GetDetailsMetadataOutput: + description: "" + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_resource_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_resource_GetPropertyDistinctFieldOutput: + description: "" + alert_resource_GetPropertySplitableExportOutput: + description: "" + alert_resource_GetPropertySplitableOutput: + description: "" + alert_resource_GetPropertyTagValuePairsOutput: + description: "" + alert_resource_GetPropertyTagValueTreeOutput: + description: "" + alert_resource_ListItemFilterOutput: + description: "" + schema: + properties: + alert_resources: + items: + $ref: '#/definitions/AlertResourceDetails' + 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 + alert_resource_PerformClassMetadataOutput: + description: "" + alert_resource_PerformPurgeSplitableOutput: + description: "" + alert_resource_PerformSetClassMetadataOutput: + description: "" + alert_resource_PerformSetOrgMetadataOutput: + description: "" + alert_resource_PerformSetUserMetadataOutput: + description: "" + alert_resource_ValidateCreateDataOutput: + description: "" + schema: + properties: + alert_resource: + $ref: '#/definitions/AlertResourceDetails' + type: object + alert_resource_ValidateUpdateDataOutput: + description: "" + schema: + properties: + alert_resource: + $ref: '#/definitions/AlertResourceDetails' + type: object + alert_resource_alert_CustomizeDeleteOutput: + description: "" + alert_resource_alert_FetchCustomizeColumnsOutput: + description: "" + alert_resource_alert_GetPropertyDistinctFieldOutput: + description: "" + alert_resource_alert_GetPropertySplitableExportOutput: + description: "" + alert_resource_alert_GetPropertySplitableOutput: + description: "" + alert_resource_alert_ListItemFilterOutput: + description: "" + alert_resource_alert_PerformPurgeSplitableOutput: + description: "" + alert_resource_alert_ValidateCreateDataOutput: + description: "" + alert_resource_alert_ValidateUpdateDataOutput: + description: "" + common_alert_CustomizeDeleteOutput: + description: "" + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertDetails' + type: object + common_alert_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertDetails' + type: object + common_alert_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + common_alert_GetDetailsMetadataOutput: + description: "" + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + common_alert_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + common_alert_GetDetailsStatusOutput: + description: "" + schema: + properties: + common_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + common_alert_GetPropertyDistinctFieldOutput: + description: "" + common_alert_GetPropertySplitableExportOutput: + description: "" + common_alert_GetPropertySplitableOutput: + description: "" + common_alert_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + common_alert: + $ref: '#/definitions/StatusStatistic' + type: object + common_alert_GetPropertyTagValuePairsOutput: + description: "" + common_alert_GetPropertyTagValueTreeOutput: + description: "" + common_alert_ListItemFilterOutput: + description: "" + schema: + properties: + common_alerts: + items: + $ref: '#/definitions/CommonAlertDetails' + 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 + common_alert_PerformClassMetadataOutput: + description: "" + common_alert_PerformConfigOutput: + description: "" + common_alert_PerformDisableOutput: + description: "" + common_alert_PerformEnableOutput: + description: "" + common_alert_PerformPauseOutput: + description: "" + common_alert_PerformPurgeSplitableOutput: + description: "" + common_alert_PerformSetClassMetadataOutput: + description: "" + common_alert_PerformSetOrgMetadataOutput: + description: "" + common_alert_PerformSetScopeOutput: + description: "" + common_alert_PerformSetUserMetadataOutput: + description: "" + common_alert_PerformStatusOutput: + description: "" + common_alert_PerformTestRunOutput: + description: "" + schema: + properties: + common_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + common_alert_ValidateCreateDataOutput: + description: "" + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertDetails' + type: object + common_alert_ValidateUpdateDataOutput: + description: "" + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertDetails' + type: object + data_source_CustomizeDeleteOutput: + description: "" + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + data_source_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + data_source_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + data_source_GetDetailsMetadataOutput: + description: "" + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + data_source_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + data_source_GetPropertyDistinctFieldOutput: + description: "" + data_source_GetPropertySplitableExportOutput: + description: "" + data_source_GetPropertySplitableOutput: + description: "" + data_source_GetPropertyTagValuePairsOutput: + description: "" + data_source_GetPropertyTagValueTreeOutput: + description: "" + data_source_ListItemFilterOutput: + description: "" + schema: + properties: + data_sources: + items: + $ref: '#/definitions/StandaloneResourceDetails' + 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 + data_source_PerformClassMetadataOutput: + description: "" + data_source_PerformPurgeSplitableOutput: + description: "" + data_source_PerformSetClassMetadataOutput: + description: "" + data_source_PerformSetOrgMetadataOutput: + description: "" + data_source_PerformSetUserMetadataOutput: + description: "" + data_source_ValidateCreateDataOutput: + description: "" + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + data_source_ValidateUpdateDataOutput: + description: "" + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + meter_alert_CustomizeDeleteOutput: + description: "" + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertDetails' + type: object + meter_alert_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertDetails' + type: object + meter_alert_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + meter_alert_GetDetailsMetadataOutput: + description: "" + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + meter_alert_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + meter_alert_GetDetailsStatusOutput: + description: "" + schema: + properties: + meter_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + meter_alert_GetPropertyDistinctFieldOutput: + description: "" + meter_alert_GetPropertySplitableExportOutput: + description: "" + meter_alert_GetPropertySplitableOutput: + description: "" + meter_alert_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + meter_alert: + $ref: '#/definitions/StatusStatistic' + type: object + meter_alert_GetPropertyTagValuePairsOutput: + description: "" + meter_alert_GetPropertyTagValueTreeOutput: + description: "" + meter_alert_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + meter_alerts: + items: + $ref: '#/definitions/MeterAlertDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + meter_alert_PerformClassMetadataOutput: + description: "" + meter_alert_PerformDisableOutput: + description: "" + meter_alert_PerformEnableOutput: + description: "" + meter_alert_PerformPauseOutput: + description: "" + meter_alert_PerformPurgeSplitableOutput: + description: "" + meter_alert_PerformSetClassMetadataOutput: + description: "" + meter_alert_PerformSetOrgMetadataOutput: + description: "" + meter_alert_PerformSetUserMetadataOutput: + description: "" + meter_alert_PerformStatusOutput: + description: "" + meter_alert_PerformTestRunOutput: + description: "" + schema: + properties: + meter_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + meter_alert_ValidateCreateDataOutput: + description: "" + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertDetails' + type: object + meter_alert_ValidateUpdateDataOutput: + description: "" + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertDetails' + type: object + metric_CustomizeDeleteOutput: + description: "" + schema: + properties: + metric: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + metric_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + metric: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + metric_GetPropertyDistinctFieldOutput: + description: "" + metric_GetPropertySplitableExportOutput: + description: "" + metric_GetPropertySplitableOutput: + description: "" + metric_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + metrics: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + metric_PerformPurgeSplitableOutput: + description: "" + metric_ValidateCreateDataOutput: + description: "" + schema: + properties: + metric: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + metric_ValidateUpdateDataOutput: + description: "" + schema: + properties: + metric: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + metric_field_CustomizeDeleteOutput: + description: "" + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldDetail' + type: object + metric_field_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldDetail' + type: object + metric_field_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_field_GetDetailsMetadataOutput: + description: "" + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_field_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_field_GetDetailsStatusOutput: + description: "" + schema: + properties: + metric_field: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + metric_field_GetPropertyDistinctFieldOutput: + description: "" + metric_field_GetPropertySplitableExportOutput: + description: "" + metric_field_GetPropertySplitableOutput: + description: "" + metric_field_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + metric_field: + $ref: '#/definitions/StatusStatistic' + type: object + metric_field_GetPropertyTagValuePairsOutput: + description: "" + metric_field_GetPropertyTagValueTreeOutput: + description: "" + metric_field_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + metric_fields: + items: + $ref: '#/definitions/MetricFieldDetail' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + metric_field_PerformClassMetadataOutput: + description: "" + metric_field_PerformPurgeSplitableOutput: + description: "" + metric_field_PerformSetClassMetadataOutput: + description: "" + metric_field_PerformSetOrgMetadataOutput: + description: "" + metric_field_PerformSetUserMetadataOutput: + description: "" + metric_field_PerformStatusOutput: + description: "" + metric_field_ValidateCreateDataOutput: + description: "" + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldDetail' + type: object + metric_field_ValidateUpdateDataOutput: + description: "" + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldDetail' + type: object + metric_measurement_CustomizeDeleteOutput: + description: "" + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricDetails' + type: object + metric_measurement_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricDetails' + type: object + metric_measurement_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_measurement_GetDetailsMetadataOutput: + description: "" + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_measurement_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_measurement_GetDetailsStatusOutput: + description: "" + schema: + properties: + metric_measurement: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + metric_measurement_GetPropertyDistinctFieldOutput: + description: "" + metric_measurement_GetPropertySplitableExportOutput: + description: "" + metric_measurement_GetPropertySplitableOutput: + description: "" + metric_measurement_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + metric_measurement: + $ref: '#/definitions/StatusStatistic' + type: object + metric_measurement_GetPropertyTagValuePairsOutput: + description: "" + metric_measurement_GetPropertyTagValueTreeOutput: + description: "" + metric_measurement_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + metric_measurements: + items: + $ref: '#/definitions/MetricDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + metric_measurement_PerformClassMetadataOutput: + description: "" + metric_measurement_PerformPurgeSplitableOutput: + description: "" + metric_measurement_PerformSetClassMetadataOutput: + description: "" + metric_measurement_PerformSetOrgMetadataOutput: + description: "" + metric_measurement_PerformSetUserMetadataOutput: + description: "" + metric_measurement_PerformStatusOutput: + description: "" + metric_measurement_ValidateCreateDataOutput: + description: "" + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricDetails' + type: object + metric_measurement_ValidateUpdateDataOutput: + description: "" + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricDetails' + type: object + migration_alert_CustomizeDeleteOutput: + description: "" + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertDetails' + type: object + migration_alert_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertDetails' + type: object + migration_alert_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + migration_alert_GetDetailsMetadataOutput: + description: "" + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + migration_alert_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + migration_alert_GetDetailsStatusOutput: + description: "" + schema: + properties: + migration_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + migration_alert_GetPropertyDistinctFieldOutput: + description: "" + migration_alert_GetPropertySplitableExportOutput: + description: "" + migration_alert_GetPropertySplitableOutput: + description: "" + migration_alert_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + migration_alert: + $ref: '#/definitions/StatusStatistic' + type: object + migration_alert_GetPropertyTagValuePairsOutput: + description: "" + migration_alert_GetPropertyTagValueTreeOutput: + description: "" + migration_alert_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + migration_alerts: + items: + $ref: '#/definitions/AlertDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + migration_alert_PerformClassMetadataOutput: + description: "" + migration_alert_PerformDisableOutput: + description: "" + migration_alert_PerformEnableOutput: + description: "" + migration_alert_PerformPauseOutput: + description: "" + migration_alert_PerformPurgeSplitableOutput: + description: "" + migration_alert_PerformSetClassMetadataOutput: + description: "" + migration_alert_PerformSetOrgMetadataOutput: + description: "" + migration_alert_PerformSetUserMetadataOutput: + description: "" + migration_alert_PerformStatusOutput: + description: "" + migration_alert_PerformTestRunOutput: + description: "" + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + migration_alert_ValidateCreateDataOutput: + description: "" + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertDetails' + type: object + migration_alert_ValidateUpdateDataOutput: + description: "" + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertDetails' + type: object + monitor_resource_CustomizeDeleteOutput: + description: "" + schema: + properties: + monitor_resource: + $ref: '#/definitions/MonitorResourceDetails' + type: object + monitor_resource_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + monitor_resource: + $ref: '#/definitions/MonitorResourceDetails' + type: object + monitor_resource_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + monitor_resource: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + monitor_resource_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + monitor_resource_GetDetailsMetadataOutput: + description: "" + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + monitor_resource_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + monitor_resource_GetDetailsStatusOutput: + description: "" + schema: + properties: + monitor_resource: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + monitor_resource_GetPropertyAlertOutput: + description: "" + monitor_resource_GetPropertyDistinctFieldOutput: + description: "" + monitor_resource_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + monitor_resource: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + monitor_resource_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + monitor_resource: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + monitor_resource_GetPropertyProjectTagValuePairsOutput: + description: "" + monitor_resource_GetPropertyProjectTagValueTreeOutput: + description: "" + monitor_resource_GetPropertySplitableExportOutput: + description: "" + monitor_resource_GetPropertySplitableOutput: + description: "" + monitor_resource_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + monitor_resource: + $ref: '#/definitions/StatusStatistic' + type: object + monitor_resource_GetPropertyTagValuePairsOutput: + description: "" + monitor_resource_GetPropertyTagValueTreeOutput: + description: "" + monitor_resource_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + monitor_resources: + items: + $ref: '#/definitions/MonitorResourceDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + monitor_resource_PerformCancelDeleteOutput: + description: "" + monitor_resource_PerformChangeOwnerOutput: + description: "" + monitor_resource_PerformClassMetadataOutput: + description: "" + monitor_resource_PerformFreezeOutput: + description: "" + monitor_resource_PerformPurgeSplitableOutput: + description: "" + monitor_resource_PerformSetClassMetadataOutput: + description: "" + monitor_resource_PerformSetOrgMetadataOutput: + description: "" + monitor_resource_PerformSetUserMetadataOutput: + description: "" + monitor_resource_PerformStatusOutput: + description: "" + monitor_resource_PerformUnfreezeOutput: + description: "" + monitor_resource_ValidateCreateDataOutput: + description: "" + schema: + properties: + monitor_resource: + $ref: '#/definitions/MonitorResourceDetails' + type: object + monitor_resource_ValidateUpdateDataOutput: + description: "" + schema: + properties: + monitor_resource: + $ref: '#/definitions/MonitorResourceDetails' + type: object + monitor_resource_alert_CustomizeDeleteOutput: + description: "" + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/MonitorResourceJointDetails' + type: object + monitor_resource_alert_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/MonitorResourceJointDetails' + type: object + monitor_resource_alert_GetPropertyDistinctFieldOutput: + description: "" + monitor_resource_alert_GetPropertySplitableExportOutput: + description: "" + monitor_resource_alert_GetPropertySplitableOutput: + description: "" + monitor_resource_alert_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + monitor_resource_alerts: + items: + $ref: '#/definitions/MonitorResourceJointDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + monitor_resource_alert_PerformPurgeSplitableOutput: + description: "" + monitor_resource_alert_ValidateCreateDataOutput: + description: "" + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/MonitorResourceJointDetails' + type: object + monitor_resource_alert_ValidateUpdateDataOutput: + description: "" + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/MonitorResourceJointDetails' + type: object + node_alert_CustomizeDeleteOutput: + description: "" + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertDetails' + type: object + node_alert_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertDetails' + type: object + node_alert_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + node_alert_GetDetailsMetadataOutput: + description: "" + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + node_alert_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + node_alert_GetDetailsStatusOutput: + description: "" + schema: + properties: + node_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + node_alert_GetPropertyDistinctFieldOutput: + description: "" + node_alert_GetPropertySplitableExportOutput: + description: "" + node_alert_GetPropertySplitableOutput: + description: "" + node_alert_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + node_alert: + $ref: '#/definitions/StatusStatistic' + type: object + node_alert_GetPropertyTagValuePairsOutput: + description: "" + node_alert_GetPropertyTagValueTreeOutput: + description: "" + node_alert_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + node_alerts: + items: + $ref: '#/definitions/NodeAlertDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + node_alert_PerformClassMetadataOutput: + description: "" + node_alert_PerformConfigOutput: + description: "" + node_alert_PerformDisableOutput: + description: "" + node_alert_PerformEnableOutput: + description: "" + node_alert_PerformPauseOutput: + description: "" + node_alert_PerformPurgeSplitableOutput: + description: "" + node_alert_PerformSetClassMetadataOutput: + description: "" + node_alert_PerformSetOrgMetadataOutput: + description: "" + node_alert_PerformSetScopeOutput: + description: "" + node_alert_PerformSetUserMetadataOutput: + description: "" + node_alert_PerformStatusOutput: + description: "" + node_alert_PerformTestRunOutput: + description: "" + schema: + properties: + node_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + node_alert_ValidateCreateDataOutput: + description: "" + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertDetails' + type: object + node_alert_ValidateUpdateDataOutput: + description: "" + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertDetails' + type: object + v1_alert_CustomizeDeleteOutput: + description: "" + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertV1Details' + type: object + v1_alert_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertV1Details' + type: object + v1_alert_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + v1_alert_GetDetailsMetadataOutput: + description: "" + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + v1_alert_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + v1_alert_GetDetailsStatusOutput: + description: "" + schema: + properties: + v1_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + v1_alert_GetPropertyDistinctFieldOutput: + description: "" + v1_alert_GetPropertySplitableExportOutput: + description: "" + v1_alert_GetPropertySplitableOutput: + description: "" + v1_alert_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + v1_alert: + $ref: '#/definitions/StatusStatistic' + type: object + v1_alert_GetPropertyTagValuePairsOutput: + description: "" + v1_alert_GetPropertyTagValueTreeOutput: + description: "" + v1_alert_ListItemFilterOutput: + description: "" + 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 + v1_alerts: + items: + $ref: '#/definitions/AlertV1Details' + type: array + x-go-name: Output + type: object + v1_alert_PerformClassMetadataOutput: + description: "" + v1_alert_PerformDisableOutput: + description: "" + v1_alert_PerformEnableOutput: + description: "" + v1_alert_PerformPauseOutput: + description: "" + v1_alert_PerformPurgeSplitableOutput: + description: "" + v1_alert_PerformSetClassMetadataOutput: + description: "" + v1_alert_PerformSetOrgMetadataOutput: + description: "" + v1_alert_PerformSetUserMetadataOutput: + description: "" + v1_alert_PerformStatusOutput: + description: "" + v1_alert_PerformTestRunOutput: + description: "" + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + v1_alert_ValidateCreateDataOutput: + description: "" + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertV1Details' + type: object + v1_alert_ValidateUpdateDataOutput: + description: "" + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertV1Details' + type: object schemes: -- https -- http + - https + - http securityDefinitions: - keystone: - in: header - name: X-Auth-Token - type: apiKey + keystone: + in: header + name: X-Auth-Token + type: apiKey swagger: "2.0" diff --git a/docs/swagger/swagger_notify.yaml b/docs/swagger/swagger_notify.yaml index de056c676a..fc5f1821ad 100644 --- a/docs/swagger/swagger_notify.yaml +++ b/docs/swagger/swagger_notify.yaml @@ -1,8911 +1,10021 @@ basePath: / consumes: -- application/json + - application/json definitions: - ChangeOwnerCandidateDomainsOutput: - properties: - candidates: - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: Candidates - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ConfigCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates type: object - x-go-name: Metadata - attribution: - description: 'description: attribution' - enum: - - system - - domain - example: system - type: string - x-go-name: Attribution - content: - $ref: '#/definitions/SNotifyConfigContent' - 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 - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - type: - description: 'description: config type' - example: feishu - type: string - x-go-name: Type - required: - - name - - type - - content - - attribution - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ConfigDetails: - properties: - attribution: - type: string - x-go-name: Attribution - 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 - content: - $ref: '#/definitions/SNotifyConfigContent' - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis + ConfigCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + attribution: + description: 'description: attribution' + enum: + - system + - domain + example: system + type: string + x-go-name: Attribution + content: + $ref: '#/definitions/SNotifyConfigContent' + 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 + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + type: + description: 'description: config type' + example: feishu + type: string + x-go-name: Type + required: + - name + - type + - content + - attribution type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - 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/notify - ConfigManagerGetTypesInput: - properties: - domain_ids: - description: 'description: View the available notification channels for the - domains with these DomainIds' - items: - type: string - type: array - x-go-name: DomainIds - operation: - description: 'description: Operation of reduce' - enum: - - union - - merge - type: string - x-go-name: Operation - receivers: - description: 'description: View the available notification channels for the - receivers' - items: - type: string - type: array - x-go-name: Receivers - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ConfigManagerGetTypesOutput: - properties: - types: - items: - type: string - type: array - x-go-name: Types - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ConfigUpdateInput: - properties: - content: - $ref: '#/definitions/SNotifyConfigContent' - required: - - content - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ConfigValidateInput: - properties: - content: - $ref: '#/definitions/SNotifyConfigContent' - type: - description: 'description: config type' - example: feishu - type: string - x-go-name: Type - required: - - type - - content - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ConfigValidateOutput: - properties: - is_valid: - type: boolean - x-go-name: IsValid - message: - type: string - x-go-name: Message - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - EmailQueueCreateInput: - properties: - attachments: - items: - $ref: '#/definitions/SEmailAttachment' - type: array - x-go-name: Attachments - bcc: - items: - type: string - type: array - x-go-name: Bcc - body: - type: string - x-go-name: Body - cc: - items: - type: string - type: array - x-go-name: Cc - content: - description: 'swagger: ignore' + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigDetails: + properties: + attribution: + type: string + x-go-name: Attribution + 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 + content: + $ref: '#/definitions/SNotifyConfigContent' + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + 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-name: Content - dest: - description: 'swagger: ignore' - type: string - x-go-name: Dest - dest_bcc: - description: 'swagger: ignore' - type: string - x-go-name: DestBcc - dest_cc: - description: 'swagger: ignore' - type: string - x-go-name: DestCc - domain: - description: 'swagger: ignore' - type: string - x-go-name: Domain - domain_id: - description: 'swagger: ignore' - type: string - x-go-name: DomainId - project: - description: 'swagger: ignore' - type: string - x-go-name: Project - project_domain: - description: 'swagger: ignore' - type: string - x-go-name: ProjectDomain - project_domain_id: - description: 'swagger: ignore' - type: string - x-go-name: ProjectDomainId - project_id: - description: 'swagger: ignore' - type: string - x-go-name: ProjectId - roles: - description: 'swagger: ignore' - type: string - x-go-name: Roles - session_id: - type: string - x-go-name: SessionId - subject: - type: string - x-go-name: Subject - to: - items: - type: string - type: array - x-go-name: To - user: - description: 'swagger: ignore' - type: string - x-go-name: User - user_id: - description: 'swagger: ignore' - type: string - x-go-name: UserId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - EmailQueueDetails: - 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 - content: + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigManagerGetTypesInput: + properties: + domain_ids: + description: 'description: View the available notification channels for the domains with these DomainIds' + items: + type: string + type: array + x-go-name: DomainIds + operation: + description: 'description: Operation of reduce' + enum: + - union + - merge + type: string + x-go-name: Operation + receivers: + description: 'description: View the available notification channels for the receivers' + items: + type: string + type: array + x-go-name: Receivers type: object - x-go-name: Content - delete_fail_reason: - $ref: '#/definitions/Error' - dest: - type: string - x-go-name: Dest - dest_bcc: - type: string - x-go-name: DestBcc - dest_cc: - type: string - x-go-name: DestCc - domain: - type: string - x-go-name: Domain - domain_id: - type: string - x-go-name: DomainId - id: - format: int64 - type: integer - x-go-name: Id - project: - type: string - x-go-name: Project - project_domain: - type: string - x-go-name: ProjectDomain - project_domain_id: - type: string - x-go-name: ProjectDomainId - project_id: - type: string - x-go-name: ProjectId - recv_at: - format: date-time - type: string - x-go-name: RecvAt - results: - type: string - x-go-name: Results - roles: - type: string - x-go-name: Roles - sent_at: - format: date-time - type: string - x-go-name: SentAt - session_id: - type: string - x-go-name: SessionId - status: - type: string - x-go-name: Status - subject: - type: string - x-go-name: Subject - update_fail_reason: - $ref: '#/definitions/Error' - 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/notify - EmailQueueSendInput: - properties: - sync: - type: boolean - x-go-name: Sync - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - 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 - FailedElem: - properties: - ContactType: - type: string - Reason: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - GetDetailsStatusOutput: - properties: - status: - description: 状态 - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - Identification: - properties: - id: - example: 036fed49483b412888a760c2bc995caa - type: string - x-go-name: ID - name: - example: test - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - JoinResourceBaseCreateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - JointResourceBaseDetails: - 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 - JointResourceBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - 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 - NotificationCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigManagerGetTypesOutput: + properties: + types: + items: + type: string + type: array + x-go-name: Types type: object - x-go-name: Metadata - contact_type: - description: |- - description: contact type - required: ture - example: email - type: string - x-go-name: ContactType - contacts: - description: 'description: direct contact, admin privileges required' - items: - type: string - type: array - x-go-name: Contacts - 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 - ignore_nonexistent_receiver: - type: boolean - x-go-name: IgnoreNonexistentReceiver - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - message: - description: |- - description: message content or jsonobject - required: ture - type: string - x-go-name: Message - 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 - priority: - description: 'description: notification priority' - enum: - - fatal - - important - - nomal - example: normal - type: string - x-go-name: Priority - receivers: - description: 'description: ids or names of receiver' - example: '{"adfb720ccdd34c638346ea4fa7a713a8", "zhangsan"}' - items: - type: string - type: array - x-go-name: Receivers - robots: - description: 'description: robots' - example: feishu robot - items: - type: string - type: array - x-go-name: Robots - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - tag: - description: 'description: notification tag' - example: alert - type: string - x-go-name: Tag - topic: - description: 'description: notification topic' - example: IMAGE_ACTIVE - type: string - x-go-name: Topic - required: - - name - - topic - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - NotificationDetails: - 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 - contact_type: - type: string - x-go-name: ContactType - content: - type: string - x-go-name: Content - 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 - event_id: - type: string - x-go-name: EventId - 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: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigUpdateInput: + properties: + content: + $ref: '#/definitions/SNotifyConfigContent' + required: + - content type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - priority: - type: string - x-go-name: Priority - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - receive_details: - items: - $ref: '#/definitions/ReceiveDetail' - type: array - x-go-name: ReceiveDetails - received_at: - format: date-time - type: string - x-go-name: ReceivedAt - send_times: - format: int64 - type: integer - x-go-name: SendTimes - status: - description: 资源状态 - type: string - x-go-name: Status - title: - type: string - x-go-name: Title - topic_type: - type: string - x-go-name: TopicType - 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/notify - NotificationManagerEventNotifyInput: - properties: - Action: - $ref: '#/definitions/SAction' - CloudAccountName: - type: string - Event: - description: 'description: event trigger sending notification' - example: SERVER_DELETE - type: string - IsFailed: - $ref: '#/definitions/SResult' - ProjectDomainId: - description: 'description: domainId of the resource that triggered the event - notification' - example: default - type: string - ResourceType: - type: string - Result: - $ref: '#/definitions/SResult' - advance_days: - description: 'description: day left before the event' - example: 0 - format: int64 - type: integer - x-go-name: AdvanceDays - contact_type: - description: 'description: contact types' - example: email - items: - type: string - type: array - x-go-name: ContactTypes - contacts: - description: 'description: direct contact, admin privileges required' - items: - $ref: '#/definitions/SContact' - type: array - x-go-name: Contacts - priority: - description: 'description: notification priority' - enum: - - fatal - - important - - nomal - example: normal - type: string - x-go-name: Priority - project_id: - description: 'description: projectId of the resource that triggered the event - notification' - example: f627e09f038645f08ce6880c8d9cb8fd - type: string - x-go-name: ProjectId - receiver_ids: - description: 'description: ids or names of receiver' - example: '{"adfb720ccdd34c638346ea4fa7a713a8"}' - items: - type: string - type: array - x-go-name: ReceiverIds - resource_details: - description: |- - description: resource details - required: ture + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigValidateInput: + properties: + content: + $ref: '#/definitions/SNotifyConfigContent' + type: + description: 'description: config type' + example: feishu + type: string + x-go-name: Type + required: + - type + - content type: object - x-go-name: ResourceDetails - required: - - Event - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - NotificationManagerEventNotifyOutput: - properties: - FailedList: - items: - $ref: '#/definitions/FailedElem' - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - PerformChangeDomainOwnerInput: - properties: - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformChangeProjectOwnerInput: - properties: - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - project_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformDisableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformEnableInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformFreezeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPrivateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPublicProjectInput: - 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 - shared_project_ids: - description: 如果共享范围为项目，则在此列表中指定共享的目标项目 - items: - type: string - type: array - x-go-name: SharedProjectIds - 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 - PerformUnfreezeInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ProjectStatistic: - properties: - Count: - format: int64 - type: integer - Id: - type: string - Name: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PurgeSplitTableInput: - properties: - tables: - items: - type: string - type: array - x-go-name: Tables - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ReceiveDetail: - properties: - contact: - type: string - x-go-name: Contact - failed_reason: - type: string - x-go-name: FailedReason - receiver_id: - type: string - x-go-name: ReceiverId - receiver_name: - type: string - x-go-name: ReceiverName - receiver_type: - type: string - x-go-name: ReceiverType - send_by: - type: string - x-go-name: SendBy - sendAt: - format: date-time - type: string - x-go-name: SendAt - status: - type: string - x-go-name: Status - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ReceiverCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigValidateOutput: + properties: + is_valid: + type: boolean + x-go-name: IsValid + message: + type: string + x-go-name: Message type: object - x-go-name: Metadata - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - email: - description: 'description: user email' - example: example@gmail.com - type: string - x-go-name: Email - enabled: - description: 该资源是否被管理员*人为*启用或者禁用 - type: boolean - x-go-name: Enabled - enabled_contact_types: - description: 'description: enabled contact types for user' - example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}' - items: - type: string - type: array - x-go-name: EnabledContactTypes - force_verified: - description: force verified if admin create the records - type: boolean - x-go-name: ForceVerified - 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 - international_mobile: - $ref: '#/definitions/SInternationalMobile' - 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 - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - uid: - description: 'description: user id in keystone' - example: adfb720ccdd34c638346ea4fa7a713a8 - type: string - x-go-name: UID - uname: - description: 'description: user name in keystone' - example: hello - type: string - x-go-name: UName - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ReceiverDetails: - 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 - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - email: - type: string - x-go-name: Email - enabled: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - enabled_contact_types: - description: 'description: enabled contact types for user' - example: eamil, mobile, feishu, dingtalk, workwx - items: - type: string - type: array - x-go-name: EnabledContactTypes - id: - description: 资源UUID - type: string - x-go-name: Id - international_mobile: - $ref: '#/definitions/SInternationalMobile' - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - lang: - type: string - x-go-name: Lang - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + EmailQueueCreateInput: + properties: + attachments: + items: + $ref: '#/definitions/SEmailAttachment' + type: array + x-go-name: Attachments + bcc: + items: + type: string + type: array + x-go-name: Bcc + body: + type: string + x-go-name: Body + cc: + items: + type: string + type: array + x-go-name: Cc + content: + description: 'swagger: ignore' + type: object + x-go-name: Content + dest: + description: 'swagger: ignore' + type: string + x-go-name: Dest + dest_bcc: + description: 'swagger: ignore' + type: string + x-go-name: DestBcc + dest_cc: + description: 'swagger: ignore' + type: string + x-go-name: DestCc + domain: + description: 'swagger: ignore' + type: string + x-go-name: Domain + domain_id: + description: 'swagger: ignore' + type: string + x-go-name: DomainId + more_datails: + additionalProperties: + type: string + type: object + x-go-name: MoreDetails + project: + description: 'swagger: ignore' + type: string + x-go-name: Project + project_domain: + description: 'swagger: ignore' + type: string + x-go-name: ProjectDomain + project_domain_id: + description: 'swagger: ignore' + type: string + x-go-name: ProjectDomainId + project_id: + description: 'swagger: ignore' + type: string + x-go-name: ProjectId + roles: + description: 'swagger: ignore' + type: string + x-go-name: Roles + session_id: + type: string + x-go-name: SessionId + subject: + type: string + x-go-name: Subject + to: + items: + type: string + type: array + x-go-name: To + user: + description: 'swagger: ignore' + type: string + x-go-name: User + user_id: + description: 'swagger: ignore' + type: string + x-go-name: UserId type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - status: - description: 资源状态 - type: string - x-go-name: Status - update_fail_reason: - $ref: '#/definitions/Error' - update_version: - description: 资源被更新次数 - format: int64 - type: integer - x-go-name: UpdateVersion - updated_at: - description: 资源更新时间 - format: date-time - type: string - x-go-name: UpdatedAt - verified_infos: - description: 'description: verified info' - items: - $ref: '#/definitions/VerifiedInfo' - type: array - x-go-name: VerifiedInfos - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ReceiverEnableContactTypeInput: - properties: - enabled_contact_types: - items: - type: string - type: array - x-go-name: EnabledContactTypes - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ReceiverIntellijGetInput: - properties: - create_if_no: - description: 'description: create if receiver with UserId does not exist' - type: boolean - x-go-name: CreateIfNo - scope: - description: 'description: scope' - type: string - x-go-name: Scope - user_id: - description: 'description: user id in keystone' - type: string - x-go-name: UserId - required: - - user_id - - scope - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ReceiverTriggerVerifyInput: - properties: - contact_type: - description: 'description: contact type' - enum: - - email - - mobile - example: email - type: string - x-go-name: ContactType - required: - - contact_type - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ReceiverUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - email: - description: 'description: user email' - example: example@gmail.com - type: string - x-go-name: Email - enabled_contact_types: - description: 'description: enabled contacts for user' - example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}' - items: - type: string - type: array - x-go-name: EnabledContactTypes - force_verified: - type: boolean - x-go-name: ForceVerified - international_mobile: - $ref: '#/definitions/SInternationalMobile' - name: - description: 资源名称 - type: string - x-go-name: Name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - ReceiverVerifyInput: - properties: - contact_type: - description: 'description: Contact type' - enum: - - email - - mobile - example: email - type: string - x-go-name: ContactType - token: - description: 'description: token user input' - example: "123456" - type: string - x-go-name: Token - required: - - contact_type - - token - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - RobotCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + EmailQueueDetails: + 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 + content: + type: object + x-go-name: Content + delete_fail_reason: + $ref: '#/definitions/Error' + dest: + type: string + x-go-name: Dest + dest_bcc: + type: string + x-go-name: DestBcc + dest_cc: + type: string + x-go-name: DestCc + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + id: + format: int64 + type: integer + x-go-name: Id + more_details: + type: object + x-go-name: MoreDetails + project: + type: string + x-go-name: Project + project_domain: + type: string + x-go-name: ProjectDomain + project_domain_id: + type: string + x-go-name: ProjectDomainId + project_id: + type: string + x-go-name: ProjectId + recv_at: + format: date-time + type: string + x-go-name: RecvAt + results: + type: string + x-go-name: Results + roles: + type: string + x-go-name: Roles + sent_at: + format: date-time + type: string + x-go-name: SentAt + session_id: + type: string + x-go-name: SessionId + status: + type: string + x-go-name: Status + subject: + type: string + x-go-name: Subject + update_fail_reason: + $ref: '#/definitions/Error' + user: + type: string + x-go-name: User + user_id: + type: string + x-go-name: UserId type: object - x-go-name: Metadata - address: - description: 'description: address' - example: http://helloworld.io/test/webhook - type: string - x-go-name: Address - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - disabled: - description: 该资源是否被管理员*人为*禁用, 和enabled互斥 - type: boolean - x-go-name: Disabled - 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 - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - is_system: - description: 'description: indicate the resource is a system resource, which - is not visible to user' - type: boolean - x-go-name: IsSystem - lang: - description: 'description: Language preference' - example: zh_CN - type: string - x-go-name: Lang - 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_id: - description: 指定项目的名称或ID - type: string - x-go-name: ProjectId - public_scope: - description: 共享范围 - type: string - x-go-name: PublicScope - status: - description: 用来存储资源的状态 - type: string - x-go-name: Status - type: - description: 'description: robot type' - enum: - - feishu - - dingtalk - - workwx - - webhook - example: webhook - type: string - x-go-name: Type - required: - - name - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - RobotDetails: - 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: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + EmailQueueSendInput: + properties: + sync: + type: boolean + x-go-name: Sync type: object - x-go-name: Metadata - project: - description: |- - 资源归属项目的名称（向后兼容别名） - Deprecated - type: string - x-go-name: Tenant - project_domain: - description: 资源归属项目的域名称 - type: string - x-go-name: ProjectDomain - project_id: - description: |- - 资源归属项目的ID(向后兼容别名） - Deprecated - type: string - x-go-name: TenantId - 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 - tenant: - description: |- - 资源归属项目的名称 - alias:project - type: string - x-go-name: Project - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - RobotUpdateInput: - properties: - address: - description: 'description: address' - example: http://helloworld.io/test/webhook - type: string - x-go-name: Address - description: - description: 资源描述 - type: string - x-go-name: Description - lang: - description: 'description: Language preference' - example: en - type: string - x-go-name: Lang - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - SAction: - type: string - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - SContact: - properties: - contact: - type: string - x-go-name: Contact - contact_type: - type: string - x-go-name: ContactType - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - SEmailAttachment: - properties: - content: - type: string - x-go-name: Base64Content - filename: - type: string - x-go-name: Filename - mime: - type: string - x-go-name: Mime - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - SInternationalMobile: - properties: - area_code: - description: 'description: area code of mobile' - example: "86" - type: string - x-go-name: AreaCode - mobile: - description: 'description: user mobile' - example: "17812345678" - type: string - x-go-name: Mobile - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - SNotifyConfigContent: - properties: - AccessKeyId: - description: sms - type: string - AccessKeySecret: - type: string - AccessToken: - type: string - AgentId: - description: workwx - type: string - AppId: - description: Lark - type: string - AppKey: - description: |- - dingtalk - AgentId string - AppSecret string - type: string - AppSecret: - type: string - CorpId: - type: string - Hostname: - description: Email - type: string - Hostport: - format: int64 - type: integer - Password: - type: string - Secret: - type: string - SenderAddress: - type: string - ServiceUrl: - type: string - Signature: - type: string - SmsDriver: - type: string - SslGlobal: - type: boolean - Username: - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - SResult: - type: string - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - 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 - 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 - StandaloneAnonResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StandaloneAnonResourceDetails: - 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: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + 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-name: Metadata - update_fail_reason: - $ref: '#/definitions/Error' - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - StatusStandaloneResourceBaseUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - progress: - format: float - type: number - x-go-name: Progress - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - 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 - SubscriberChangeInput: - properties: - Receivers: - description: 'description: receivers which is required when the type is ''receiver'' - will Subscribe TopicID' - items: - type: string - type: array - Robot: - description: 'description: Robot(Id or Name) which is required when the type - is ''robot'' will Subscribe TopicID' - type: string - Role: - description: 'description: Role(Id or Name) which is required when the type - is ''role'' will Subscribe TopicID' - type: string - RoleScope: - description: 'description: The scope of role subscribers' - enum: - - system - - domain - - project - type: string - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - SubscriberCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/httperrors + FailedElem: + properties: + ContactType: + type: string + Reason: + type: string type: object - x-go-name: Metadata - DomainId: - description: 'description: domain id of resource' - example: 1e3824756bac4ac084e784ed297ec652 - type: string - Receivers: - description: 'description: receivers which is required when the type is ''receiver'' - will Subscribe TopicID' - items: - type: string - type: array - ResourceAttributionId: - description: 'description: project id or domain id of resource' - example: 1e3824756bac4ac084e784ed297ec652 - type: string - ResourceAttributionName: - type: string - ResourceScope: - description: 'description: scope of resource' - enum: - - system - - domain - - project - type: string - Robot: - description: 'description: Robot(Id or Name) which is required when the type - is ''robot'' will Subscribe TopicID' - type: string - Role: - description: 'description: Role(Id or Name) which is required when the type - is ''role'' will Subscribe TopicID' - type: string - RoleScope: - description: 'description: The scope of role subscribers' - enum: - - system - - domain - - project - type: string - Scope: - description: 'description: scope' - enum: - - system - - domain - type: string - TopicID: - description: |- - description: Id of Topic - required - type: string - Type: - description: 'description: Type of subscriber' - enum: - - receiver - - robot - - role - type: string - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - SubscriberDetails: - properties: - Receivers: - description: 'description: receivers' - items: - $ref: '#/definitions/Identification' - type: array - Robot: - $ref: '#/definitions/Identification' - Role: - $ref: '#/definitions/Identification' - 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 - id: - description: 资源UUID - type: string - x-go-name: Id - identification: - type: string - x-go-name: Identification - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status type: object - x-go-name: Metadata - resource_attribution_id: - type: string - x-go-name: ResourceAttributionId - resource_attribution_name: - type: string - x-go-name: ResourceAttributionName - resource_scope: - type: string - x-go-name: ResourceScope - role_scope: - type: string - x-go-name: RoleScope - scope: - type: string - x-go-name: Scope - topic_id: - type: string - x-go-name: TopicId - 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/notify - SubscriberSetReceiverInput: - properties: - Receivers: - items: - type: string - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - 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 - TemplateCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis + Identification: + properties: + id: + example: 036fed49483b412888a760c2bc995caa + type: string + x-go-name: ID + name: + example: test + type: string + x-go-name: Name type: object - x-go-name: Metadata - contact_type: - description: |- - description: Contact type, specifically, setting it to all means all contact type - require: true - example: email - type: string - x-go-name: ContactType - content: - description: 'description: Template content' - example: 镜像 {{.name}} 上传完成 - type: string - x-go-name: Content - description: - description: 资源描述 - example: test create network - type: string - x-go-name: Description - dry_run: - default: false - description: 预检验参数,若为true则仅检查参数,并不真正创建变更 - type: boolean - x-go-name: DryRun - example: - description: 'description: Example for using this template' - example: '{"name": "centos7.6"}' - type: string - x-go-name: Example - is_emulated: - description: |- - 资源是否为模拟资源 - description: the resource is an emulated resource - type: boolean - x-go-name: IsEmulated - lang: - description: 'description: Language' - enum: - - cn - - en - type: string - x-go-name: Lang - template_type: - description: 'description: Template type' - enum: - - title - - content - - remote - example: title - type: string - x-go-name: TemplateType - topic: - description: 'description: Template topic' - example: IMAGE_ACTIVE - type: string - x-go-name: Topic - required: - - topic - - content - - example - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - TemplateManagerSaveInput: - properties: - ContactType: - type: string - Force: - type: boolean - Templates: - items: - $ref: '#/definitions/TemplateCreateInput' - type: array - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - TemplateUpdateInput: - properties: - content: - description: 'description: template content' - example: 镜像 {{.name}} 上传完成 - type: string - x-go-name: Content - description: - description: 资源描述 - type: string - x-go-name: Description - example: - description: 'description: all example for using this template' - example: '{"name": "centos7.6"}' - type: string - x-go-name: Example - required: - - content - - example - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - TopicDetails: - properties: - actions: - format: uint32 - type: integer - x-go-name: Actions - advance_days: - format: int64 - type: integer - x-go-name: AdvanceDays - 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 - content_cn: - type: string - x-go-name: ContentCn - content_en: - type: string - x-go-name: ContentEn - 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: - description: 资源是否启用 - type: boolean - x-go-name: Enabled - 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: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + JoinResourceBaseCreateInput: type: object - x-go-name: Metadata - name: - description: 资源名称 + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseDetails: + 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 + JointResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + 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 + NotificationCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + contact_type: + description: |- + description: contact type + required: ture + example: email + type: string + x-go-name: ContactType + contacts: + description: 'description: direct contact, admin privileges required' + items: + type: string + type: array + x-go-name: Contacts + 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 + ignore_nonexistent_receiver: + type: boolean + x-go-name: IgnoreNonexistentReceiver + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + message: + description: |- + description: message content or jsonobject + required: ture + type: string + x-go-name: Message + 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 + priority: + description: 'description: notification priority' + enum: + - fatal + - important + - nomal + example: normal + type: string + x-go-name: Priority + receivers: + description: 'description: ids or names of receiver' + example: '{"adfb720ccdd34c638346ea4fa7a713a8", "zhangsan"}' + items: + type: string + type: array + x-go-name: Receivers + robots: + description: 'description: robots' + example: feishu robot + items: + type: string + type: array + x-go-name: Robots + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + tag: + description: 'description: notification tag' + example: alert + type: string + x-go-name: Tag + topic: + description: 'description: notification topic' + example: IMAGE_ACTIVE + type: string + x-go-name: Topic + required: + - name + - topic + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + NotificationDetails: + 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 + contact_type: + type: string + x-go-name: ContactType + content: + type: string + x-go-name: Content + 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 + event_id: + type: string + x-go-name: EventId + 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 + priority: + type: string + x-go-name: Priority + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + receive_details: + items: + $ref: '#/definitions/ReceiveDetail' + type: array + x-go-name: ReceiveDetails + received_at: + format: date-time + type: string + x-go-name: ReceivedAt + send_times: + format: int64 + type: integer + x-go-name: SendTimes + status: + description: 资源状态 + type: string + x-go-name: Status + title: + type: string + x-go-name: Title + topic_type: + type: string + x-go-name: TopicType + 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/notify + NotificationManagerContactNotifyInput: + properties: + Body: + type: string + Subject: + type: string + contact_type: + description: 'description: contact types' + example: email + items: + type: string + type: array + x-go-name: ContactTypes + receiver_ids: + description: 'description: ids or names of receiver' + example: '{"adfb720ccdd34c638346ea4fa7a713a8"}' + items: + type: string + type: array + x-go-name: ReceiverIds + robot_ids: + description: 'description: ids of robot' + example: '{"adfb720ccdd34c638346ea4fa7a713a8"}' + items: + type: string + type: array + x-go-name: RobotIds + role_ids: + items: + type: string + type: array + x-go-name: RoleIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + NotificationManagerEventNotifyInput: + properties: + Action: + $ref: '#/definitions/SAction' + CloudAccountName: + type: string + Event: + description: 'description: event trigger sending notification' + example: SERVER_DELETE + type: string + IsFailed: + $ref: '#/definitions/SResult' + ProjectDomainId: + description: 'description: domainId of the resource that triggered the event notification' + example: default + type: string + ResourceType: + type: string + Result: + $ref: '#/definitions/SResult' + advance_days: + description: 'description: day left before the event' + example: 0 + format: int64 + type: integer + x-go-name: AdvanceDays + contact_type: + description: 'description: contact types' + example: email + items: + type: string + type: array + x-go-name: ContactTypes + contacts: + description: 'description: direct contact, admin privileges required' + items: + $ref: '#/definitions/SContact' + type: array + x-go-name: Contacts + priority: + description: 'description: notification priority' + enum: + - fatal + - important + - nomal + example: normal + type: string + x-go-name: Priority + project_id: + description: 'description: projectId of the resource that triggered the event notification' + example: f627e09f038645f08ce6880c8d9cb8fd + type: string + x-go-name: ProjectId + receiver_ids: + description: 'description: ids or names of receiver' + example: '{"adfb720ccdd34c638346ea4fa7a713a8"}' + items: + type: string + type: array + x-go-name: ReceiverIds + resource_details: + description: |- + description: resource details + required: ture + type: object + x-go-name: ResourceDetails + required: + - Event + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + NotificationManagerEventNotifyOutput: + properties: + FailedList: + items: + $ref: '#/definitions/FailedElem' + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + PerformChangeDomainOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformChangeProjectOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformFreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicProjectInput: + 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 + shared_project_ids: + description: 如果共享范围为项目，则在此列表中指定共享的目标项目 + items: + type: string + type: array + x-go-name: SharedProjectIds + 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 + PerformUnfreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ProjectStatistic: + properties: + Count: + format: int64 + type: integer + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ReceiveDetail: + properties: + contact: + type: string + x-go-name: Contact + failed_reason: + type: string + x-go-name: FailedReason + receiver_id: + type: string + x-go-name: ReceiverId + receiver_name: + type: string + x-go-name: ReceiverName + receiver_type: + type: string + x-go-name: ReceiverType + send_by: + type: string + x-go-name: SendBy + sendAt: + format: date-time + type: string + x-go-name: SendAt + status: + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverCreateInput: + 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 + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + email: + description: 'description: user email' + example: example@gmail.com + type: string + x-go-name: Email + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + enabled_contact_types: + description: 'description: enabled contact types for user' + example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}' + items: + type: string + type: array + x-go-name: EnabledContactTypes + force_verified: + description: force verified if admin create the records + type: boolean + x-go-name: ForceVerified + 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 + international_mobile: + $ref: '#/definitions/SInternationalMobile' + 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 + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + uid: + description: 'description: user id in keystone' + example: adfb720ccdd34c638346ea4fa7a713a8 + type: string + x-go-name: UID + uname: + description: 'description: user name in keystone' + example: hello + type: string + x-go-name: UName + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverDetails: + 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 + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + email: + type: string + x-go-name: Email + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + enabled_contact_types: + description: 'description: enabled contact types for user' + example: eamil, mobile, feishu, dingtalk, workwx + items: + type: string + type: array + x-go-name: EnabledContactTypes + id: + description: 资源UUID + type: string + x-go-name: Id + international_mobile: + $ref: '#/definitions/SInternationalMobile' + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + lang: + type: string + x-go-name: Lang + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + verified_infos: + description: 'description: verified info' + items: + $ref: '#/definitions/VerifiedInfo' + type: array + x-go-name: VerifiedInfos + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverEnableContactTypeInput: + properties: + enabled_contact_types: + items: + type: string + type: array + x-go-name: EnabledContactTypes + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverGetSubscriptionOptions: + properties: + Id: + type: string + ShowDisabled: + type: boolean + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverIntellijGetInput: + properties: + create_if_no: + description: 'description: create if receiver with UserId does not exist' + type: boolean + x-go-name: CreateIfNo + scope: + description: 'description: scope' + type: string + x-go-name: Scope + user_id: + description: 'description: user id in keystone' + type: string + x-go-name: UserId + required: + - user_id + - scope + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverTriggerVerifyInput: + properties: + contact_type: + description: 'description: contact type' + enum: + - email + - mobile + example: email + type: string + x-go-name: ContactType + required: + - contact_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + email: + description: 'description: user email' + example: example@gmail.com + type: string + x-go-name: Email + enabled_contact_types: + description: 'description: enabled contacts for user' + example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}' + items: + type: string + type: array + x-go-name: EnabledContactTypes + force_verified: + type: boolean + x-go-name: ForceVerified + international_mobile: + $ref: '#/definitions/SInternationalMobile' + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverVerifyInput: + properties: + contact_type: + description: 'description: Contact type' + enum: + - email + - mobile + example: email + type: string + x-go-name: ContactType + token: + description: 'description: token user input' + example: "123456" + type: string + x-go-name: Token + required: + - contact_type + - token + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + RobotCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + address: + description: 'description: address' + example: http://helloworld.io/test/webhook + type: string + x-go-name: Address + body: + type: object + x-go-name: Body + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + 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 + header: + type: object + x-go-name: Header + 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: 'description: indicate the resource is a system resource, which is not visible to user' + type: boolean + x-go-name: IsSystem + lang: + description: 'description: Language preference' + example: zh_CN + type: string + x-go-name: Lang + msg_key: + type: string + x-go-name: MsgKey + 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_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + type: + description: 'description: robot type' + enum: + - feishu + - dingtalk + - workwx + - webhook + example: webhook + type: string + x-go-name: Type + use_template: + $ref: '#/definitions/TriState' + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + RobotDetails: + 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 + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_metadata: + additionalProperties: + type: string + type: object + x-go-name: ProjectMetadata + 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 + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + RobotUpdateInput: + properties: + address: + description: 'description: address' + example: http://helloworld.io/test/webhook + type: string + x-go-name: Address + body: + type: object + x-go-name: Body + description: + description: 资源描述 + type: string + x-go-name: Description + header: + type: object + x-go-name: Header + lang: + description: 'description: Language preference' + example: en + type: string + x-go-name: Lang + msg_key: + type: string + x-go-name: MsgKey + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SAction: type: string - x-go-name: Name - progress: - description: 操作进度0-100 - format: float - type: number - x-go-name: Progress - resource_types: - description: 'description: resources managed' - example: - - server - - eip - - disk + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SContact: + properties: + contact: + type: string + x-go-name: Contact + contact_type: + type: string + x-go-name: ContactType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SEmailAttachment: + properties: + content: + type: string + x-go-name: Base64Content + filename: + type: string + x-go-name: Filename + mime: + type: string + x-go-name: Mime + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SInternationalMobile: + properties: + area_code: + description: 'description: area code of mobile' + example: "86" + type: string + x-go-name: AreaCode + mobile: + description: 'description: user mobile' + example: "17812345678" + type: string + x-go-name: Mobile + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SNotifyConfigContent: + properties: + AccessKeyId: + description: sms + type: string + AccessKeySecret: + type: string + AccessToken: + type: string + AgentId: + description: workwx + type: string + AppId: + description: Lark + type: string + AppKey: + description: |- + dingtalk + AgentId string + AppSecret string + type: string + AppSecret: + type: string + CorpId: + type: string + Hostname: + description: Email + type: string + Hostport: + format: int64 + type: integer + Password: + type: string + Secret: + type: string + SenderAddress: + type: string + ServiceUrl: + type: string + Signature: + type: string + SmsDriver: + type: string + SslGlobal: + type: boolean + Username: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SResult: + type: string + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + 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 + STopicGroupKeys: items: - type: string + type: string type: array - x-go-name: Resources - resources: - format: uint64 - type: integer - x-go-name: Resources - results: - type: boolean - x-go-name: Results - status: - description: 资源状态 + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + 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 + StandaloneAnonResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneAnonResourceDetails: + 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 + StatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + 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 + SubscriberChangeInput: + properties: + GroupTimes: + description: minutes + format: uint32 + type: integer + Receivers: + description: 'description: receivers which is required when the type is ''receiver'' will Subscribe TopicID' + items: + type: string + type: array + Robot: + description: 'description: Robot(Id or Name) which is required when the type is ''robot'' will Subscribe TopicID' + type: string + Role: + description: 'description: Role(Id or Name) which is required when the type is ''role'' will Subscribe TopicID' + type: string + RoleScope: + description: 'description: The scope of role subscribers' + enum: + - system + - domain + - project + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SubscriberCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + DomainId: + description: 'description: domain id of resource' + example: 1e3824756bac4ac084e784ed297ec652 + type: string + GroupTimes: + description: minutes + format: uint32 + type: integer + Receivers: + description: 'description: receivers which is required when the type is ''receiver'' will Subscribe TopicID' + items: + type: string + type: array + ResourceAttributionId: + description: 'description: project id or domain id of resource' + example: 1e3824756bac4ac084e784ed297ec652 + type: string + ResourceAttributionName: + type: string + ResourceScope: + description: 'description: scope of resource' + enum: + - system + - domain + - project + type: string + Robot: + description: 'description: Robot(Id or Name) which is required when the type is ''robot'' will Subscribe TopicID' + type: string + Role: + description: 'description: Role(Id or Name) which is required when the type is ''role'' will Subscribe TopicID' + type: string + RoleScope: + description: 'description: The scope of role subscribers' + enum: + - system + - domain + - project + type: string + Scope: + description: 'description: scope' + enum: + - system + - domain + type: string + TopicID: + description: |- + description: Id of Topic + required + type: string + Type: + description: 'description: Type of subscriber' + enum: + - receiver + - robot + - role + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SubscriberDetails: + properties: + Receivers: + description: 'description: receivers' + items: + $ref: '#/definitions/Identification' + type: array + Robot: + $ref: '#/definitions/Identification' + Role: + $ref: '#/definitions/Identification' + 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 + group_times: + description: minutes + format: uint32 + type: integer + x-go-name: GroupTimes + id: + description: 资源UUID + type: string + x-go-name: Id + identification: + type: string + x-go-name: Identification + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + resource_attribution_id: + type: string + x-go-name: ResourceAttributionId + resource_attribution_name: + type: string + x-go-name: ResourceAttributionName + resource_scope: + type: string + x-go-name: ResourceScope + role_scope: + type: string + x-go-name: RoleScope + scope: + type: string + x-go-name: Scope + topic_id: + type: string + x-go-name: TopicId + 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/notify + SubscriberSetReceiverInput: + properties: + Receivers: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + 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 + TemplateCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + contact_type: + description: |- + description: Contact type, specifically, setting it to all means all contact type + require: true + example: email + type: string + x-go-name: ContactType + content: + description: 'description: Template content' + example: 镜像 {{.name}} 上传完成 + type: string + x-go-name: Content + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + example: + description: 'description: Example for using this template' + example: '{"name": "centos7.6"}' + type: string + x-go-name: Example + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + lang: + description: 'description: Language' + enum: + - cn + - en + type: string + x-go-name: Lang + template_type: + description: 'description: Template type' + enum: + - title + - content + - remote + example: title + type: string + x-go-name: TemplateType + topic: + description: 'description: Template topic' + example: IMAGE_ACTIVE + type: string + x-go-name: Topic + required: + - topic + - content + - example + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + TemplateManagerSaveInput: + properties: + ContactType: + type: string + Force: + type: boolean + Templates: + items: + $ref: '#/definitions/TemplateCreateInput' + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + TemplateUpdateInput: + properties: + content: + description: 'description: template content' + example: 镜像 {{.name}} 上传完成 + type: string + x-go-name: Content + description: + description: 资源描述 + type: string + x-go-name: Description + example: + description: 'description: all example for using this template' + example: '{"name": "centos7.6"}' + type: string + x-go-name: Example + required: + - content + - example + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + TopicDetails: + properties: + actions: + format: uint64 + type: integer + x-go-name: Actions + advance_days: + items: + format: int64 + type: integer + type: array + x-go-name: AdvanceDays + 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 + content_cn: + type: string + x-go-name: ContentCn + content_en: + type: string + x-go-name: ContentEn + 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: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + group_keys: + $ref: '#/definitions/STopicGroupKeys' + 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 + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + resource_types: + description: 'description: resources managed' + example: + - server + - eip + - disk + items: + type: string + type: array + x-go-name: Resources + resources: + format: uint64 + type: integer + x-go-name: Resources + results: + type: boolean + x-go-name: Results + status: + description: 资源状态 + type: string + x-go-name: Status + title_cn: + type: string + x-go-name: TitleCn + title_en: + type: string + x-go-name: TitleEn + 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 + webconsole_disable: + type: boolean + x-go-name: WebconsoleDisable + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + TopicUpdateInput: + properties: + ContentCn: + type: string + ContentEn: + type: string + TitleCn: + type: string + TitleEn: + type: string + advance_days: + items: + format: int64 + type: integer + type: array + x-go-name: AdvanceDays + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + TriState: type: string - x-go-name: Status - title_cn: - type: string - x-go-name: TitleCn - title_en: - type: string - x-go-name: TitleEn - 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 - webconsole_disable: - type: boolean - x-go-name: WebconsoleDisable - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify - VerifiedInfo: - properties: - ContactType: - type: string - Note: - type: string - Verified: - type: boolean - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/notify + x-go-package: yunion.io/x/pkg/tristate + VerifiedInfo: + properties: + ContactType: + type: string + Note: + type: string + Verified: + type: boolean + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify host: '"127.0.0.1:8889"' info: - contact: - email: lizexi@yunion.cn - name: Zexi Li - description: Notify API - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html - version: "1.0" + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Notify API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" paths: - /configs: - get: - description: 列表 - operationId: config_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') - 支持的操作符如下： + /configs: + get: + description: 列表 + operationId: config_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 - - in: query - name: type - type: string - x-go-name: Type - - in: query - name: attribution - type: string - x-go-name: Attribution - responses: - "200": - $ref: '#/responses/config_ListItemFilterOutput' - summary: 列表 - tags: - - config - post: - description: 新建 - operationId: config_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - config: - $ref: '#/definitions/ConfigCreateInput' - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/config_ValidateCreateDataOutput' - summary: 新建 - tags: - - config - /configs/{id}: - delete: - description: 删除 - operationId: config_CustomizeDelete - parameters: - - description: The Id or Name of config - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/config_CustomizeDeleteOutput' - summary: 删除 - tags: - - config - get: - description: 获取详情 - operationId: config_FetchCustomizeColumns - parameters: - - description: The Id or Name of config - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/config_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - config - put: - description: 更新 - operationId: config_ValidateUpdateData - parameters: - - description: The Id or Name of config - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - config: - $ref: '#/definitions/ConfigUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/config_ValidateUpdateDataOutput' - summary: 更新 - tags: - - config - /configs/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: config_PerformChangeOwner - parameters: - - description: The Id or Name of config - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - config: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/config_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - config - /configs/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: config_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of config - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/config_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - config - /configs/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: config_GetDetailsClassMetadata - parameters: - - description: The Id or Name of config - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/config_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - config - post: - description: 执行操作ClassMetadata - operationId: config_PerformClassMetadata - parameters: - - description: The Id or Name of config - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - config: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/config_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - config - /configs/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: config_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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 + - in: query + name: type + type: string + x-go-name: Type + - in: query + name: attribution + type: string + x-go-name: Attribution + responses: + "200": + $ref: '#/responses/config_ListItemFilterOutput' + summary: 列表 + tags: + - config + post: + description: 新建 + operationId: config_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/ConfigCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_ValidateCreateDataOutput' + summary: 新建 + tags: + - config + /configs/{id}: + delete: + description: 删除 + operationId: config_CustomizeDelete + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_CustomizeDeleteOutput' + summary: 删除 + tags: + - config + get: + description: 获取详情 + operationId: config_FetchCustomizeColumns + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - config + put: + description: 更新 + operationId: config_ValidateUpdateData + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/ConfigUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_ValidateUpdateDataOutput' + summary: 更新 + tags: + - config + /configs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: config_PerformChangeOwner + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - config + /configs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: config_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - config + /configs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: config_GetDetailsClassMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - config + post: + description: 执行操作ClassMetadata + operationId: config_PerformClassMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - config + /configs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: config_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 config - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/config_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - config - /configs/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: config_PerformSetClassMetadata - parameters: - - description: The Id or Name of config - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - config: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/config_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - config - /configs/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: config_PerformSetUserMetadata - parameters: - - description: The Id or Name of config - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - config: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/config_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - config - /configs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: config_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/config_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - config - /configs/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: config_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/config_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - config - /configs/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: config_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/config_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - config - /configs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: config_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - config: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/config_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - config - /configs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: config_GetPropertySplitable - responses: - "200": - $ref: '#/responses/config_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - config - /configs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: config_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/config_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - config - /configs/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: config_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/config_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - config - /configs/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: config_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/config_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - config - /configs/validate: - post: - description: 执行操作Validate - operationId: config_PerformValidate - parameters: - - in: body - name: body - schema: - properties: - config: - $ref: '#/definitions/ConfigValidateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/config_PerformValidateOutput' - summary: 执行操作Validate - tags: - - config - /email_queue_statuses: - get: - description: 列表 - operationId: email_queue_status_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - config + /configs/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: config_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - config + /configs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: config_PerformSetClassMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - config + /configs/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: config_PerformSetOrgMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - config + /configs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: config_PerformSetUserMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - config + /configs/capability: + get: + description: 获取指定资源类的信息Capability + operationId: config_GetPropertyCapability + responses: + "200": + $ref: '#/responses/config_GetPropertyCapabilityOutput' + summary: 获取指定资源类的信息Capability + tags: + - config + /configs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: config_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/config_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - config + /configs/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: config_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/config_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - config + /configs/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: config_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/config_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - config + /configs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: config_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - config + /configs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: config_GetPropertySplitable + responses: + "200": + $ref: '#/responses/config_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - config + /configs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: config_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/config_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - config + /configs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: config_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/config_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - config + /configs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: config_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/config_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - config + /configs/validate: + post: + description: 执行操作Validate + operationId: config_PerformValidate + parameters: + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/ConfigValidateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformValidateOutput' + summary: 执行操作Validate + tags: + - config + /email_queue_statuses: + get: + description: 列表 + operationId: email_queue_status_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/email_queue_status_ListItemFilterOutput' - summary: 列表 - tags: - - email_queue_status - post: - description: 新建 - operationId: email_queue_status_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - email_queue_status: - $ref: '#/definitions/ModelBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/email_queue_status_ValidateCreateDataOutput' - summary: 新建 - tags: - - email_queue_status - /email_queue_statuses/{id}: - delete: - description: 删除 - operationId: email_queue_status_CustomizeDelete - parameters: - - description: The Id or Name of email_queue_status - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/email_queue_status_CustomizeDeleteOutput' - summary: 删除 - tags: - - email_queue_status - get: - description: 获取详情 - operationId: email_queue_status_FetchCustomizeColumns - parameters: - - description: The Id or Name of email_queue_status - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/email_queue_status_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - email_queue_status - put: - description: 更新 - operationId: email_queue_status_ValidateUpdateData - parameters: - - description: The Id or Name of email_queue_status - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - email_queue_status: - $ref: '#/definitions/ModelBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/email_queue_status_ValidateUpdateDataOutput' - summary: 更新 - tags: - - email_queue_status - /email_queue_statuses/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: email_queue_status_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/email_queue_status_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - email_queue_status - /email_queue_statuses/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: email_queue_status_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - email_queue_status: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/email_queue_status_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - email_queue_status - /email_queue_statuses/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: email_queue_status_GetPropertySplitable - responses: - "200": - $ref: '#/responses/email_queue_status_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - email_queue_status - /email_queue_statuses/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: email_queue_status_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/email_queue_status_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - email_queue_status - /email_queues: - get: - description: 列表 - operationId: email_queue_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/email_queue_status_ListItemFilterOutput' + summary: 列表 + tags: + - email_queue_status + post: + description: 新建 + operationId: email_queue_status_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + email_queue_status: + $ref: '#/definitions/ModelBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_status_ValidateCreateDataOutput' + summary: 新建 + tags: + - email_queue_status + /email_queue_statuses/{id}: + delete: + description: 删除 + operationId: email_queue_status_CustomizeDelete + parameters: + - description: The Id or Name of email_queue_status + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_status_CustomizeDeleteOutput' + summary: 删除 + tags: + - email_queue_status + get: + description: 获取详情 + operationId: email_queue_status_FetchCustomizeColumns + parameters: + - description: The Id or Name of email_queue_status + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_status_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - email_queue_status + put: + description: 更新 + operationId: email_queue_status_ValidateUpdateData + parameters: + - description: The Id or Name of email_queue_status + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_status_ValidateUpdateDataOutput' + summary: 更新 + tags: + - email_queue_status + /email_queue_statuses/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: email_queue_status_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/email_queue_status_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - email_queue_status + /email_queue_statuses/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: email_queue_status_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + email_queue_status: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_status_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - email_queue_status + /email_queue_statuses/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: email_queue_status_GetPropertySplitable + responses: + "200": + $ref: '#/responses/email_queue_status_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - email_queue_status + /email_queue_statuses/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: email_queue_status_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/email_queue_status_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - email_queue_status + /email_queues: + get: + description: 列表 + operationId: email_queue_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: - format: int64 - type: integer - name: id - type: array - x-go-name: Id - - in: query - items: - type: string - name: to - type: array - x-go-name: To - - in: query - name: subject - type: string - x-go-name: Subject - - in: query - items: - type: string - name: session_id - type: array - x-go-name: SessionId - responses: - "200": - $ref: '#/responses/email_queue_ListItemFilterOutput' - summary: 宿主机/物理机列表 - tags: - - email_queue - post: - description: 新建 - operationId: email_queue_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - email_queue: - $ref: '#/definitions/EmailQueueCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/email_queue_ValidateCreateDataOutput' - summary: 新建 - tags: - - email_queue - /email_queues/{id}: - delete: - description: 删除 - operationId: email_queue_CustomizeDelete - parameters: - - description: The Id or Name of email_queue - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/email_queue_CustomizeDeleteOutput' - summary: 删除 - tags: - - email_queue - get: - description: 获取详情 - operationId: email_queue_FetchCustomizeColumns - parameters: - - description: The Id or Name of email_queue - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/email_queue_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - email_queue - put: - description: 更新 - operationId: email_queue_ValidateUpdateData - parameters: - - description: The Id or Name of email_queue - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/email_queue_ValidateUpdateDataOutput' - summary: 更新 - tags: - - email_queue - /email_queues/{id}/send: - post: - description: 执行操作Send - operationId: email_queue_PerformSend - parameters: - - description: The Id or Name of email_queue - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - email_queue: - $ref: '#/definitions/EmailQueueSendInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/email_queue_PerformSendOutput' - summary: 执行操作Send - tags: - - email_queue - /email_queues/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: email_queue_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/email_queue_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - email_queue - /email_queues/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: email_queue_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - email_queue: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/email_queue_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - email_queue - /email_queues/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: email_queue_GetPropertySplitable - responses: - "200": - $ref: '#/responses/email_queue_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - email_queue - /email_queues/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: email_queue_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/email_queue_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - email_queue - /events: - get: - description: 列表 - operationId: event_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: + format: int64 + type: integer + name: id + type: array + x-go-name: Id + - in: query + items: + type: string + name: to + type: array + x-go-name: To + - in: query + name: subject + type: string + x-go-name: Subject + - in: query + items: + type: string + name: session_id + type: array + x-go-name: SessionId + responses: + "200": + $ref: '#/responses/email_queue_ListItemFilterOutput' + summary: 宿主机/物理机列表 + tags: + - email_queue + post: + description: 新建 + operationId: email_queue_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + email_queue: + $ref: '#/definitions/EmailQueueCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_ValidateCreateDataOutput' + summary: 新建 + tags: + - email_queue + /email_queues/{id}: + delete: + description: 删除 + operationId: email_queue_CustomizeDelete + parameters: + - description: The Id or Name of email_queue + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_CustomizeDeleteOutput' + summary: 删除 + tags: + - email_queue + get: + description: 获取详情 + operationId: email_queue_FetchCustomizeColumns + parameters: + - description: The Id or Name of email_queue + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - email_queue + put: + description: 更新 + operationId: email_queue_ValidateUpdateData + parameters: + - description: The Id or Name of email_queue + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_ValidateUpdateDataOutput' + summary: 更新 + tags: + - email_queue + /email_queues/{id}/send: + post: + description: 执行操作Send + operationId: email_queue_PerformSend + parameters: + - description: The Id or Name of email_queue + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueSendInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_PerformSendOutput' + summary: 执行操作Send + tags: + - email_queue + /email_queues/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: email_queue_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/email_queue_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - email_queue + /email_queues/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: email_queue_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + email_queue: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - email_queue + /email_queues/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: email_queue_GetPropertySplitable + responses: + "200": + $ref: '#/responses/email_queue_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - email_queue + /email_queues/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: email_queue_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/email_queue_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - email_queue + /events: + get: + description: 列表 + operationId: event_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/event_ListItemFilterOutput' - summary: 列表 - tags: - - event - post: - description: 新建 - operationId: event_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - event: - $ref: '#/definitions/ModelBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/event_ValidateCreateDataOutput' - summary: 新建 - tags: - - event - /events/{id}: - delete: - description: 删除 - operationId: event_CustomizeDelete - parameters: - - description: The Id or Name of event - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/event_CustomizeDeleteOutput' - summary: 删除 - tags: - - event - get: - description: 获取详情 - operationId: event_FetchCustomizeColumns - parameters: - - description: The Id or Name of event - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/event_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - event - put: - description: 更新 - operationId: event_ValidateUpdateData - parameters: - - description: The Id or Name of event - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/event_ValidateUpdateDataOutput' - summary: 更新 - tags: - - event - /events/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: event_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/event_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - event - /events/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: event_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - event: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/event_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - event - /events/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: event_GetPropertySplitable - responses: - "200": - $ref: '#/responses/event_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - event - /events/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: event_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/event_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - event - /notification_logs: - get: - description: 列表 - operationId: notification_log_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/event_ListItemFilterOutput' + summary: 列表 + tags: + - event + post: + description: 新建 + operationId: event_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + event: + $ref: '#/definitions/ModelBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/event_ValidateCreateDataOutput' + summary: 新建 + tags: + - event + /events/{id}: + delete: + description: 删除 + operationId: event_CustomizeDelete + parameters: + - description: The Id or Name of event + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/event_CustomizeDeleteOutput' + summary: 删除 + tags: + - event + get: + description: 获取详情 + operationId: event_FetchCustomizeColumns + parameters: + - description: The Id or Name of event + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/event_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - event + put: + description: 更新 + operationId: event_ValidateUpdateData + parameters: + - description: The Id or Name of event + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/event_ValidateUpdateDataOutput' + summary: 更新 + tags: + - event + /events/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: event_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/event_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - event + /events/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: event_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + event: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/event_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - event + /events/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: event_GetPropertySplitable + responses: + "200": + $ref: '#/responses/event_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - event + /events/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: event_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/event_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - event + /notification_groups: + get: + description: 列表 + operationId: notification_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 - responses: - "200": - $ref: '#/responses/notification_log_ListItemFilterOutput' - summary: 列表 - tags: - - notification_log - post: - description: 新建 - operationId: notification_log_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - notification_log: - $ref: '#/definitions/ModelBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_log_ValidateCreateDataOutput' - summary: 新建 - tags: - - notification_log - /notification_logs/{id}: - delete: - description: 删除 - operationId: notification_log_CustomizeDelete - parameters: - - description: The Id or Name of notification_log - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/notification_log_CustomizeDeleteOutput' - summary: 删除 - tags: - - notification_log - get: - description: 获取详情 - operationId: notification_log_FetchCustomizeColumns - parameters: - - description: The Id or Name of notification_log - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/notification_log_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - notification_log - put: - description: 更新 - operationId: notification_log_ValidateUpdateData - parameters: - - description: The Id or Name of notification_log - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/notification_log_ValidateUpdateDataOutput' - summary: 更新 - tags: - - notification_log - /notification_logs/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: notification_log_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/notification_log_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - notification_log - /notification_logs/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: notification_log_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - notification_log: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_log_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - notification_log - /notification_logs/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: notification_log_GetPropertySplitable - responses: - "200": - $ref: '#/responses/notification_log_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - notification_log - /notification_logs/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: notification_log_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/notification_log_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - notification_log - /notifications: - get: - description: 列表 - operationId: notification_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/notification_group_ListItemFilterOutput' + summary: 列表 + tags: + - notification_group + post: + description: 新建 + operationId: notification_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + notification_group: + $ref: '#/definitions/ModelBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - notification_group + /notification_groups/{id}: + delete: + description: 删除 + operationId: notification_group_CustomizeDelete + parameters: + - description: The Id or Name of notification_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - notification_group + get: + description: 获取详情 + operationId: notification_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of notification_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - notification_group + put: + description: 更新 + operationId: notification_group_ValidateUpdateData + parameters: + - description: The Id or Name of notification_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification_group: + $ref: '#/definitions/ModelBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - notification_group + /notification_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: notification_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/notification_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - notification_group + /notification_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: notification_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + notification_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - notification_group + /notification_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: notification_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/notification_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - notification_group + /notification_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: notification_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/notification_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - notification_group + /notification_logs: + get: + description: 列表 + operationId: notification_log_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 - - in: query - name: ContactType - type: string - - in: query - name: ReceiverId - type: string - - in: query - name: Tag - type: string - - in: query - name: TopicType - type: string - responses: - "200": - $ref: '#/responses/notification_ListItemFilterOutput' - summary: 通知消息列表 - tags: - - notification - post: - description: 新建 - operationId: notification_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - notification: - $ref: '#/definitions/NotificationCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_ValidateCreateDataOutput' - summary: 新建 - tags: - - notification - /notifications/{id}: - delete: - description: 删除 - operationId: notification_CustomizeDelete - parameters: - - description: The Id or Name of notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/notification_CustomizeDeleteOutput' - summary: 删除 - tags: - - notification - get: - description: 获取详情 - operationId: notification_FetchCustomizeColumns - parameters: - - description: The Id or Name of notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/notification_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - notification - put: - description: 更新 - operationId: notification_ValidateUpdateData - parameters: - - description: The Id or Name of notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - notification: - $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_ValidateUpdateDataOutput' - summary: 更新 - tags: - - notification - /notifications/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: notification_GetDetailsClassMetadata - parameters: - - description: The Id or Name of notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/notification_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - notification - post: - description: 执行操作ClassMetadata - operationId: notification_PerformClassMetadata - parameters: - - description: The Id or Name of notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - notification: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - notification - /notifications/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: notification_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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/notification_log_ListItemFilterOutput' + summary: 列表 + tags: + - notification_log + post: + description: 新建 + operationId: notification_log_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + notification_log: + $ref: '#/definitions/ModelBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_log_ValidateCreateDataOutput' + summary: 新建 + tags: + - notification_log + /notification_logs/{id}: + delete: + description: 删除 + operationId: notification_log_CustomizeDelete + parameters: + - description: The Id or Name of notification_log + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_log_CustomizeDeleteOutput' + summary: 删除 + tags: + - notification_log + get: + description: 获取详情 + operationId: notification_log_FetchCustomizeColumns + parameters: + - description: The Id or Name of notification_log + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_log_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - notification_log + put: + description: 更新 + operationId: notification_log_ValidateUpdateData + parameters: + - description: The Id or Name of notification_log + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_log_ValidateUpdateDataOutput' + summary: 更新 + tags: + - notification_log + /notification_logs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: notification_log_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/notification_log_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - notification_log + /notification_logs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: notification_log_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + notification_log: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_log_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - notification_log + /notification_logs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: notification_log_GetPropertySplitable + responses: + "200": + $ref: '#/responses/notification_log_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - notification_log + /notification_logs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: notification_log_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/notification_log_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - notification_log + /notifications: + get: + description: 列表 + operationId: notification_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') + 支持的操作符如下： - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | 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 notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/notification_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - notification - /notifications/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: notification_PerformSetClassMetadata - parameters: - - description: The Id or Name of notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - notification: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - notification - /notifications/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: notification_PerformSetUserMetadata - parameters: - - description: The Id or Name of notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - notification: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - notification - /notifications/{id}/status: - get: - description: 获取指定信息Status - operationId: notification_GetDetailsStatus - parameters: - - description: The Id or Name of notification - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/notification_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - notification - post: - description: 执行操作Status - operationId: notification_PerformStatus - parameters: - - description: The Id or Name of notification - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - notification: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_PerformStatusOutput' - summary: 更新资源状态 - tags: - - notification - /notifications/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: notification_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/notification_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - notification - /notifications/event-notify: - post: - description: 执行操作EventNotify - operationId: notification_PerformEventNotify - parameters: - - in: body - name: body - schema: - properties: - notification: - $ref: '#/definitions/NotificationManagerEventNotifyInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_PerformEventNotifyOutput' - summary: 'TODO: support project and domain' - tags: - - notification - /notifications/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: notification_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - notification: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/notification_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - notification - /notifications/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: notification_GetPropertySplitable - responses: - "200": - $ref: '#/responses/notification_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - notification - /notifications/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: notification_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/notification_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - notification - /notifications/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: notification_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/notification_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - notification - /notifications/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: notification_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/notification_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - notification - /notifications/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: notification_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/notification_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - notification - /receivers: - get: - description: 列表 - operationId: receiver_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 + - in: query + name: ContactType + type: string + - in: query + name: ReceiverId + type: string + - in: query + name: Tag + type: string + - in: query + name: TopicType + type: string + responses: + "200": + $ref: '#/responses/notification_ListItemFilterOutput' + summary: 通知消息列表 + tags: + - notification + post: + description: 新建 + operationId: notification_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + notification: + $ref: '#/definitions/NotificationCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_ValidateCreateDataOutput' + summary: 新建 + tags: + - notification + /notifications/{id}: + delete: + description: 删除 + operationId: notification_CustomizeDelete + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_CustomizeDeleteOutput' + summary: 删除 + tags: + - notification + get: + description: 获取详情 + operationId: notification_FetchCustomizeColumns + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - notification + put: + description: 更新 + operationId: notification_ValidateUpdateData + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_ValidateUpdateDataOutput' + summary: 更新 + tags: + - notification + /notifications/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: notification_GetDetailsClassMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - notification + post: + description: 执行操作ClassMetadata + operationId: notification_PerformClassMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - notification + /notifications/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: notification_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源的状态过滤列表 - in: query - items: - type: string - name: status - type: array - x-go-name: Status - - description: 以资源是否启用/禁用过滤列表 - in: query - name: enabled - type: boolean - x-go-name: Enabled - - in: query - name: uid - type: string - x-go-name: UID - - in: query - name: uname - type: string - x-go-name: UName - - in: query - name: enabled_contact_type - type: string - x-go-name: EnabledContactType - - in: query - name: verified_contact_type - type: string - x-go-name: VerifiedContactType - - in: query - name: project_domain_filter - type: boolean - x-go-name: ProjectDomainFilter - responses: - "200": - $ref: '#/responses/receiver_ListItemFilterOutput' - summary: 列表 - tags: - - receiver - post: - description: 新建 - operationId: receiver_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - receiver: - $ref: '#/definitions/ReceiverCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_ValidateCreateDataOutput' - summary: 新建 - tags: - - receiver - /receivers/{id}: - delete: - description: 删除 - operationId: receiver_CustomizeDelete - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/receiver_CustomizeDeleteOutput' - summary: 删除 - tags: - - receiver - get: - description: 获取详情 - operationId: receiver_FetchCustomizeColumns - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/receiver_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - receiver - put: - description: 更新 - operationId: receiver_ValidateUpdateData - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_ValidateUpdateDataOutput' - summary: 更新 - tags: - - receiver - /receivers/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: receiver_PerformChangeOwner - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - receiver - /receivers/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: receiver_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/receiver_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - receiver - /receivers/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: receiver_GetDetailsClassMetadata - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/receiver_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - receiver - post: - description: 执行操作ClassMetadata - operationId: receiver_PerformClassMetadata - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - receiver - /receivers/{id}/disable: - post: - description: 执行操作Disable - operationId: receiver_PerformDisable - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformDisableOutput' - summary: 执行操作Disable - tags: - - receiver - /receivers/{id}/enable: - post: - description: 执行操作Enable - operationId: receiver_PerformEnable - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformEnableOutput' - summary: 执行操作Enable - tags: - - receiver - /receivers/{id}/enable-contact-type: - post: - description: 执行操作EnableContactType - operationId: receiver_PerformEnableContactType - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverEnableContactTypeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformEnableContactTypeOutput' - summary: 执行操作EnableContactType - tags: - - receiver - /receivers/{id}/get-subscription: - post: - description: 执行操作GetSubscription - operationId: receiver_PerformGetSubscription - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverIntellijGetInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformGetSubscriptionOutput' - summary: 获取用户订阅 - tags: - - receiver - /receivers/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: receiver_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 notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - notification + /notifications/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: notification_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - notification + /notifications/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: notification_PerformSetClassMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - notification + /notifications/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: notification_PerformSetOrgMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - notification + /notifications/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: notification_PerformSetUserMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - notification + /notifications/{id}/status: + get: + description: 获取指定信息Status + operationId: notification_GetDetailsStatus + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - notification + post: + description: 执行操作Status + operationId: notification_PerformStatus + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformStatusOutput' + summary: 更新资源状态 + tags: + - notification + /notifications/contact-notify: + post: + description: 执行操作ContactNotify + operationId: notification_PerformContactNotify + parameters: + - in: body + name: body + schema: + properties: + notification: + $ref: '#/definitions/NotificationManagerContactNotifyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformContactNotifyOutput' + summary: 执行操作ContactNotify + tags: + - notification + /notifications/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: notification_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/notification_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - notification + /notifications/event-notify: + post: + description: 执行操作EventNotify + operationId: notification_PerformEventNotify + parameters: + - in: body + name: body + schema: + properties: + notification: + $ref: '#/definitions/NotificationManagerEventNotifyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformEventNotifyOutput' + summary: 'TODO: support project and domain' + tags: + - notification + /notifications/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: notification_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + notification: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - notification + /notifications/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: notification_GetPropertySplitable + responses: + "200": + $ref: '#/responses/notification_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - notification + /notifications/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: notification_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/notification_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - notification + /notifications/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: notification_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/notification_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - notification + /notifications/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: notification_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/notification_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - notification + /notifications/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: notification_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/notification_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - notification + /receivers: + get: + description: 列表 + operationId: receiver_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') + 支持的操作符如下： - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | 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 receiver - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/receiver_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - receiver - /receivers/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: receiver_PerformSetClassMetadata - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - receiver - /receivers/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: receiver_PerformSetUserMetadata - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - receiver - /receivers/{id}/status: - get: - description: 获取指定信息Status - operationId: receiver_GetDetailsStatus - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/receiver_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - receiver - post: - description: 执行操作Status - operationId: receiver_PerformStatus - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformStatusOutput' - summary: 更新资源状态 - tags: - - receiver - /receivers/{id}/trigger-verify: - post: - description: 执行操作TriggerVerify - operationId: receiver_PerformTriggerVerify - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverTriggerVerifyInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformTriggerVerifyOutput' - summary: 执行操作TriggerVerify - tags: - - receiver - /receivers/{id}/verify: - post: - description: 执行操作Verify - operationId: receiver_PerformVerify - parameters: - - description: The Id or Name of receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverVerifyInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformVerifyOutput' - summary: 执行操作Verify - tags: - - receiver - /receivers/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: receiver_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/receiver_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - receiver - /receivers/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: receiver_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/receiver_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - receiver - /receivers/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: receiver_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/receiver_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - receiver - /receivers/get-types: - post: - description: 执行操作GetTypes - operationId: receiver_PerformGetTypes - parameters: - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/ConfigManagerGetTypesInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformGetTypesOutput' - summary: 执行操作GetTypes - tags: - - receiver - /receivers/intellij-get: - post: - description: 执行操作IntellijGet - operationId: receiver_PerformIntellijGet - parameters: - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverIntellijGetInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformIntellijGetOutput' - summary: 执行操作IntellijGet - tags: - - receiver - /receivers/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: receiver_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - receiver: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/receiver_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - receiver - /receivers/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: receiver_GetPropertySplitable - responses: - "200": - $ref: '#/responses/receiver_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - receiver - /receivers/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: receiver_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/receiver_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - receiver - /receivers/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: receiver_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/receiver_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - receiver - /receivers/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: receiver_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/receiver_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - receiver - /robots: - get: - description: 列表 - operationId: robot_ListItemFilter - parameters: - - default: 20 - description: 查询限制量 - format: int64 - in: query - name: limit - type: integer - x-go-name: Limit - - default: 0 - description: 查询偏移量 - format: int64 - in: query - name: offset - type: integer - x-go-name: Offset - - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 - in: query - items: - type: string - name: order_by - type: array - x-go-name: OrderBy - - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 - example: desc|asc - in: query - name: order - type: string - x-go-name: Order - - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 - in: query - name: details - type: boolean - x-go-name: Details - - description: 模糊搜索所有字段 - in: query - name: search - type: string - x-go-name: Search - - description: |- - 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') - 支持的操作符如下： + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - in: query + name: uid + type: string + x-go-name: UID + - in: query + name: uname + type: string + x-go-name: UName + - in: query + name: enabled_contact_type + type: string + x-go-name: EnabledContactType + - in: query + name: verified_contact_type + type: string + x-go-name: VerifiedContactType + - in: query + name: project_domain_filter + type: boolean + x-go-name: ProjectDomainFilter + responses: + "200": + $ref: '#/responses/receiver_ListItemFilterOutput' + summary: 列表 + tags: + - receiver + post: + description: 新建 + operationId: receiver_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + receiver: + $ref: '#/definitions/ReceiverCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_ValidateCreateDataOutput' + summary: 新建 + tags: + - receiver + /receivers/{id}: + delete: + description: 删除 + operationId: receiver_CustomizeDelete + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_CustomizeDeleteOutput' + summary: 删除 + tags: + - receiver + get: + description: 获取详情 + operationId: receiver_FetchCustomizeColumns + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - receiver + put: + description: 更新 + operationId: receiver_ValidateUpdateData + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_ValidateUpdateDataOutput' + summary: 更新 + tags: + - receiver + /receivers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: receiver_PerformChangeOwner + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - receiver + /receivers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: receiver_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - receiver + /receivers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: receiver_GetDetailsClassMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - receiver + post: + description: 执行操作ClassMetadata + operationId: receiver_PerformClassMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - receiver + /receivers/{id}/disable: + post: + description: 执行操作Disable + operationId: receiver_PerformDisable + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformDisableOutput' + summary: 执行操作Disable + tags: + - receiver + /receivers/{id}/enable: + post: + description: 执行操作Enable + operationId: receiver_PerformEnable + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformEnableOutput' + summary: 执行操作Enable + tags: + - receiver + /receivers/{id}/enable-contact-type: + post: + description: 执行操作EnableContactType + operationId: receiver_PerformEnableContactType + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverEnableContactTypeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformEnableContactTypeOutput' + summary: 执行操作EnableContactType + tags: + - receiver + /receivers/{id}/get-subscription: + post: + description: 执行操作GetSubscription + operationId: receiver_PerformGetSubscription + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverGetSubscriptionOptions' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformGetSubscriptionOutput' + summary: 获取用户订阅 + tags: + - receiver + /receivers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: receiver_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - 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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID - in: query - name: project_id - type: string - x-go-name: ProjectId - - description: 对具有项目属性的资源，严格匹配项目ID - in: query - items: - type: string - name: project_ids - type: array - x-go-name: ProjectIds - - description: 按project名称排序，可能值为asc|desc - in: query - name: order_by_project - pattern: asc|desc - type: string - x-go-name: OrderByProject - - $ref: '#/definitions/TTagSetList' - description: filter by project tags - in: query - name: project_tags - x-go-name: ProjectTags - - $ref: '#/definitions/TTagSetList' - description: filter by no project tags - in: query - name: no_project_tags - x-go-name: NoProjectTags - - $ref: '#/definitions/TTagSetList' - description: |- - ignore - project tag fitlers imposed by policy - in: query - name: policy_project_tags - x-go-name: PolicyProjectTags - - description: 列表中包含标记为"系统资源"的资源 - in: query - name: system - type: boolean - x-go-name: System - - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） - in: query - name: pending_delete - type: boolean - x-go-name: PendingDelete - - 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: enabled - type: boolean - x-go-name: Enabled - - description: 'description: robot type' - enum: - - feishu - - dingtalk - - workwx - - webhook - example: webhook - in: query - name: type - type: string - x-go-name: Type - - description: 'description: Language preference' - example: en - in: query - name: lang - type: string - x-go-name: Lang - responses: - "200": - $ref: '#/responses/robot_ListItemFilterOutput' - summary: 列表 - tags: - - robot - post: - description: 新建 - operationId: robot_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - robot: - $ref: '#/definitions/RobotCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_ValidateCreateDataOutput' - summary: 新建 - tags: - - robot - /robots/{id}: - delete: - description: 删除 - operationId: robot_CustomizeDelete - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/robot_CustomizeDeleteOutput' - summary: 删除 - tags: - - robot - get: - description: 获取详情 - operationId: robot_FetchCustomizeColumns - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/robot_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - robot - put: - description: 更新 - operationId: robot_ValidateUpdateData - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/RobotUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_ValidateUpdateDataOutput' - summary: 更新 - tags: - - robot - /robots/{id}/cancel-delete: - post: - description: 执行操作CancelDelete - operationId: robot_PerformCancelDelete - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/robot_PerformCancelDeleteOutput' - summary: 执行操作CancelDelete - tags: - - robot - /robots/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: robot_PerformChangeOwner - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/PerformChangeProjectOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - robot - /robots/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: robot_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/robot_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - robot - /robots/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: robot_GetDetailsClassMetadata - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/robot_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - robot - post: - description: 执行操作ClassMetadata - operationId: robot_PerformClassMetadata - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - robot - /robots/{id}/disable: - post: - description: 执行操作Disable - operationId: robot_PerformDisable - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformDisableOutput' - summary: 执行操作Disable - tags: - - robot - /robots/{id}/enable: - post: - description: 执行操作Enable - operationId: robot_PerformEnable - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformEnableOutput' - summary: 执行操作Enable - tags: - - robot - /robots/{id}/freeze: - post: - description: 执行操作Freeze - operationId: robot_PerformFreeze - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/PerformFreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformFreezeOutput' - summary: freezed update and perform action operation except for unfreeze - tags: - - robot - /robots/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: robot_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 receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - receiver + /receivers/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: receiver_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - receiver + /receivers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: receiver_PerformSetClassMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - receiver + /receivers/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: receiver_PerformSetOrgMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - receiver + /receivers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: receiver_PerformSetUserMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - receiver + /receivers/{id}/status: + get: + description: 获取指定信息Status + operationId: receiver_GetDetailsStatus + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - receiver + post: + description: 执行操作Status + operationId: receiver_PerformStatus + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformStatusOutput' + summary: 更新资源状态 + tags: + - receiver + /receivers/{id}/trigger-verify: + post: + description: 执行操作TriggerVerify + operationId: receiver_PerformTriggerVerify + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverTriggerVerifyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformTriggerVerifyOutput' + summary: 执行操作TriggerVerify + tags: + - receiver + /receivers/{id}/verify: + post: + description: 执行操作Verify + operationId: receiver_PerformVerify + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverVerifyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformVerifyOutput' + summary: 执行操作Verify + tags: + - receiver + /receivers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: receiver_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/receiver_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - receiver + /receivers/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: receiver_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/receiver_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - receiver + /receivers/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: receiver_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/receiver_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - receiver + /receivers/get-types: + post: + description: 执行操作GetTypes + operationId: receiver_PerformGetTypes + parameters: + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ConfigManagerGetTypesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformGetTypesOutput' + summary: 执行操作GetTypes + tags: + - receiver + /receivers/intellij-get: + post: + description: 执行操作IntellijGet + operationId: receiver_PerformIntellijGet + parameters: + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverIntellijGetInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformIntellijGetOutput' + summary: 执行操作IntellijGet + tags: + - receiver + /receivers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: receiver_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - receiver + /receivers/role-contact-type: + get: + description: 获取指定资源类的信息RoleContactType + operationId: receiver_GetPropertyRoleContactType + parameters: + - in: query + items: + type: string + name: RoleIds + type: array + - in: query + name: Scope + type: string + - in: query + name: ProjectDomainId + type: string + - in: query + name: project_id + type: string + x-go-name: ProjectId + responses: + "200": + $ref: '#/responses/receiver_GetPropertyRoleContactTypeOutput' + summary: 获取指定资源类的信息RoleContactType + tags: + - receiver + /receivers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: receiver_GetPropertySplitable + responses: + "200": + $ref: '#/responses/receiver_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - receiver + /receivers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: receiver_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/receiver_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - receiver + /receivers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: receiver_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/receiver_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - receiver + /receivers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: receiver_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/receiver_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - receiver + /robots: + get: + description: 列表 + operationId: robot_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') + 支持的操作符如下： - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | 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 robot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/robot_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - robot - /robots/{id}/private: - post: - description: 执行操作Private - operationId: robot_PerformPrivate - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformPrivateOutput' - summary: 执行操作Private - tags: - - robot - /robots/{id}/public: - post: - description: 执行操作Public - operationId: robot_PerformPublic - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/PerformPublicProjectInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformPublicOutput' - summary: 执行操作Public - tags: - - robot - /robots/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: robot_PerformSetClassMetadata - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - robot - /robots/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: robot_PerformSetUserMetadata - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - robot - /robots/{id}/status: - get: - description: 获取指定信息Status - operationId: robot_GetDetailsStatus - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/robot_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - robot - post: - description: 执行操作Status - operationId: robot_PerformStatus - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformStatusOutput' - summary: 更新资源状态 - tags: - - robot - /robots/{id}/unfreeze: - post: - description: 执行操作Unfreeze - operationId: robot_PerformUnfreeze - parameters: - - description: The Id or Name of robot - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/PerformUnfreezeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformUnfreezeOutput' - summary: 执行操作Unfreeze - tags: - - robot - /robots/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: robot_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/robot_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - robot - /robots/domain-statistics: - get: - description: 获取指定资源类的信息DomainStatistics - operationId: robot_GetPropertyDomainStatistics - responses: - "200": - $ref: '#/responses/robot_GetPropertyDomainStatisticsOutput' - summary: 获取指定资源类的信息DomainStatistics - tags: - - robot - /robots/project-statistics: - get: - description: 获取指定资源类的信息ProjectStatistics - operationId: robot_GetPropertyProjectStatistics - responses: - "200": - $ref: '#/responses/robot_GetPropertyProjectStatisticsOutput' - summary: 获取指定资源类的信息ProjectStatistics - tags: - - robot - /robots/project-tag-value-pairs: - get: - description: 获取指定资源类的信息ProjectTagValuePairs - operationId: robot_GetPropertyProjectTagValuePairs - responses: - "200": - $ref: '#/responses/robot_GetPropertyProjectTagValuePairsOutput' - summary: 获取指定资源类的信息ProjectTagValuePairs - tags: - - robot - /robots/project-tag-value-tree: - get: - description: 获取指定资源类的信息ProjectTagValueTree - operationId: robot_GetPropertyProjectTagValueTree - responses: - "200": - $ref: '#/responses/robot_GetPropertyProjectTagValueTreeOutput' - summary: 获取指定资源类的信息ProjectTagValueTree - tags: - - robot - /robots/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: robot_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - robot: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/robot_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - robot - /robots/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: robot_GetPropertySplitable - responses: - "200": - $ref: '#/responses/robot_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - robot - /robots/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: robot_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/robot_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - robot - /robots/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: robot_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/robot_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - robot - /robots/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: robot_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/robot_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - robot - /robots/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: robot_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/robot_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - robot - /subscriber_receivers: - get: - description: 列表 - operationId: subscriber_receiver_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: 指定查询的权限范围，可能值为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: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - description: filter by project organizations + in: query + items: + type: string + name: project_organizations + type: array + x-go-name: ProjectOrganizations + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - 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: enabled + type: boolean + x-go-name: Enabled + - description: 'description: robot type' + enum: + - feishu + - dingtalk + - workwx + - webhook + example: webhook + in: query + name: type + type: string + x-go-name: Type + - description: 'description: Language preference' + example: en + in: query + name: lang + type: string + x-go-name: Lang + responses: + "200": + $ref: '#/responses/robot_ListItemFilterOutput' + summary: 列表 + tags: + - robot + post: + description: 新建 + operationId: robot_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + robot: + $ref: '#/definitions/RobotCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_ValidateCreateDataOutput' + summary: 新建 + tags: + - robot + /robots/{id}: + delete: + description: 删除 + operationId: robot_CustomizeDelete + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_CustomizeDeleteOutput' + summary: 删除 + tags: + - robot + get: + description: 获取详情 + operationId: robot_FetchCustomizeColumns + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - robot + put: + description: 更新 + operationId: robot_ValidateUpdateData + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/RobotUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_ValidateUpdateDataOutput' + summary: 更新 + tags: + - robot + /robots/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: robot_PerformCancelDelete + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - robot + /robots/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: robot_PerformChangeOwner + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - robot + /robots/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: robot_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - robot + /robots/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: robot_GetDetailsClassMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - robot + post: + description: 执行操作ClassMetadata + operationId: robot_PerformClassMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - robot + /robots/{id}/disable: + post: + description: 执行操作Disable + operationId: robot_PerformDisable + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformDisableOutput' + summary: 执行操作Disable + tags: + - robot + /robots/{id}/enable: + post: + description: 执行操作Enable + operationId: robot_PerformEnable + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformEnableOutput' + summary: 执行操作Enable + tags: + - robot + /robots/{id}/freeze: + post: + description: 执行操作Freeze + operationId: robot_PerformFreeze + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - robot + /robots/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: robot_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - 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/subscriber_receiver_ListItemFilterOutput' - summary: 列表 - tags: - - subscriber_receiver - post: - description: 新建 - operationId: subscriber_receiver_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - subscriber_receiver: - $ref: '#/definitions/JoinResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_receiver_ValidateCreateDataOutput' - summary: 新建 - tags: - - subscriber_receiver - /subscriber_receivers/{id}: - delete: - description: 删除 - operationId: subscriber_receiver_CustomizeDelete - parameters: - - description: The Id or Name of subscriber_receiver - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/subscriber_receiver_CustomizeDeleteOutput' - summary: 删除 - tags: - - subscriber_receiver - get: - description: 获取详情 - operationId: subscriber_receiver_FetchCustomizeColumns - parameters: - - description: The Id or Name of subscriber_receiver - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/subscriber_receiver_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - subscriber_receiver - put: - description: 更新 - operationId: subscriber_receiver_ValidateUpdateData - parameters: - - description: The Id or Name of subscriber_receiver - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - subscriber_receiver: - $ref: '#/definitions/JointResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_receiver_ValidateUpdateDataOutput' - summary: 更新 - tags: - - subscriber_receiver - /subscriber_receivers/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: subscriber_receiver_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/subscriber_receiver_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - subscriber_receiver - /subscriber_receivers/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: subscriber_receiver_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - subscriber_receiver: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_receiver_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - subscriber_receiver - /subscriber_receivers/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: subscriber_receiver_GetPropertySplitable - responses: - "200": - $ref: '#/responses/subscriber_receiver_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - subscriber_receiver - /subscriber_receivers/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: subscriber_receiver_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/subscriber_receiver_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - subscriber_receiver - /subscribers: - get: - description: 列表 - operationId: subscriber_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - robot + /robots/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: robot_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - robot + /robots/{id}/private: + post: + description: 执行操作Private + operationId: robot_PerformPrivate + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformPrivateOutput' + summary: 执行操作Private + tags: + - robot + /robots/{id}/public: + post: + description: 执行操作Public + operationId: robot_PerformPublic + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformPublicOutput' + summary: 执行操作Public + tags: + - robot + /robots/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: robot_PerformSetClassMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - robot + /robots/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: robot_PerformSetOrgMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - robot + /robots/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: robot_PerformSetUserMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - robot + /robots/{id}/status: + get: + description: 获取指定信息Status + operationId: robot_GetDetailsStatus + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - robot + post: + description: 执行操作Status + operationId: robot_PerformStatus + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformStatusOutput' + summary: 更新资源状态 + tags: + - robot + /robots/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: robot_PerformUnfreeze + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - robot + /robots/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: robot_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/robot_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - robot + /robots/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: robot_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/robot_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - robot + /robots/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: robot_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/robot_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - robot + /robots/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: robot_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/robot_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - robot + /robots/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: robot_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/robot_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - robot + /robots/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: robot_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - robot + /robots/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: robot_GetPropertySplitable + responses: + "200": + $ref: '#/responses/robot_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - robot + /robots/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: robot_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/robot_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - robot + /robots/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: robot_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/robot_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - robot + /robots/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: robot_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/robot_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - robot + /robots/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: robot_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/robot_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - robot + /subscriber_receivers: + get: + description: 列表 + operationId: subscriber_receiver_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 - name: enabled - type: boolean - x-go-name: Enabled - - description: 'description: topic id' - in: query - name: TopicID - type: string - - description: 'description: scope of resource' - enum: - - system - - domain - - project - in: query - name: ResourceScope - type: string - - description: 'description: type' - enum: - - receiver - - robot - - role - in: query - name: Type - type: string - - description: 'description: scope' - enum: - - system - - domain - in: query - name: Scope - type: string - responses: - "200": - $ref: '#/responses/subscriber_ListItemFilterOutput' - summary: 列表 - tags: - - subscriber - post: - description: 新建 - operationId: subscriber_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - subscriber: - $ref: '#/definitions/SubscriberCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_ValidateCreateDataOutput' - summary: 新建 - tags: - - subscriber - /subscribers/{id}: - delete: - description: 删除 - operationId: subscriber_CustomizeDelete - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/subscriber_CustomizeDeleteOutput' - summary: 删除 - tags: - - subscriber - get: - description: 获取详情 - operationId: subscriber_FetchCustomizeColumns - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/subscriber_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - subscriber - put: - description: 更新 - operationId: subscriber_ValidateUpdateData - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - subscriber: - $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_ValidateUpdateDataOutput' - summary: 更新 - tags: - - subscriber - /subscribers/{id}/change: - post: - description: 执行操作Change - operationId: subscriber_PerformChange - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - subscriber: - $ref: '#/definitions/SubscriberChangeInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_PerformChangeOutput' - summary: 执行操作Change - tags: - - subscriber - /subscribers/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: subscriber_GetDetailsClassMetadata - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/subscriber_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - subscriber - post: - description: 执行操作ClassMetadata - operationId: subscriber_PerformClassMetadata - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - subscriber: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - subscriber - /subscribers/{id}/disable: - post: - description: 执行操作Disable - operationId: subscriber_PerformDisable - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/subscriber_PerformDisableOutput' - summary: 执行操作Disable - tags: - - subscriber - /subscribers/{id}/enable: - post: - description: 执行操作Enable - operationId: subscriber_PerformEnable - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/subscriber_PerformEnableOutput' - summary: 执行操作Enable - tags: - - subscriber - /subscribers/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: subscriber_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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/subscriber_receiver_ListItemFilterOutput' + summary: 列表 + tags: + - subscriber_receiver + post: + description: 新建 + operationId: subscriber_receiver_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + subscriber_receiver: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_receiver_ValidateCreateDataOutput' + summary: 新建 + tags: + - subscriber_receiver + /subscriber_receivers/{id}: + delete: + description: 删除 + operationId: subscriber_receiver_CustomizeDelete + parameters: + - description: The Id or Name of subscriber_receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_receiver_CustomizeDeleteOutput' + summary: 删除 + tags: + - subscriber_receiver + get: + description: 获取详情 + operationId: subscriber_receiver_FetchCustomizeColumns + parameters: + - description: The Id or Name of subscriber_receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_receiver_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - subscriber_receiver + put: + description: 更新 + operationId: subscriber_receiver_ValidateUpdateData + parameters: + - description: The Id or Name of subscriber_receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_receiver_ValidateUpdateDataOutput' + summary: 更新 + tags: + - subscriber_receiver + /subscriber_receivers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: subscriber_receiver_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/subscriber_receiver_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - subscriber_receiver + /subscriber_receivers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: subscriber_receiver_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_receiver_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - subscriber_receiver + /subscriber_receivers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: subscriber_receiver_GetPropertySplitable + responses: + "200": + $ref: '#/responses/subscriber_receiver_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - subscriber_receiver + /subscriber_receivers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: subscriber_receiver_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/subscriber_receiver_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - subscriber_receiver + /subscribers: + get: + description: 列表 + operationId: subscriber_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') + 支持的操作符如下： - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | 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 subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/subscriber_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - subscriber - /subscribers/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: subscriber_PerformSetClassMetadata - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - subscriber: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - subscriber - /subscribers/{id}/set-receiver: - post: - description: 执行操作SetReceiver - operationId: subscriber_PerformSetReceiver - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - subscriber: - $ref: '#/definitions/SubscriberSetReceiverInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_PerformSetReceiverOutput' - summary: 执行操作SetReceiver - tags: - - subscriber - /subscribers/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: subscriber_PerformSetUserMetadata - parameters: - - description: The Id or Name of subscriber - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - subscriber: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - subscriber - /subscribers/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: subscriber_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/subscriber_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - subscriber - /subscribers/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: subscriber_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - subscriber: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/subscriber_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - subscriber - /subscribers/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: subscriber_GetPropertySplitable - responses: - "200": - $ref: '#/responses/subscriber_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - subscriber - /subscribers/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: subscriber_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/subscriber_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - subscriber - /subscribers/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: subscriber_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/subscriber_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - subscriber - /subscribers/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: subscriber_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/subscriber_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - subscriber - /templates: - get: - description: 列表 - operationId: template_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 + name: enabled + type: boolean + x-go-name: Enabled + - description: 'description: topic id' + in: query + name: TopicID + type: string + - description: 'description: scope of resource' + enum: + - system + - domain + - project + in: query + name: ResourceScope + type: string + - description: 'description: type' + enum: + - receiver + - robot + - role + in: query + name: Type + type: string + - description: 'description: scope' + enum: + - system + - domain + in: query + name: Scope + type: string + responses: + "200": + $ref: '#/responses/subscriber_ListItemFilterOutput' + summary: 列表 + tags: + - subscriber + post: + description: 新建 + operationId: subscriber_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + subscriber: + $ref: '#/definitions/SubscriberCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_ValidateCreateDataOutput' + summary: 新建 + tags: + - subscriber + /subscribers/{id}: + delete: + description: 删除 + operationId: subscriber_CustomizeDelete + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_CustomizeDeleteOutput' + summary: 删除 + tags: + - subscriber + get: + description: 获取详情 + operationId: subscriber_FetchCustomizeColumns + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - subscriber + put: + description: 更新 + operationId: subscriber_ValidateUpdateData + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_ValidateUpdateDataOutput' + summary: 更新 + tags: + - subscriber + /subscribers/{id}/change: + post: + description: 执行操作Change + operationId: subscriber_PerformChange + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberChangeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformChangeOutput' + summary: 执行操作Change + tags: + - subscriber + /subscribers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: subscriber_GetDetailsClassMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - subscriber + post: + description: 执行操作ClassMetadata + operationId: subscriber_PerformClassMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - subscriber + /subscribers/{id}/disable: + post: + description: 执行操作Disable + operationId: subscriber_PerformDisable + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_PerformDisableOutput' + summary: 执行操作Disable + tags: + - subscriber + /subscribers/{id}/enable: + post: + description: 执行操作Enable + operationId: subscriber_PerformEnable + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_PerformEnableOutput' + summary: 执行操作Enable + tags: + - subscriber + /subscribers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: subscriber_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - 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: |- - description: Contact type, specifically, setting it to all means all contact type - require: true - example: email - in: query - name: contact_type - type: string - x-go-name: ContactType - - description: 'description: Template type' - enum: - - title - - content - - remote - example: title - in: query - name: template_type - type: string - x-go-name: TemplateType - - description: 'description: template topic' - example: IMAGE_ACTIVE - in: query - name: topic - required: true - type: string - x-go-name: Topic - - description: 'description: Language' - enum: - - cn - - en - in: query - name: lang - type: string - x-go-name: Lang - responses: - "200": - $ref: '#/responses/template_ListItemFilterOutput' - summary: 列表 - tags: - - template - post: - description: 新建 - operationId: template_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - template: - $ref: '#/definitions/TemplateCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/template_ValidateCreateDataOutput' - summary: 新建 - tags: - - template - /templates/{id}: - delete: - description: 删除 - operationId: template_CustomizeDelete - parameters: - - description: The Id or Name of template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/template_CustomizeDeleteOutput' - summary: 删除 - tags: - - template - get: - description: 获取详情 - operationId: template_FetchCustomizeColumns - parameters: - - description: The Id or Name of template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/template_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - template - put: - description: 更新 - operationId: template_ValidateUpdateData - parameters: - - description: The Id or Name of template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - template: - $ref: '#/definitions/TemplateUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/template_ValidateUpdateDataOutput' - summary: 更新 - tags: - - template - /templates/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: template_GetDetailsClassMetadata - parameters: - - description: The Id or Name of template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/template_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - template - post: - description: 执行操作ClassMetadata - operationId: template_PerformClassMetadata - parameters: - - description: The Id or Name of template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - template: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/template_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - template - /templates/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: template_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 subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - subscriber + /subscribers/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: subscriber_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - subscriber + /subscribers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: subscriber_PerformSetClassMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - subscriber + /subscribers/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: subscriber_PerformSetOrgMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - subscriber + /subscribers/{id}/set-receiver: + post: + description: 执行操作SetReceiver + operationId: subscriber_PerformSetReceiver + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberSetReceiverInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformSetReceiverOutput' + summary: 执行操作SetReceiver + tags: + - subscriber + /subscribers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: subscriber_PerformSetUserMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - subscriber + /subscribers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: subscriber_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/subscriber_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - subscriber + /subscribers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: subscriber_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + subscriber: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - subscriber + /subscribers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: subscriber_GetPropertySplitable + responses: + "200": + $ref: '#/responses/subscriber_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - subscriber + /subscribers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: subscriber_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/subscriber_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - subscriber + /subscribers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: subscriber_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/subscriber_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - subscriber + /subscribers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: subscriber_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/subscriber_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - subscriber + /templates: + get: + description: 列表 + operationId: template_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') + 支持的操作符如下： - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | 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 template - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/template_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - template - /templates/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: template_PerformSetClassMetadata - parameters: - - description: The Id or Name of template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - template: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/template_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - template - /templates/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: template_PerformSetUserMetadata - parameters: - - description: The Id or Name of template - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - template: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/template_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - template - /templates/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: template_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/template_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - template - /templates/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: template_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - template: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/template_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - template - /templates/save: - post: - description: 执行操作Save - operationId: template_PerformSave - parameters: - - in: body - name: body - schema: - properties: - template: - $ref: '#/definitions/TemplateManagerSaveInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/template_PerformSaveOutput' - summary: 执行操作Save - tags: - - template - /templates/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: template_GetPropertySplitable - responses: - "200": - $ref: '#/responses/template_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - template - /templates/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: template_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/template_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - template - /templates/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: template_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/template_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - template - /templates/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: template_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/template_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - template - /topics: - get: - description: 列表 - operationId: topic_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: |- + description: Contact type, specifically, setting it to all means all contact type + require: true + example: email + in: query + name: contact_type + type: string + x-go-name: ContactType + - description: 'description: Template type' + enum: + - title + - content + - remote + example: title + in: query + name: template_type + type: string + x-go-name: TemplateType + - description: 'description: template topic' + example: IMAGE_ACTIVE + in: query + name: topic + required: true + type: string + x-go-name: Topic + - description: 'description: Language' + enum: + - cn + - en + in: query + name: lang + type: string + x-go-name: Lang + responses: + "200": + $ref: '#/responses/template_ListItemFilterOutput' + summary: 列表 + tags: + - template + post: + description: 新建 + operationId: template_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + template: + $ref: '#/definitions/TemplateCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_ValidateCreateDataOutput' + summary: 新建 + tags: + - template + /templates/{id}: + delete: + description: 删除 + operationId: template_CustomizeDelete + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/template_CustomizeDeleteOutput' + summary: 删除 + tags: + - template + get: + description: 获取详情 + operationId: template_FetchCustomizeColumns + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/template_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - template + put: + description: 更新 + operationId: template_ValidateUpdateData + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + template: + $ref: '#/definitions/TemplateUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_ValidateUpdateDataOutput' + summary: 更新 + tags: + - template + /templates/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: template_GetDetailsClassMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/template_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - template + post: + description: 执行操作ClassMetadata + operationId: template_PerformClassMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - template + /templates/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: template_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - 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: enabled - type: boolean - x-go-name: Enabled - responses: - "200": - $ref: '#/responses/topic_ListItemFilterOutput' - summary: 列表 - tags: - - topic - post: - description: 新建 - operationId: topic_ValidateCreateData - responses: - "200": - $ref: '#/responses/topic_ValidateCreateDataOutput' - summary: 新建 - tags: - - topic - /topics/{id}: - delete: - description: 删除 - operationId: topic_CustomizeDelete - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/topic_CustomizeDeleteOutput' - summary: 删除 - tags: - - topic - get: - description: 获取详情 - operationId: topic_FetchCustomizeColumns - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/topic_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - topic - put: - description: 更新 - operationId: topic_ValidateUpdateData - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/topic_ValidateUpdateDataOutput' - summary: 更新 - tags: - - topic - /topics/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: topic_GetDetailsClassMetadata - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/topic_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - topic - post: - description: 执行操作ClassMetadata - operationId: topic_PerformClassMetadata - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - topic: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/topic_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - topic - /topics/{id}/disable: - post: - description: 执行操作Disable - operationId: topic_PerformDisable - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - topic: - $ref: '#/definitions/PerformDisableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/topic_PerformDisableOutput' - summary: 禁用资源 - tags: - - topic - /topics/{id}/enable: - post: - description: 执行操作Enable - operationId: topic_PerformEnable - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - topic: - $ref: '#/definitions/PerformEnableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/topic_PerformEnableOutput' - summary: 启用资源 - tags: - - topic - /topics/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: topic_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 template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/template_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - template + /templates/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: template_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/template_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - template + /templates/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: template_PerformSetClassMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - template + /templates/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: template_PerformSetOrgMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - template + /templates/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: template_PerformSetUserMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - template + /templates/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: template_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/template_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - template + /templates/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: template_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + template: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - template + /templates/save: + post: + description: 执行操作Save + operationId: template_PerformSave + parameters: + - in: body + name: body + schema: + properties: + template: + $ref: '#/definitions/TemplateManagerSaveInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformSaveOutput' + summary: 执行操作Save + tags: + - template + /templates/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: template_GetPropertySplitable + responses: + "200": + $ref: '#/responses/template_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - template + /templates/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: template_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/template_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - template + /templates/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: template_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/template_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - template + /templates/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: template_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/template_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - template + /topics: + get: + description: 列表 + operationId: topic_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') + 支持的操作符如下： - 类型 | 说明 | - ----------|---------------------------------------------| - 系统标签 | 平台定义的标签 | - 用户标签 | 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 topic - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/topic_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - topic - /topics/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: topic_PerformSetClassMetadata - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - topic: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/topic_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - topic - /topics/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: topic_PerformSetUserMetadata - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - topic: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/topic_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - topic - /topics/{id}/status: - get: - description: 获取指定信息Status - operationId: topic_GetDetailsStatus - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/topic_GetDetailsStatusOutput' - summary: 获取资源状态 - tags: - - topic - post: - description: 执行操作Status - operationId: topic_PerformStatus - parameters: - - description: The Id or Name of topic - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - topic: - $ref: '#/definitions/PerformStatusInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/topic_PerformStatusOutput' - summary: 更新资源状态 - tags: - - topic - /topics/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: topic_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/topic_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - topic - /topics/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: topic_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - topic: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/topic_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - topic - /topics/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: topic_GetPropertySplitable - responses: - "200": - $ref: '#/responses/topic_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - topic - /topics/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: topic_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/topic_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - topic - /topics/statistics: - get: - description: 获取指定资源类的信息Statistics - operationId: topic_GetPropertyStatistics - responses: - "200": - $ref: '#/responses/topic_GetPropertyStatisticsOutput' - summary: 获取指定资源类的信息Statistics - tags: - - topic - /topics/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: topic_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/topic_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - topic - /topics/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: topic_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/topic_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - topic + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/topic_ListItemFilterOutput' + summary: 列表 + tags: + - topic + post: + description: 新建 + operationId: topic_ValidateCreateData + responses: + "200": + $ref: '#/responses/topic_ValidateCreateDataOutput' + summary: 新建 + tags: + - topic + /topics/{id}: + delete: + description: 删除 + operationId: topic_CustomizeDelete + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_CustomizeDeleteOutput' + summary: 删除 + tags: + - topic + get: + description: 获取详情 + operationId: topic_FetchCustomizeColumns + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - topic + put: + description: 更新 + operationId: topic_ValidateUpdateData + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + $ref: '#/definitions/TopicUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_ValidateUpdateDataOutput' + summary: 更新 + tags: + - topic + /topics/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: topic_GetDetailsClassMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - topic + post: + description: 执行操作ClassMetadata + operationId: topic_PerformClassMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - topic + /topics/{id}/disable: + post: + description: 执行操作Disable + operationId: topic_PerformDisable + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformDisableOutput' + summary: 禁用资源 + tags: + - topic + /topics/{id}/enable: + post: + description: 执行操作Enable + operationId: topic_PerformEnable + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformEnableOutput' + summary: 启用资源 + tags: + - topic + /topics/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: topic_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 topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - topic + /topics/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: topic_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - topic + /topics/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: topic_PerformSetClassMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - topic + /topics/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: topic_PerformSetOrgMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - topic + /topics/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: topic_PerformSetUserMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - topic + /topics/{id}/status: + get: + description: 获取指定信息Status + operationId: topic_GetDetailsStatus + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - topic + post: + description: 执行操作Status + operationId: topic_PerformStatus + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformStatusOutput' + summary: 更新资源状态 + tags: + - topic + /topics/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: topic_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/topic_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - topic + /topics/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: topic_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + topic: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - topic + /topics/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: topic_GetPropertySplitable + responses: + "200": + $ref: '#/responses/topic_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - topic + /topics/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: topic_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/topic_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - topic + /topics/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: topic_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/topic_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - topic + /topics/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: topic_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/topic_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - topic + /topics/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: topic_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/topic_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - topic produces: -- application/json + - application/json responses: - config_CustomizeDeleteOutput: - schema: - properties: - config: - $ref: '#/definitions/ConfigDetails' - type: object - config_FetchCustomizeColumnsOutput: - schema: - properties: - config: - $ref: '#/definitions/ConfigDetails' - type: object - config_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - config: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - config_GetDetailsClassMetadataOutput: - schema: - properties: - config: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - config_GetDetailsMetadataOutput: - schema: - properties: - config: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - config_GetPropertyDistinctFieldOutput: {} - config_GetPropertyDomainTagValuePairsOutput: {} - config_GetPropertyDomainTagValueTreeOutput: {} - config_GetPropertySplitableExportOutput: {} - config_GetPropertySplitableOutput: {} - config_GetPropertyTagValuePairsOutput: {} - config_GetPropertyTagValueTreeOutput: {} - config_ListItemFilterOutput: - schema: - properties: - configs: - items: - $ref: '#/definitions/ConfigDetails' - 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 - config_PerformChangeOwnerOutput: {} - config_PerformClassMetadataOutput: {} - config_PerformPurgeSplitableOutput: {} - config_PerformSetClassMetadataOutput: {} - config_PerformSetUserMetadataOutput: {} - config_PerformValidateOutput: - schema: - properties: - config: - $ref: '#/definitions/ConfigValidateOutput' - type: object - config_ValidateCreateDataOutput: - schema: - properties: - config: - $ref: '#/definitions/ConfigDetails' - type: object - config_ValidateUpdateDataOutput: - schema: - properties: - config: - $ref: '#/definitions/ConfigDetails' - type: object - email_queue_CustomizeDeleteOutput: - schema: - properties: - email_queue: - $ref: '#/definitions/EmailQueueDetails' - type: object - email_queue_FetchCustomizeColumnsOutput: - schema: - properties: - email_queue: - $ref: '#/definitions/EmailQueueDetails' - type: object - email_queue_GetPropertyDistinctFieldOutput: {} - email_queue_GetPropertySplitableExportOutput: {} - email_queue_GetPropertySplitableOutput: {} - email_queue_ListItemFilterOutput: - schema: - properties: - email_queues: - items: - $ref: '#/definitions/EmailQueueDetails' - 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 - email_queue_PerformPurgeSplitableOutput: {} - email_queue_PerformSendOutput: {} - email_queue_ValidateCreateDataOutput: - schema: - properties: - email_queue: - $ref: '#/definitions/EmailQueueDetails' - type: object - email_queue_ValidateUpdateDataOutput: - schema: - properties: - email_queue: - $ref: '#/definitions/EmailQueueDetails' - type: object - email_queue_status_CustomizeDeleteOutput: - schema: - properties: - email_queue_status: - $ref: '#/definitions/ModelBaseDetails' - type: object - email_queue_status_FetchCustomizeColumnsOutput: - schema: - properties: - email_queue_status: - $ref: '#/definitions/ModelBaseDetails' - type: object - email_queue_status_GetPropertyDistinctFieldOutput: {} - email_queue_status_GetPropertySplitableExportOutput: {} - email_queue_status_GetPropertySplitableOutput: {} - email_queue_status_ListItemFilterOutput: - schema: - properties: - email_queue_statuses: - items: - $ref: '#/definitions/ModelBaseDetails' - 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 - email_queue_status_PerformPurgeSplitableOutput: {} - email_queue_status_ValidateCreateDataOutput: - schema: - properties: - email_queue_status: - $ref: '#/definitions/ModelBaseDetails' - type: object - email_queue_status_ValidateUpdateDataOutput: - schema: - properties: - email_queue_status: - $ref: '#/definitions/ModelBaseDetails' - type: object - event_CustomizeDeleteOutput: - schema: - properties: - event: - $ref: '#/definitions/ModelBaseDetails' - type: object - event_FetchCustomizeColumnsOutput: - schema: - properties: - event: - $ref: '#/definitions/ModelBaseDetails' - type: object - event_GetPropertyDistinctFieldOutput: {} - event_GetPropertySplitableExportOutput: {} - event_GetPropertySplitableOutput: {} - event_ListItemFilterOutput: - schema: - properties: - events: - items: - $ref: '#/definitions/ModelBaseDetails' - 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 - event_PerformPurgeSplitableOutput: {} - event_ValidateCreateDataOutput: - schema: - properties: - event: - $ref: '#/definitions/ModelBaseDetails' - type: object - event_ValidateUpdateDataOutput: - schema: - properties: - event: - $ref: '#/definitions/ModelBaseDetails' - type: object - notification_CustomizeDeleteOutput: - schema: - properties: - notification: - $ref: '#/definitions/NotificationDetails' - type: object - notification_FetchCustomizeColumnsOutput: - schema: - properties: - notification: - $ref: '#/definitions/NotificationDetails' - type: object - notification_GetDetailsClassMetadataOutput: - schema: - properties: - notification: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - notification_GetDetailsMetadataOutput: - schema: - properties: - notification: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - notification_GetDetailsStatusOutput: - schema: - properties: - notification: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - notification_GetPropertyDistinctFieldOutput: {} - notification_GetPropertySplitableExportOutput: {} - notification_GetPropertySplitableOutput: {} - notification_GetPropertyStatisticsOutput: - schema: - properties: - notification: - $ref: '#/definitions/StatusStatistic' - type: object - notification_GetPropertyTagValuePairsOutput: {} - notification_GetPropertyTagValueTreeOutput: {} - notification_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - notifications: - items: - $ref: '#/definitions/NotificationDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - notification_PerformClassMetadataOutput: {} - notification_PerformEventNotifyOutput: - schema: - properties: - notification: - $ref: '#/definitions/NotificationManagerEventNotifyOutput' - type: object - notification_PerformPurgeSplitableOutput: {} - notification_PerformSetClassMetadataOutput: {} - notification_PerformSetUserMetadataOutput: {} - notification_PerformStatusOutput: {} - notification_ValidateCreateDataOutput: - schema: - properties: - notification: - $ref: '#/definitions/NotificationDetails' - type: object - notification_ValidateUpdateDataOutput: - schema: - properties: - notification: - $ref: '#/definitions/NotificationDetails' - type: object - notification_log_CustomizeDeleteOutput: - schema: - properties: - notification_log: - $ref: '#/definitions/ModelBaseDetails' - type: object - notification_log_FetchCustomizeColumnsOutput: - schema: - properties: - notification_log: - $ref: '#/definitions/ModelBaseDetails' - type: object - notification_log_GetPropertyDistinctFieldOutput: {} - notification_log_GetPropertySplitableExportOutput: {} - notification_log_GetPropertySplitableOutput: {} - notification_log_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - notification_logs: - items: - $ref: '#/definitions/ModelBaseDetails' - type: array - x-go-name: Output - offset: - format: int64 - type: integer - x-go-name: Offset - total: - format: int64 - type: integer - x-go-name: Total - type: object - notification_log_PerformPurgeSplitableOutput: {} - notification_log_ValidateCreateDataOutput: - schema: - properties: - notification_log: - $ref: '#/definitions/ModelBaseDetails' - type: object - notification_log_ValidateUpdateDataOutput: - schema: - properties: - notification_log: - $ref: '#/definitions/ModelBaseDetails' - type: object - receiver_CustomizeDeleteOutput: - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverDetails' - type: object - receiver_FetchCustomizeColumnsOutput: - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverDetails' - type: object - receiver_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - receiver: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - receiver_GetDetailsClassMetadataOutput: - schema: - properties: - receiver: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - receiver_GetDetailsMetadataOutput: - schema: - properties: - receiver: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - receiver_GetDetailsStatusOutput: - schema: - properties: - receiver: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - receiver_GetPropertyDistinctFieldOutput: {} - receiver_GetPropertyDomainTagValuePairsOutput: {} - receiver_GetPropertyDomainTagValueTreeOutput: {} - receiver_GetPropertySplitableExportOutput: {} - receiver_GetPropertySplitableOutput: {} - receiver_GetPropertyTagValuePairsOutput: {} - receiver_GetPropertyTagValueTreeOutput: {} - receiver_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - receivers: - items: - $ref: '#/definitions/ReceiverDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - receiver_PerformChangeOwnerOutput: {} - receiver_PerformClassMetadataOutput: {} - receiver_PerformDisableOutput: {} - receiver_PerformEnableContactTypeOutput: {} - receiver_PerformEnableOutput: {} - receiver_PerformGetSubscriptionOutput: {} - receiver_PerformGetTypesOutput: - schema: - properties: - receiver: - $ref: '#/definitions/ConfigManagerGetTypesOutput' - type: object - receiver_PerformIntellijGetOutput: {} - receiver_PerformPurgeSplitableOutput: {} - receiver_PerformSetClassMetadataOutput: {} - receiver_PerformSetUserMetadataOutput: {} - receiver_PerformStatusOutput: {} - receiver_PerformTriggerVerifyOutput: {} - receiver_PerformVerifyOutput: {} - receiver_ValidateCreateDataOutput: - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverDetails' - type: object - receiver_ValidateUpdateDataOutput: - schema: - properties: - receiver: - $ref: '#/definitions/ReceiverDetails' - type: object - robot_CustomizeDeleteOutput: - schema: - properties: - robot: - $ref: '#/definitions/RobotDetails' - type: object - robot_FetchCustomizeColumnsOutput: - schema: - properties: - robot: - $ref: '#/definitions/RobotDetails' - type: object - robot_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - robot: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - robot_GetDetailsClassMetadataOutput: - schema: - properties: - robot: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - robot_GetDetailsMetadataOutput: - schema: - properties: - robot: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - robot_GetDetailsStatusOutput: - schema: - properties: - robot: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - robot_GetPropertyDistinctFieldOutput: {} - robot_GetPropertyDomainStatisticsOutput: - schema: - properties: - robot: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - robot_GetPropertyProjectStatisticsOutput: - schema: - properties: - robot: - items: - $ref: '#/definitions/ProjectStatistic' - type: array - x-go-name: Output - type: object - robot_GetPropertyProjectTagValuePairsOutput: {} - robot_GetPropertyProjectTagValueTreeOutput: {} - robot_GetPropertySplitableExportOutput: {} - robot_GetPropertySplitableOutput: {} - robot_GetPropertyStatisticsOutput: - schema: - properties: - robot: - $ref: '#/definitions/StatusStatistic' - type: object - robot_GetPropertyTagValuePairsOutput: {} - robot_GetPropertyTagValueTreeOutput: {} - robot_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - robots: - items: - $ref: '#/definitions/RobotDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - robot_PerformCancelDeleteOutput: {} - robot_PerformChangeOwnerOutput: {} - robot_PerformClassMetadataOutput: {} - robot_PerformDisableOutput: {} - robot_PerformEnableOutput: {} - robot_PerformFreezeOutput: {} - robot_PerformPrivateOutput: {} - robot_PerformPublicOutput: {} - robot_PerformPurgeSplitableOutput: {} - robot_PerformSetClassMetadataOutput: {} - robot_PerformSetUserMetadataOutput: {} - robot_PerformStatusOutput: {} - robot_PerformUnfreezeOutput: {} - robot_ValidateCreateDataOutput: - schema: - properties: - robot: - $ref: '#/definitions/RobotDetails' - type: object - robot_ValidateUpdateDataOutput: - schema: - properties: - robot: - $ref: '#/definitions/RobotDetails' - type: object - subscriber_CustomizeDeleteOutput: - schema: - properties: - subscriber: - $ref: '#/definitions/SubscriberDetails' - type: object - subscriber_FetchCustomizeColumnsOutput: - schema: - properties: - subscriber: - $ref: '#/definitions/SubscriberDetails' - type: object - subscriber_GetDetailsClassMetadataOutput: - schema: - properties: - subscriber: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - subscriber_GetDetailsMetadataOutput: - schema: - properties: - subscriber: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - subscriber_GetPropertyDistinctFieldOutput: {} - subscriber_GetPropertySplitableExportOutput: {} - subscriber_GetPropertySplitableOutput: {} - subscriber_GetPropertyTagValuePairsOutput: {} - subscriber_GetPropertyTagValueTreeOutput: {} - subscriber_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - subscribers: - items: - $ref: '#/definitions/SubscriberDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - subscriber_PerformChangeOutput: {} - subscriber_PerformClassMetadataOutput: {} - subscriber_PerformDisableOutput: {} - subscriber_PerformEnableOutput: {} - subscriber_PerformPurgeSplitableOutput: {} - subscriber_PerformSetClassMetadataOutput: {} - subscriber_PerformSetReceiverOutput: {} - subscriber_PerformSetUserMetadataOutput: {} - subscriber_ValidateCreateDataOutput: - schema: - properties: - subscriber: - $ref: '#/definitions/SubscriberDetails' - type: object - subscriber_ValidateUpdateDataOutput: - schema: - properties: - subscriber: - $ref: '#/definitions/SubscriberDetails' - type: object - subscriber_receiver_CustomizeDeleteOutput: - schema: - properties: - subscriber_receiver: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - subscriber_receiver_FetchCustomizeColumnsOutput: - schema: - properties: - subscriber_receiver: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - subscriber_receiver_GetPropertyDistinctFieldOutput: {} - subscriber_receiver_GetPropertySplitableExportOutput: {} - subscriber_receiver_GetPropertySplitableOutput: {} - subscriber_receiver_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - subscriber_receivers: - items: - $ref: '#/definitions/JointResourceBaseDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - subscriber_receiver_PerformPurgeSplitableOutput: {} - subscriber_receiver_ValidateCreateDataOutput: - schema: - properties: - subscriber_receiver: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - subscriber_receiver_ValidateUpdateDataOutput: - schema: - properties: - subscriber_receiver: - $ref: '#/definitions/JointResourceBaseDetails' - type: object - template_CustomizeDeleteOutput: - schema: - properties: - template: - $ref: '#/definitions/StandaloneAnonResourceDetails' - type: object - template_FetchCustomizeColumnsOutput: - schema: - properties: - template: - $ref: '#/definitions/StandaloneAnonResourceDetails' - type: object - template_GetDetailsClassMetadataOutput: - schema: - properties: - template: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - template_GetDetailsMetadataOutput: - schema: - properties: - template: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - template_GetPropertyDistinctFieldOutput: {} - template_GetPropertySplitableExportOutput: {} - template_GetPropertySplitableOutput: {} - template_GetPropertyTagValuePairsOutput: {} - template_GetPropertyTagValueTreeOutput: {} - template_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - templates: - items: - $ref: '#/definitions/StandaloneAnonResourceDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - template_PerformClassMetadataOutput: {} - template_PerformPurgeSplitableOutput: {} - template_PerformSaveOutput: {} - template_PerformSetClassMetadataOutput: {} - template_PerformSetUserMetadataOutput: {} - template_ValidateCreateDataOutput: - schema: - properties: - template: - $ref: '#/definitions/StandaloneAnonResourceDetails' - type: object - template_ValidateUpdateDataOutput: - schema: - properties: - template: - $ref: '#/definitions/StandaloneAnonResourceDetails' - type: object - topic_CustomizeDeleteOutput: - schema: - properties: - topic: - $ref: '#/definitions/TopicDetails' - type: object - topic_FetchCustomizeColumnsOutput: - schema: - properties: - topic: - $ref: '#/definitions/TopicDetails' - type: object - topic_GetDetailsClassMetadataOutput: - schema: - properties: - topic: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - topic_GetDetailsMetadataOutput: - schema: - properties: - topic: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - topic_GetDetailsStatusOutput: - schema: - properties: - topic: - $ref: '#/definitions/GetDetailsStatusOutput' - type: object - topic_GetPropertyDistinctFieldOutput: {} - topic_GetPropertySplitableExportOutput: {} - topic_GetPropertySplitableOutput: {} - topic_GetPropertyStatisticsOutput: - schema: - properties: - topic: - $ref: '#/definitions/StatusStatistic' - type: object - topic_GetPropertyTagValuePairsOutput: {} - topic_GetPropertyTagValueTreeOutput: {} - topic_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - topics: - items: - $ref: '#/definitions/TopicDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - topic_PerformClassMetadataOutput: {} - topic_PerformDisableOutput: {} - topic_PerformEnableOutput: {} - topic_PerformPurgeSplitableOutput: {} - topic_PerformSetClassMetadataOutput: {} - topic_PerformSetUserMetadataOutput: {} - topic_PerformStatusOutput: {} - topic_ValidateCreateDataOutput: - schema: - properties: - topic: - $ref: '#/definitions/TopicDetails' - type: object - topic_ValidateUpdateDataOutput: - schema: - properties: - topic: - $ref: '#/definitions/TopicDetails' - type: object + config_CustomizeDeleteOutput: + description: "" + schema: + properties: + config: + $ref: '#/definitions/ConfigDetails' + type: object + config_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + config: + $ref: '#/definitions/ConfigDetails' + type: object + config_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + config: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + config_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + config_GetDetailsMetadataOutput: + description: "" + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + config_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + config_GetPropertyCapabilityOutput: + description: "" + config_GetPropertyDistinctFieldOutput: + description: "" + config_GetPropertyDomainTagValuePairsOutput: + description: "" + config_GetPropertyDomainTagValueTreeOutput: + description: "" + config_GetPropertySplitableExportOutput: + description: "" + config_GetPropertySplitableOutput: + description: "" + config_GetPropertyTagValuePairsOutput: + description: "" + config_GetPropertyTagValueTreeOutput: + description: "" + config_ListItemFilterOutput: + description: "" + schema: + properties: + configs: + items: + $ref: '#/definitions/ConfigDetails' + 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 + config_PerformChangeOwnerOutput: + description: "" + config_PerformClassMetadataOutput: + description: "" + config_PerformPurgeSplitableOutput: + description: "" + config_PerformSetClassMetadataOutput: + description: "" + config_PerformSetOrgMetadataOutput: + description: "" + config_PerformSetUserMetadataOutput: + description: "" + config_PerformValidateOutput: + description: "" + schema: + properties: + config: + $ref: '#/definitions/ConfigValidateOutput' + type: object + config_ValidateCreateDataOutput: + description: "" + schema: + properties: + config: + $ref: '#/definitions/ConfigDetails' + type: object + config_ValidateUpdateDataOutput: + description: "" + schema: + properties: + config: + $ref: '#/definitions/ConfigDetails' + type: object + email_queue_CustomizeDeleteOutput: + description: "" + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueDetails' + type: object + email_queue_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueDetails' + type: object + email_queue_GetPropertyDistinctFieldOutput: + description: "" + email_queue_GetPropertySplitableExportOutput: + description: "" + email_queue_GetPropertySplitableOutput: + description: "" + email_queue_ListItemFilterOutput: + description: "" + schema: + properties: + email_queues: + items: + $ref: '#/definitions/EmailQueueDetails' + 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 + email_queue_PerformPurgeSplitableOutput: + description: "" + email_queue_PerformSendOutput: + description: "" + email_queue_ValidateCreateDataOutput: + description: "" + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueDetails' + type: object + email_queue_ValidateUpdateDataOutput: + description: "" + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueDetails' + type: object + email_queue_status_CustomizeDeleteOutput: + description: "" + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseDetails' + type: object + email_queue_status_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseDetails' + type: object + email_queue_status_GetPropertyDistinctFieldOutput: + description: "" + email_queue_status_GetPropertySplitableExportOutput: + description: "" + email_queue_status_GetPropertySplitableOutput: + description: "" + email_queue_status_ListItemFilterOutput: + description: "" + schema: + properties: + email_queue_statuses: + items: + $ref: '#/definitions/ModelBaseDetails' + 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 + email_queue_status_PerformPurgeSplitableOutput: + description: "" + email_queue_status_ValidateCreateDataOutput: + description: "" + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseDetails' + type: object + email_queue_status_ValidateUpdateDataOutput: + description: "" + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseDetails' + type: object + event_CustomizeDeleteOutput: + description: "" + schema: + properties: + event: + $ref: '#/definitions/ModelBaseDetails' + type: object + event_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + event: + $ref: '#/definitions/ModelBaseDetails' + type: object + event_GetPropertyDistinctFieldOutput: + description: "" + event_GetPropertySplitableExportOutput: + description: "" + event_GetPropertySplitableOutput: + description: "" + event_ListItemFilterOutput: + description: "" + schema: + properties: + events: + items: + $ref: '#/definitions/ModelBaseDetails' + 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 + event_PerformPurgeSplitableOutput: + description: "" + event_ValidateCreateDataOutput: + description: "" + schema: + properties: + event: + $ref: '#/definitions/ModelBaseDetails' + type: object + event_ValidateUpdateDataOutput: + description: "" + schema: + properties: + event: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_CustomizeDeleteOutput: + description: "" + schema: + properties: + notification: + $ref: '#/definitions/NotificationDetails' + type: object + notification_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + notification: + $ref: '#/definitions/NotificationDetails' + type: object + notification_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + notification_GetDetailsMetadataOutput: + description: "" + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + notification_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + notification_GetDetailsStatusOutput: + description: "" + schema: + properties: + notification: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + notification_GetPropertyDistinctFieldOutput: + description: "" + notification_GetPropertySplitableExportOutput: + description: "" + notification_GetPropertySplitableOutput: + description: "" + notification_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + notification: + $ref: '#/definitions/StatusStatistic' + type: object + notification_GetPropertyTagValuePairsOutput: + description: "" + notification_GetPropertyTagValueTreeOutput: + description: "" + notification_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + notifications: + items: + $ref: '#/definitions/NotificationDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + notification_PerformClassMetadataOutput: + description: "" + notification_PerformContactNotifyOutput: + description: "" + schema: + properties: + notification: + $ref: '#/definitions/NotificationManagerEventNotifyOutput' + type: object + notification_PerformEventNotifyOutput: + description: "" + schema: + properties: + notification: + $ref: '#/definitions/NotificationManagerEventNotifyOutput' + type: object + notification_PerformPurgeSplitableOutput: + description: "" + notification_PerformSetClassMetadataOutput: + description: "" + notification_PerformSetOrgMetadataOutput: + description: "" + notification_PerformSetUserMetadataOutput: + description: "" + notification_PerformStatusOutput: + description: "" + notification_ValidateCreateDataOutput: + description: "" + schema: + properties: + notification: + $ref: '#/definitions/NotificationDetails' + type: object + notification_ValidateUpdateDataOutput: + description: "" + schema: + properties: + notification: + $ref: '#/definitions/NotificationDetails' + type: object + notification_group_CustomizeDeleteOutput: + description: "" + schema: + properties: + notification_group: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_group_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + notification_group: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_group_GetPropertyDistinctFieldOutput: + description: "" + notification_group_GetPropertySplitableExportOutput: + description: "" + notification_group_GetPropertySplitableOutput: + description: "" + notification_group_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + notification_groups: + items: + $ref: '#/definitions/ModelBaseDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + notification_group_PerformPurgeSplitableOutput: + description: "" + notification_group_ValidateCreateDataOutput: + description: "" + schema: + properties: + notification_group: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_group_ValidateUpdateDataOutput: + description: "" + schema: + properties: + notification_group: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_log_CustomizeDeleteOutput: + description: "" + schema: + properties: + notification_log: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_log_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + notification_log: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_log_GetPropertyDistinctFieldOutput: + description: "" + notification_log_GetPropertySplitableExportOutput: + description: "" + notification_log_GetPropertySplitableOutput: + description: "" + notification_log_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + notification_logs: + items: + $ref: '#/definitions/ModelBaseDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + notification_log_PerformPurgeSplitableOutput: + description: "" + notification_log_ValidateCreateDataOutput: + description: "" + schema: + properties: + notification_log: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_log_ValidateUpdateDataOutput: + description: "" + schema: + properties: + notification_log: + $ref: '#/definitions/ModelBaseDetails' + type: object + receiver_CustomizeDeleteOutput: + description: "" + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverDetails' + type: object + receiver_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverDetails' + type: object + receiver_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + receiver: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + receiver_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + receiver_GetDetailsMetadataOutput: + description: "" + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + receiver_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + receiver_GetDetailsStatusOutput: + description: "" + schema: + properties: + receiver: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + receiver_GetPropertyDistinctFieldOutput: + description: "" + receiver_GetPropertyDomainTagValuePairsOutput: + description: "" + receiver_GetPropertyDomainTagValueTreeOutput: + description: "" + receiver_GetPropertyRoleContactTypeOutput: + description: "" + receiver_GetPropertySplitableExportOutput: + description: "" + receiver_GetPropertySplitableOutput: + description: "" + receiver_GetPropertyTagValuePairsOutput: + description: "" + receiver_GetPropertyTagValueTreeOutput: + description: "" + receiver_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + receivers: + items: + $ref: '#/definitions/ReceiverDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + receiver_PerformChangeOwnerOutput: + description: "" + receiver_PerformClassMetadataOutput: + description: "" + receiver_PerformDisableOutput: + description: "" + receiver_PerformEnableContactTypeOutput: + description: "" + receiver_PerformEnableOutput: + description: "" + receiver_PerformGetSubscriptionOutput: + description: "" + receiver_PerformGetTypesOutput: + description: "" + schema: + properties: + receiver: + $ref: '#/definitions/ConfigManagerGetTypesOutput' + type: object + receiver_PerformIntellijGetOutput: + description: "" + receiver_PerformPurgeSplitableOutput: + description: "" + receiver_PerformSetClassMetadataOutput: + description: "" + receiver_PerformSetOrgMetadataOutput: + description: "" + receiver_PerformSetUserMetadataOutput: + description: "" + receiver_PerformStatusOutput: + description: "" + receiver_PerformTriggerVerifyOutput: + description: "" + receiver_PerformVerifyOutput: + description: "" + receiver_ValidateCreateDataOutput: + description: "" + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverDetails' + type: object + receiver_ValidateUpdateDataOutput: + description: "" + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverDetails' + type: object + robot_CustomizeDeleteOutput: + description: "" + schema: + properties: + robot: + $ref: '#/definitions/RobotDetails' + type: object + robot_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + robot: + $ref: '#/definitions/RobotDetails' + type: object + robot_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + robot: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + robot_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + robot_GetDetailsMetadataOutput: + description: "" + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + robot_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + robot_GetDetailsStatusOutput: + description: "" + schema: + properties: + robot: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + robot_GetPropertyDistinctFieldOutput: + description: "" + robot_GetPropertyDomainStatisticsOutput: + description: "" + schema: + properties: + robot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + robot_GetPropertyProjectStatisticsOutput: + description: "" + schema: + properties: + robot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + robot_GetPropertyProjectTagValuePairsOutput: + description: "" + robot_GetPropertyProjectTagValueTreeOutput: + description: "" + robot_GetPropertySplitableExportOutput: + description: "" + robot_GetPropertySplitableOutput: + description: "" + robot_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + robot: + $ref: '#/definitions/StatusStatistic' + type: object + robot_GetPropertyTagValuePairsOutput: + description: "" + robot_GetPropertyTagValueTreeOutput: + description: "" + robot_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + robots: + items: + $ref: '#/definitions/RobotDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + robot_PerformCancelDeleteOutput: + description: "" + robot_PerformChangeOwnerOutput: + description: "" + robot_PerformClassMetadataOutput: + description: "" + robot_PerformDisableOutput: + description: "" + robot_PerformEnableOutput: + description: "" + robot_PerformFreezeOutput: + description: "" + robot_PerformPrivateOutput: + description: "" + robot_PerformPublicOutput: + description: "" + robot_PerformPurgeSplitableOutput: + description: "" + robot_PerformSetClassMetadataOutput: + description: "" + robot_PerformSetOrgMetadataOutput: + description: "" + robot_PerformSetUserMetadataOutput: + description: "" + robot_PerformStatusOutput: + description: "" + robot_PerformUnfreezeOutput: + description: "" + robot_ValidateCreateDataOutput: + description: "" + schema: + properties: + robot: + $ref: '#/definitions/RobotDetails' + type: object + robot_ValidateUpdateDataOutput: + description: "" + schema: + properties: + robot: + $ref: '#/definitions/RobotDetails' + type: object + subscriber_CustomizeDeleteOutput: + description: "" + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberDetails' + type: object + subscriber_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberDetails' + type: object + subscriber_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + subscriber_GetDetailsMetadataOutput: + description: "" + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + subscriber_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + subscriber_GetPropertyDistinctFieldOutput: + description: "" + subscriber_GetPropertySplitableExportOutput: + description: "" + subscriber_GetPropertySplitableOutput: + description: "" + subscriber_GetPropertyTagValuePairsOutput: + description: "" + subscriber_GetPropertyTagValueTreeOutput: + description: "" + subscriber_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + subscribers: + items: + $ref: '#/definitions/SubscriberDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + subscriber_PerformChangeOutput: + description: "" + subscriber_PerformClassMetadataOutput: + description: "" + subscriber_PerformDisableOutput: + description: "" + subscriber_PerformEnableOutput: + description: "" + subscriber_PerformPurgeSplitableOutput: + description: "" + subscriber_PerformSetClassMetadataOutput: + description: "" + subscriber_PerformSetOrgMetadataOutput: + description: "" + subscriber_PerformSetReceiverOutput: + description: "" + subscriber_PerformSetUserMetadataOutput: + description: "" + subscriber_ValidateCreateDataOutput: + description: "" + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberDetails' + type: object + subscriber_ValidateUpdateDataOutput: + description: "" + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberDetails' + type: object + subscriber_receiver_CustomizeDeleteOutput: + description: "" + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + subscriber_receiver_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + subscriber_receiver_GetPropertyDistinctFieldOutput: + description: "" + subscriber_receiver_GetPropertySplitableExportOutput: + description: "" + subscriber_receiver_GetPropertySplitableOutput: + description: "" + subscriber_receiver_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + subscriber_receivers: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + subscriber_receiver_PerformPurgeSplitableOutput: + description: "" + subscriber_receiver_ValidateCreateDataOutput: + description: "" + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + subscriber_receiver_ValidateUpdateDataOutput: + description: "" + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + template_CustomizeDeleteOutput: + description: "" + schema: + properties: + template: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + template_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + template: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + template_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + template_GetDetailsMetadataOutput: + description: "" + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + template_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + template_GetPropertyDistinctFieldOutput: + description: "" + template_GetPropertySplitableExportOutput: + description: "" + template_GetPropertySplitableOutput: + description: "" + template_GetPropertyTagValuePairsOutput: + description: "" + template_GetPropertyTagValueTreeOutput: + description: "" + template_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + templates: + items: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + template_PerformClassMetadataOutput: + description: "" + template_PerformPurgeSplitableOutput: + description: "" + template_PerformSaveOutput: + description: "" + template_PerformSetClassMetadataOutput: + description: "" + template_PerformSetOrgMetadataOutput: + description: "" + template_PerformSetUserMetadataOutput: + description: "" + template_ValidateCreateDataOutput: + description: "" + schema: + properties: + template: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + template_ValidateUpdateDataOutput: + description: "" + schema: + properties: + template: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + topic_CustomizeDeleteOutput: + description: "" + schema: + properties: + topic: + $ref: '#/definitions/TopicDetails' + type: object + topic_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + topic: + $ref: '#/definitions/TopicDetails' + type: object + topic_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + topic_GetDetailsMetadataOutput: + description: "" + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + topic_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + topic_GetDetailsStatusOutput: + description: "" + schema: + properties: + topic: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + topic_GetPropertyDistinctFieldOutput: + description: "" + topic_GetPropertySplitableExportOutput: + description: "" + topic_GetPropertySplitableOutput: + description: "" + topic_GetPropertyStatisticsOutput: + description: "" + schema: + properties: + topic: + $ref: '#/definitions/StatusStatistic' + type: object + topic_GetPropertyTagValuePairsOutput: + description: "" + topic_GetPropertyTagValueTreeOutput: + description: "" + topic_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + topics: + items: + $ref: '#/definitions/TopicDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + topic_PerformClassMetadataOutput: + description: "" + topic_PerformDisableOutput: + description: "" + topic_PerformEnableOutput: + description: "" + topic_PerformPurgeSplitableOutput: + description: "" + topic_PerformSetClassMetadataOutput: + description: "" + topic_PerformSetOrgMetadataOutput: + description: "" + topic_PerformSetUserMetadataOutput: + description: "" + topic_PerformStatusOutput: + description: "" + topic_ValidateCreateDataOutput: + description: "" + schema: + properties: + topic: + $ref: '#/definitions/TopicDetails' + type: object + topic_ValidateUpdateDataOutput: + description: "" + schema: + properties: + topic: + $ref: '#/definitions/TopicDetails' + type: object schemes: -- https -- http + - https + - http securityDefinitions: - keystone: - in: header - name: X-Auth-Token - type: apiKey + keystone: + in: header + name: X-Auth-Token + type: apiKey swagger: "2.0" diff --git a/docs/swagger/swagger_yunionconf.yaml b/docs/swagger/swagger_yunionconf.yaml index 9b4fe209c2..3386cbfa10 100644 --- a/docs/swagger/swagger_yunionconf.yaml +++ b/docs/swagger/swagger_yunionconf.yaml @@ -1,1848 +1,1946 @@ basePath: / consumes: -- application/json + - application/json definitions: - ChangeOwnerCandidateDomainsOutput: - properties: - candidates: - items: - $ref: '#/definitions/SharedDomain' - type: array - x-go-name: Candidates - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - 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 - PerformChangeDomainOwnerInput: - properties: - project_domain_id: - description: 指定项目归属域名称或ID - type: string - x-go-name: ProjectDomainId - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPrivateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PerformPublicDomainInput: - properties: - scope: - description: 共享项目资源的共享范围，可能的值为：project, domain和system - pattern: project|domain|system - type: string - x-go-name: Scope - shared_domain_ids: - description: 如果共享范围为域，则在此列表中指定共享的目标域 - items: - type: string - type: array - x-go-name: SharedDomainIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - PurgeSplitTableInput: - properties: - tables: - items: - type: string - type: array - x-go-name: Tables - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ResourceBaseCreateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - ResourceBaseDetails: - 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 - ResourceBaseUpdateInput: - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis - 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 - ScopedPolicyBindInput: - properties: - scope: - $ref: '#/definitions/TRbacScope' - target_ids: - description: 绑定的目标ID（域或者项目ID) - items: - type: string - type: array - x-go-name: TargetIds - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/yunionconf - ScopedPolicyBindingDetails: - 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 - category: - type: string - x-go-name: Category - 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 - domain_id: - type: string - x-go-name: DomainId - id: - type: string - x-go-name: Id - policy: + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates type: object - x-go-name: Policies - policy_id: - type: string - x-go-name: PolicyId - policy_name: - type: string - x-go-name: PolicyName - priority: - format: int64 - type: integer - x-go-name: Priority - project: - type: string - x-go-name: Project - project_domain: - type: string - x-go-name: ProjectDomain - project_id: - type: string - x-go-name: ProjectId - 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/yunionconf - ScopedPolicyCreateInput: - properties: - __meta__: - additionalProperties: - type: string - description: 标签列表,最多支持20个 - example: - user:rd: op + x-go-package: yunion.io/x/onecloud/pkg/apis + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details type: object - x-go-name: Metadata - category: - description: 策略类别 - type: string - x-go-name: Category - 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 - policies: - description: 策略定义内容 + x-go-package: yunion.io/x/onecloud/pkg/httperrors + PerformChangeDomainOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId type: object - x-go-name: Policies - 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/yunionconf - ScopedPolicyDetails: - 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 - category: - description: 策略类别 - type: string - x-go-name: Category - created_at: - description: 资源创建时间 - format: date-time - type: string - x-go-name: CreatedAt - delete_fail_reason: - $ref: '#/definitions/Error' - deleted: - description: 资源是否被删除 - type: boolean - x-go-name: Deleted - deleted_at: - description: 资源删除时间 - format: date-time - type: string - x-go-name: DeletedAt - description: - description: 资源描述信息 - type: string - x-go-name: Description - domain_id: - description: 域Id - type: string - x-go-name: DomainId - domain_src: - description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' - example: local - type: string - x-go-name: DomainSrc - id: - description: 资源UUID - type: string - x-go-name: Id - is_emulated: - description: |- - 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 - list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 - type: boolean - x-go-name: IsEmulated - is_public: - description: 是否共享 - type: boolean - x-go-name: IsPublic - metadata: - additionalProperties: - type: string - description: 标签 + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: type: object - x-go-name: Metadata - name: - description: 资源名称 - type: string - x-go-name: Name - policies: - description: 策略内容 + 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-name: Policies - project_domain: - description: 资源归属项目的域名称 + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResourceBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResourceBaseDetails: + 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 + ResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + 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 + ScopedPolicyBindInput: + properties: + scope: + $ref: '#/definitions/TRbacScope' + target_ids: + description: 绑定的目标ID（域或者项目ID) + items: + type: string + type: array + x-go-name: TargetIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/yunionconf + ScopedPolicyBindingDetails: + 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 + category: + type: string + x-go-name: Category + 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 + domain_id: + type: string + x-go-name: DomainId + id: + type: string + x-go-name: Id + policy: + type: object + x-go-name: Policies + policy_id: + type: string + x-go-name: PolicyId + policy_name: + type: string + x-go-name: PolicyName + priority: + format: int64 + type: integer + x-go-name: Priority + project: + type: string + x-go-name: Project + project_domain: + type: string + x-go-name: ProjectDomain + project_id: + type: string + x-go-name: ProjectId + 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/yunionconf + ScopedPolicyCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + category: + description: 策略类别 + type: string + x-go-name: Category + 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 + policies: + description: 策略定义内容 + type: object + x-go-name: Policies + 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/yunionconf + ScopedPolicyDetails: + 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 + category: + description: 策略类别 + type: string + x-go-name: Category + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + policies: + description: 策略内容 + type: object + x-go-name: Policies + 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 + ref_count: + format: int64 + type: integer + x-go-name: RefCount + 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/yunionconf + ScopedPolicyUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + policies: + description: 策略定义内容 + type: object + x-go-name: Policies + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/yunionconf + 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 + TRbacScope: 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 - ref_count: - format: int64 - type: integer - x-go-name: RefCount - shared_domains: - description: 共享的域列表 + x-go-package: yunion.io/x/pkg/util/rbacscope + TTagSet: items: - $ref: '#/definitions/SharedDomain' + $ref: '#/definitions/STag' type: array - x-go-name: SharedDomains - shared_projects: - description: 共享的项目列表 + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: items: - $ref: '#/definitions/SharedProject' + $ref: '#/definitions/TTagSet' 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/yunionconf - ScopedPolicyUpdateInput: - properties: - description: - description: 资源描述 - type: string - x-go-name: Description - name: - description: 资源名称 - type: string - x-go-name: Name - policies: - description: 策略定义内容 - type: object - x-go-name: Policies - type: object - x-go-package: yunion.io/x/onecloud/pkg/apis/yunionconf - 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 - 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 + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils host: '"127.0.0.1:8889"' info: - contact: - email: lizexi@yunion.cn - name: Zexi Li - description: Yunionconf API - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html - version: "1.0" + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Yunionconf API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" paths: - /parameters: - get: - description: 列表 - operationId: parameter_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') - 支持的操作符如下： + /parameters: + get: + description: 列表 + operationId: parameter_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 - name: namespace_id - type: string - x-go-name: NamespaceId - - description: 服务名称或ID - in: query - name: service_id - type: string - x-go-name: ServiceId - - description: 用户名称或ID - in: query - name: user_id - type: string - x-go-name: UserId - - description: filter by name - in: query - items: - type: string - name: name - type: array - x-go-name: Name - responses: - "200": - $ref: '#/responses/parameter_ListItemFilterOutput' - summary: 配置参数列表 - tags: - - parameter - post: - description: 新建 - operationId: parameter_ValidateCreateData - responses: - "200": - $ref: '#/responses/parameter_ValidateCreateDataOutput' - summary: 新建 - tags: - - parameter - /parameters/{id}: - delete: - description: 删除 - operationId: parameter_CustomizeDelete - parameters: - - description: The Id or Name of parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/parameter_CustomizeDeleteOutput' - summary: 删除 - tags: - - parameter - get: - description: 获取详情 - operationId: parameter_FetchCustomizeColumns - parameters: - - description: The Id or Name of parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/parameter_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - parameter - put: - description: 更新 - operationId: parameter_ValidateUpdateData - parameters: - - description: The Id or Name of parameter - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/parameter_ValidateUpdateDataOutput' - summary: 更新 - tags: - - parameter - /parameters/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: parameter_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/parameter_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - parameter - /parameters/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: parameter_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - parameter: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/parameter_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - parameter - /parameters/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: parameter_GetPropertySplitable - responses: - "200": - $ref: '#/responses/parameter_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - parameter - /parameters/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: parameter_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/parameter_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - parameter - /scopedpolicies: - get: - description: 列表 - operationId: scopedpolicy_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 + name: namespace_id + type: string + x-go-name: NamespaceId + - description: 服务名称或ID + in: query + name: service_id + type: string + x-go-name: ServiceId + - description: 用户名称或ID + in: query + name: user_id + type: string + x-go-name: UserId + - description: filter by name + in: query + items: + type: string + name: name + type: array + x-go-name: Name + responses: + "200": + $ref: '#/responses/parameter_ListItemFilterOutput' + summary: 配置参数列表 + tags: + - parameter + post: + description: 新建 + operationId: parameter_ValidateCreateData + responses: + "200": + $ref: '#/responses/parameter_ValidateCreateDataOutput' + summary: 新建 + tags: + - parameter + /parameters/{id}: + delete: + description: 删除 + operationId: parameter_CustomizeDelete + parameters: + - description: The Id or Name of parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/parameter_CustomizeDeleteOutput' + summary: 删除 + tags: + - parameter + get: + description: 获取详情 + operationId: parameter_FetchCustomizeColumns + parameters: + - description: The Id or Name of parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/parameter_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - parameter + put: + description: 更新 + operationId: parameter_ValidateUpdateData + parameters: + - description: The Id or Name of parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/parameter_ValidateUpdateDataOutput' + summary: 更新 + tags: + - parameter + /parameters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: parameter_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/parameter_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - parameter + /parameters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: parameter_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + parameter: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/parameter_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - parameter + /parameters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: parameter_GetPropertySplitable + responses: + "200": + $ref: '#/responses/parameter_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - parameter + /parameters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: parameter_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/parameter_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - parameter + /scopedpolicies: + get: + description: 列表 + operationId: scopedpolicy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： - 操作符 | 参数个数 | 举例 | 说明 | - ---------------|----------|------------------------------------------------|-----------------------------| - in | > 0 | name.in("test", "good") | 在给定数组中 | - notin | > 0 | name.notin('test') | 不在给定数组中 | - between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | - ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | - gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | - le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | - lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | - like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | - contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | - startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | - endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | - equals | > 0 | name.equals('test') | 等于任意一个给定值 | - notequals | 1 | name.notequals('test') | 不等于给定值 | - isnull | 0 | name.isnull() | 值为SQL的NULL | - isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | - isempty | 0 | name.isempty('test') | 值为空字符串 | - isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | - isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | - in: query - items: - type: string - name: filter - type: array - x-go-name: Filter - - description: |- - 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， - 和其他表关联的语法如下： - joint_resources.related_key(origin_key).filter_col.filter_ops(values) - 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 - 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 - 举例： - guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') - in: query - items: - type: string - name: joint_filter - type: array - x-go-name: JointFilter - - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 - in: query - name: filter_any - type: boolean - x-go-name: FilterAny - - description: 返回结果只包含指定的字段 - in: query - items: - type: string - name: field - type: array - x-go-name: Field - - description: 用于数据导出，指定导出的数据字段 - in: query - name: export_keys - type: string - x-go-name: ExportKeys - - description: 返回结果携带delete_fail_reason和update_fail_reason字段 - in: query - name: show_fail_reason - type: boolean - x-go-name: ShowFailReason - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（包含这些标签） - in: query - name: tags - x-go-name: Tags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还包含这些标签，OR的关系） - in: query - name: obj_tags - x-go-name: ObjTags - - $ref: '#/definitions/TTagSet' - description: 通过标签过滤（不包含这些标签） - in: query - name: no_tags - x-go-name: NoTags - - $ref: '#/definitions/TTagSetList' - description: 通过一组标签过滤（还不包含这些标签，AND的关系） - in: query - name: no_obj_tags - x-go-name: NoObjTags - - description: 通过标签排序 - in: query - name: order_by_tag - type: string - x-go-name: OrderByTag - - description: |- - deprecated - 返回资源的标签不包含用户标签 - in: query - name: without_user_meta - type: boolean - x-go-name: WithoutUserMeta - - description: 返回包含用户标签的资源 - in: query - name: with_user_meta - type: boolean - x-go-name: WithUserMeta - - description: 返回包含外部标签的资源 - in: query - name: with_cloud_meta - type: boolean - x-go-name: WithCloudMeta - - description: 返回包含任意标签的资源 - in: query - name: with_any_meta - type: boolean - x-go-name: WithAnyMeta - - description: 返回列表数据中包含资源的标签数据（Metadata） - in: query - name: with_meta - type: boolean - x-go-name: WithMeta - - description: 显示所有的资源，包括模拟的资源 - in: query - name: show_emulated - type: boolean - x-go-name: ShowEmulated - - description: 以资源ID过滤列表 - in: query - items: - type: string - name: id - type: array - x-go-name: Ids - - description: 以资源名称过滤列表 - in: query - items: - type: string - name: name - type: array - x-go-name: Names - - description: 指定查询的权限范围，可能值为project, domain or system - in: query - name: scope - type: string - x-go-name: Scope - - description: 指定项目归属域名称或ID - in: query - name: project_domain_id - type: string - x-go-name: ProjectDomainId - - description: 对具有域属性的资源，严格匹配域ID - in: query - items: - type: string - name: project_domain_ids - type: array - x-go-name: ProjectDomainIds - - description: 按domain名称排序，可能值为asc|desc - in: query - name: order_by_domain - pattern: asc|desc - type: string - x-go-name: OrderByDomain - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: domain_tags - x-go-name: DomainTags - - $ref: '#/definitions/TTagSetList' - description: filter by domain tags - in: query - name: no_domain_tags - x-go-name: NoDomainTags - - description: 以资源是否共享过滤列表 - in: query - name: is_public - type: boolean - x-go-name: IsPublic - - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project - in: query - name: public_scope - type: string - x-go-name: PublicScope - - description: 策略类别 - in: query - items: - type: string - name: category - type: array - x-go-name: Category - responses: - "200": - $ref: '#/responses/scopedpolicy_ListItemFilterOutput' - summary: 范围策略列表 - tags: - - scopedpolicy - post: - description: 新建 - operationId: scopedpolicy_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - scopedpolicy: - $ref: '#/definitions/ScopedPolicyCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_ValidateCreateDataOutput' - summary: 新建 - tags: - - scopedpolicy - /scopedpolicies/{id}: - delete: - description: 删除 - operationId: scopedpolicy_CustomizeDelete - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scopedpolicy_CustomizeDeleteOutput' - summary: 删除 - tags: - - scopedpolicy - get: - description: 获取详情 - operationId: scopedpolicy_FetchCustomizeColumns - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scopedpolicy_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - scopedpolicy - put: - description: 更新 - operationId: scopedpolicy_ValidateUpdateData - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scopedpolicy: - $ref: '#/definitions/ScopedPolicyUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_ValidateUpdateDataOutput' - summary: 更新 - tags: - - scopedpolicy - /scopedpolicies/{id}/bind: - post: - description: 执行操作Bind - operationId: scopedpolicy_PerformBind - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scopedpolicy: - $ref: '#/definitions/ScopedPolicyBindInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_PerformBindOutput' - summary: 执行操作Bind - tags: - - scopedpolicy - /scopedpolicies/{id}/change-owner: - post: - description: 执行操作ChangeOwner - operationId: scopedpolicy_PerformChangeOwner - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scopedpolicy: - $ref: '#/definitions/PerformChangeDomainOwnerInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_PerformChangeOwnerOutput' - summary: 执行操作ChangeOwner - tags: - - scopedpolicy - /scopedpolicies/{id}/change-owner-candidate-domains: - get: - description: 获取指定信息ChangeOwnerCandidateDomains - operationId: scopedpolicy_GetDetailsChangeOwnerCandidateDomains - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scopedpolicy_GetDetailsChangeOwnerCandidateDomainsOutput' - summary: 获取指定信息ChangeOwnerCandidateDomains - tags: - - scopedpolicy - /scopedpolicies/{id}/class-metadata: - get: - description: 获取指定信息ClassMetadata - operationId: scopedpolicy_GetDetailsClassMetadata - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scopedpolicy_GetDetailsClassMetadataOutput' - summary: 获取指定信息ClassMetadata - tags: - - scopedpolicy - post: - description: 执行操作ClassMetadata - operationId: scopedpolicy_PerformClassMetadata - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scopedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_PerformClassMetadataOutput' - summary: 更新资源的 class 标签 - tags: - - scopedpolicy - /scopedpolicies/{id}/metadata: - get: - description: 获取指定信息Metadata - operationId: scopedpolicy_GetDetailsMetadata - parameters: - - description: |- - 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 - 标签分为 + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 策略类别 + in: query + items: + type: string + name: category + type: array + x-go-name: Category + responses: + "200": + $ref: '#/responses/scopedpolicy_ListItemFilterOutput' + summary: 范围策略列表 + tags: + - scopedpolicy + post: + description: 新建 + operationId: scopedpolicy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scopedpolicy: + $ref: '#/definitions/ScopedPolicyCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_ValidateCreateDataOutput' + summary: 新建 + tags: + - scopedpolicy + /scopedpolicies/{id}: + delete: + description: 删除 + operationId: scopedpolicy_CustomizeDelete + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_CustomizeDeleteOutput' + summary: 删除 + tags: + - scopedpolicy + get: + description: 获取详情 + operationId: scopedpolicy_FetchCustomizeColumns + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scopedpolicy + put: + description: 更新 + operationId: scopedpolicy_ValidateUpdateData + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scopedpolicy + /scopedpolicies/{id}/bind: + post: + description: 执行操作Bind + operationId: scopedpolicy_PerformBind + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyBindInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformBindOutput' + summary: 执行操作Bind + tags: + - scopedpolicy + /scopedpolicies/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: scopedpolicy_PerformChangeOwner + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - scopedpolicy + /scopedpolicies/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: scopedpolicy_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - scopedpolicy + /scopedpolicies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scopedpolicy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scopedpolicy + post: + description: 执行操作ClassMetadata + operationId: scopedpolicy_PerformClassMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scopedpolicy + /scopedpolicies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scopedpolicy_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 scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scopedpolicy_GetDetailsMetadataOutput' - summary: 获取资源标签（元数据） - tags: - - scopedpolicy - /scopedpolicies/{id}/private: - post: - description: 执行操作Private - operationId: scopedpolicy_PerformPrivate - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scopedpolicy: - $ref: '#/definitions/PerformPrivateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_PerformPrivateOutput' - summary: 执行操作Private - tags: - - scopedpolicy - /scopedpolicies/{id}/public: - post: - description: 执行操作Public - operationId: scopedpolicy_PerformPublic - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scopedpolicy: - $ref: '#/definitions/PerformPublicDomainInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_PerformPublicOutput' - summary: 执行操作Public - tags: - - scopedpolicy - /scopedpolicies/{id}/set-class-metadata: - post: - description: 执行操作SetClassMetadata - operationId: scopedpolicy_PerformSetClassMetadata - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scopedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_PerformSetClassMetadataOutput' - summary: 全量替换资源的所有 class 标签 - tags: - - scopedpolicy - /scopedpolicies/{id}/set-user-metadata: - post: - description: 执行操作SetUserMetadata - operationId: scopedpolicy_PerformSetUserMetadata - parameters: - - description: The Id or Name of scopedpolicy - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scopedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Input - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_PerformSetUserMetadataOutput' - summary: 全量替换资源的所有用户标签 - tags: - - scopedpolicy - /scopedpolicies/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: scopedpolicy_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/scopedpolicy_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - scopedpolicy - /scopedpolicies/domain-tag-value-pairs: - get: - description: 获取指定资源类的信息DomainTagValuePairs - operationId: scopedpolicy_GetPropertyDomainTagValuePairs - responses: - "200": - $ref: '#/responses/scopedpolicy_GetPropertyDomainTagValuePairsOutput' - summary: 获取指定资源类的信息DomainTagValuePairs - tags: - - scopedpolicy - /scopedpolicies/domain-tag-value-tree: - get: - description: 获取指定资源类的信息DomainTagValueTree - operationId: scopedpolicy_GetPropertyDomainTagValueTree - responses: - "200": - $ref: '#/responses/scopedpolicy_GetPropertyDomainTagValueTreeOutput' - summary: 获取指定资源类的信息DomainTagValueTree - tags: - - scopedpolicy - /scopedpolicies/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: scopedpolicy_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - scopedpolicy: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicy_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - scopedpolicy - /scopedpolicies/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: scopedpolicy_GetPropertySplitable - responses: - "200": - $ref: '#/responses/scopedpolicy_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - scopedpolicy - /scopedpolicies/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: scopedpolicy_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/scopedpolicy_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - scopedpolicy - /scopedpolicies/tag-value-pairs: - get: - description: 获取指定资源类的信息TagValuePairs - operationId: scopedpolicy_GetPropertyTagValuePairs - responses: - "200": - $ref: '#/responses/scopedpolicy_GetPropertyTagValuePairsOutput' - summary: 获取指定资源类的信息TagValuePairs - tags: - - scopedpolicy - /scopedpolicies/tag-value-tree: - get: - description: 获取指定资源类的信息TagValueTree - operationId: scopedpolicy_GetPropertyTagValueTree - responses: - "200": - $ref: '#/responses/scopedpolicy_GetPropertyTagValueTreeOutput' - summary: 获取指定资源类的信息TagValueTree - tags: - - scopedpolicy - /scopedpolicybindings: - get: - description: 列表 - operationId: scopedpolicybinding_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') - 支持的操作符如下： + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | 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 scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scopedpolicy + /scopedpolicies/{id}/org-metadata: + get: + description: 获取指定信息OrgMetadata + operationId: scopedpolicy_GetDetailsOrgMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_GetDetailsOrgMetadataOutput' + summary: 获取指定信息OrgMetadata + tags: + - scopedpolicy + /scopedpolicies/{id}/private: + post: + description: 执行操作Private + operationId: scopedpolicy_PerformPrivate + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformPrivateOutput' + summary: 执行操作Private + tags: + - scopedpolicy + /scopedpolicies/{id}/public: + post: + description: 执行操作Public + operationId: scopedpolicy_PerformPublic + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformPublicOutput' + summary: 执行操作Public + tags: + - scopedpolicy + /scopedpolicies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scopedpolicy_PerformSetClassMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scopedpolicy + /scopedpolicies/{id}/set-org-metadata: + post: + description: 执行操作SetOrgMetadata + operationId: scopedpolicy_PerformSetOrgMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformSetOrgMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scopedpolicy + /scopedpolicies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scopedpolicy_PerformSetUserMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scopedpolicy + /scopedpolicies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scopedpolicy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scopedpolicy + /scopedpolicies/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: scopedpolicy_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - scopedpolicy + /scopedpolicies/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: scopedpolicy_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - scopedpolicy + /scopedpolicies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scopedpolicy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scopedpolicy + /scopedpolicies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scopedpolicy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scopedpolicy + /scopedpolicies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scopedpolicy_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/scopedpolicy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scopedpolicy + /scopedpolicies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scopedpolicy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scopedpolicy + /scopedpolicies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scopedpolicy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scopedpolicy + /scopedpolicybindings: + get: + description: 列表 + operationId: scopedpolicybinding_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: name - type: array - x-go-name: Name - - in: query - name: policy_id - type: string - x-go-name: PolicyId - - in: query - name: domain_id - type: string - x-go-name: DomainId - - in: query - name: project_id - type: string - x-go-name: ProjectId - - in: query - items: - type: string - name: category - type: array - x-go-name: Category - - in: query - name: effective - type: boolean - x-go-name: Effective - - in: query - name: scope - type: string - x-go-name: Scope - - in: query - name: order_by_scopedpolicy - type: string - x-go-name: OrderByScopedpolicy - responses: - "200": - $ref: '#/responses/scopedpolicybinding_ListItemFilterOutput' - summary: 范围策略列表 - tags: - - scopedpolicybinding - post: - description: 新建 - operationId: scopedpolicybinding_ValidateCreateData - parameters: - - in: body - name: body - schema: - properties: - count: - default: 1 - format: int64 - type: integer - x-go-name: Count - scopedpolicybinding: - $ref: '#/definitions/ResourceBaseCreateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicybinding_ValidateCreateDataOutput' - summary: 新建 - tags: - - scopedpolicybinding - /scopedpolicybindings/{id}: - delete: - description: 删除 - operationId: scopedpolicybinding_CustomizeDelete - parameters: - - description: The Id or Name of scopedpolicybinding - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scopedpolicybinding_CustomizeDeleteOutput' - summary: 删除 - tags: - - scopedpolicybinding - get: - description: 获取详情 - operationId: scopedpolicybinding_FetchCustomizeColumns - parameters: - - description: The Id or Name of scopedpolicybinding - in: path - name: id - required: true - type: string - x-go-name: Id - responses: - "200": - $ref: '#/responses/scopedpolicybinding_FetchCustomizeColumnsOutput' - summary: 获取详情 - tags: - - scopedpolicybinding - put: - description: 更新 - operationId: scopedpolicybinding_ValidateUpdateData - parameters: - - description: The Id or Name of scopedpolicybinding - in: path - name: id - required: true - type: string - x-go-name: Id - - in: body - name: body - schema: - properties: - scopedpolicybinding: - $ref: '#/definitions/ResourceBaseUpdateInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicybinding_ValidateUpdateDataOutput' - summary: 更新 - tags: - - scopedpolicybinding - /scopedpolicybindings/distinct-field: - get: - description: 获取指定资源类的信息DistinctField - operationId: scopedpolicybinding_GetPropertyDistinctField - responses: - "200": - $ref: '#/responses/scopedpolicybinding_GetPropertyDistinctFieldOutput' - summary: 获取指定资源类的信息DistinctField - tags: - - scopedpolicybinding - /scopedpolicybindings/purge-splitable: - post: - description: 执行操作PurgeSplitable - operationId: scopedpolicybinding_PerformPurgeSplitable - parameters: - - in: body - name: body - schema: - properties: - scopedpolicybinding: - $ref: '#/definitions/PurgeSplitTableInput' - type: object - x-go-name: Body - responses: - "200": - $ref: '#/responses/scopedpolicybinding_PerformPurgeSplitableOutput' - summary: 执行操作PurgeSplitable - tags: - - scopedpolicybinding - /scopedpolicybindings/splitable: - get: - description: 获取指定资源类的信息Splitable - operationId: scopedpolicybinding_GetPropertySplitable - responses: - "200": - $ref: '#/responses/scopedpolicybinding_GetPropertySplitableOutput' - summary: 获取指定资源类的信息Splitable - tags: - - scopedpolicybinding - /scopedpolicybindings/splitable-export: - get: - description: 获取指定资源类的信息SplitableExport - operationId: scopedpolicybinding_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/scopedpolicybinding_GetPropertySplitableExportOutput' - summary: 获取指定资源类的信息SplitableExport - tags: - - scopedpolicybinding + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + 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: name + type: array + x-go-name: Name + - in: query + name: policy_id + type: string + x-go-name: PolicyId + - in: query + name: domain_id + type: string + x-go-name: DomainId + - in: query + name: project_id + type: string + x-go-name: ProjectId + - in: query + items: + type: string + name: category + type: array + x-go-name: Category + - in: query + name: effective + type: boolean + x-go-name: Effective + - in: query + name: scope + type: string + x-go-name: Scope + - in: query + name: order_by_scopedpolicy + type: string + x-go-name: OrderByScopedpolicy + responses: + "200": + $ref: '#/responses/scopedpolicybinding_ListItemFilterOutput' + summary: 范围策略列表 + tags: + - scopedpolicybinding + post: + description: 新建 + operationId: scopedpolicybinding_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scopedpolicybinding: + $ref: '#/definitions/ResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicybinding_ValidateCreateDataOutput' + summary: 新建 + tags: + - scopedpolicybinding + /scopedpolicybindings/{id}: + delete: + description: 删除 + operationId: scopedpolicybinding_CustomizeDelete + parameters: + - description: The Id or Name of scopedpolicybinding + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicybinding_CustomizeDeleteOutput' + summary: 删除 + tags: + - scopedpolicybinding + get: + description: 获取详情 + operationId: scopedpolicybinding_FetchCustomizeColumns + parameters: + - description: The Id or Name of scopedpolicybinding + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicybinding_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scopedpolicybinding + put: + description: 更新 + operationId: scopedpolicybinding_ValidateUpdateData + parameters: + - description: The Id or Name of scopedpolicybinding + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicybinding_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scopedpolicybinding + /scopedpolicybindings/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scopedpolicybinding_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scopedpolicybinding_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scopedpolicybinding + /scopedpolicybindings/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scopedpolicybinding_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicybinding_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scopedpolicybinding + /scopedpolicybindings/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scopedpolicybinding_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scopedpolicybinding_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scopedpolicybinding + /scopedpolicybindings/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scopedpolicybinding_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/scopedpolicybinding_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scopedpolicybinding produces: -- application/json + - application/json responses: - parameter_CustomizeDeleteOutput: - schema: - properties: - parameter: - $ref: '#/definitions/ResourceBaseDetails' - type: object - parameter_FetchCustomizeColumnsOutput: - schema: - properties: - parameter: - $ref: '#/definitions/ResourceBaseDetails' - type: object - parameter_GetPropertyDistinctFieldOutput: {} - parameter_GetPropertySplitableExportOutput: {} - parameter_GetPropertySplitableOutput: {} - parameter_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - parameters: - items: - $ref: '#/definitions/ResourceBaseDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - parameter_PerformPurgeSplitableOutput: {} - parameter_ValidateCreateDataOutput: - schema: - properties: - parameter: - $ref: '#/definitions/ResourceBaseDetails' - type: object - parameter_ValidateUpdateDataOutput: - schema: - properties: - parameter: - $ref: '#/definitions/ResourceBaseDetails' - type: object - scopedpolicy_CustomizeDeleteOutput: - schema: - properties: - scopedpolicy: - $ref: '#/definitions/ScopedPolicyDetails' - type: object - scopedpolicy_FetchCustomizeColumnsOutput: - schema: - properties: - scopedpolicy: - $ref: '#/definitions/ScopedPolicyDetails' - type: object - scopedpolicy_GetDetailsChangeOwnerCandidateDomainsOutput: - schema: - properties: - scopedpolicy: - $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' - type: object - scopedpolicy_GetDetailsClassMetadataOutput: - schema: - properties: - scopedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scopedpolicy_GetDetailsMetadataOutput: - schema: - properties: - scopedpolicy: - additionalProperties: - type: string - type: object - x-go-name: Output - type: object - scopedpolicy_GetPropertyDistinctFieldOutput: {} - scopedpolicy_GetPropertyDomainTagValuePairsOutput: {} - scopedpolicy_GetPropertyDomainTagValueTreeOutput: {} - scopedpolicy_GetPropertySplitableExportOutput: {} - scopedpolicy_GetPropertySplitableOutput: {} - scopedpolicy_GetPropertyTagValuePairsOutput: {} - scopedpolicy_GetPropertyTagValueTreeOutput: {} - scopedpolicy_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - scopedpolicies: - items: - $ref: '#/definitions/ScopedPolicyDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - scopedpolicy_PerformBindOutput: {} - scopedpolicy_PerformChangeOwnerOutput: {} - scopedpolicy_PerformClassMetadataOutput: {} - scopedpolicy_PerformPrivateOutput: {} - scopedpolicy_PerformPublicOutput: {} - scopedpolicy_PerformPurgeSplitableOutput: {} - scopedpolicy_PerformSetClassMetadataOutput: {} - scopedpolicy_PerformSetUserMetadataOutput: {} - scopedpolicy_ValidateCreateDataOutput: - schema: - properties: - scopedpolicy: - $ref: '#/definitions/ScopedPolicyDetails' - type: object - scopedpolicy_ValidateUpdateDataOutput: - schema: - properties: - scopedpolicy: - $ref: '#/definitions/ScopedPolicyDetails' - type: object - scopedpolicybinding_CustomizeDeleteOutput: - schema: - properties: - scopedpolicybinding: - $ref: '#/definitions/ScopedPolicyBindingDetails' - type: object - scopedpolicybinding_FetchCustomizeColumnsOutput: - schema: - properties: - scopedpolicybinding: - $ref: '#/definitions/ScopedPolicyBindingDetails' - type: object - scopedpolicybinding_GetPropertyDistinctFieldOutput: {} - scopedpolicybinding_GetPropertySplitableExportOutput: {} - scopedpolicybinding_GetPropertySplitableOutput: {} - scopedpolicybinding_ListItemFilterOutput: - schema: - properties: - limit: - format: int64 - type: integer - x-go-name: Limit - offset: - format: int64 - type: integer - x-go-name: Offset - scopedpolicybindings: - items: - $ref: '#/definitions/ScopedPolicyBindingDetails' - type: array - x-go-name: Output - total: - format: int64 - type: integer - x-go-name: Total - type: object - scopedpolicybinding_PerformPurgeSplitableOutput: {} - scopedpolicybinding_ValidateCreateDataOutput: - schema: - properties: - scopedpolicybinding: - $ref: '#/definitions/ScopedPolicyBindingDetails' - type: object - scopedpolicybinding_ValidateUpdateDataOutput: - schema: - properties: - scopedpolicybinding: - $ref: '#/definitions/ScopedPolicyBindingDetails' - type: object + parameter_CustomizeDeleteOutput: + description: "" + schema: + properties: + parameter: + $ref: '#/definitions/ResourceBaseDetails' + type: object + parameter_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + parameter: + $ref: '#/definitions/ResourceBaseDetails' + type: object + parameter_GetPropertyDistinctFieldOutput: + description: "" + parameter_GetPropertySplitableExportOutput: + description: "" + parameter_GetPropertySplitableOutput: + description: "" + parameter_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + parameters: + items: + $ref: '#/definitions/ResourceBaseDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + parameter_PerformPurgeSplitableOutput: + description: "" + parameter_ValidateCreateDataOutput: + description: "" + schema: + properties: + parameter: + $ref: '#/definitions/ResourceBaseDetails' + type: object + parameter_ValidateUpdateDataOutput: + description: "" + schema: + properties: + parameter: + $ref: '#/definitions/ResourceBaseDetails' + type: object + scopedpolicy_CustomizeDeleteOutput: + description: "" + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyDetails' + type: object + scopedpolicy_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyDetails' + type: object + scopedpolicy_GetDetailsChangeOwnerCandidateDomainsOutput: + description: "" + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + scopedpolicy_GetDetailsClassMetadataOutput: + description: "" + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scopedpolicy_GetDetailsMetadataOutput: + description: "" + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scopedpolicy_GetDetailsOrgMetadataOutput: + description: "" + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scopedpolicy_GetPropertyDistinctFieldOutput: + description: "" + scopedpolicy_GetPropertyDomainTagValuePairsOutput: + description: "" + scopedpolicy_GetPropertyDomainTagValueTreeOutput: + description: "" + scopedpolicy_GetPropertySplitableExportOutput: + description: "" + scopedpolicy_GetPropertySplitableOutput: + description: "" + scopedpolicy_GetPropertyTagValuePairsOutput: + description: "" + scopedpolicy_GetPropertyTagValueTreeOutput: + description: "" + scopedpolicy_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scopedpolicies: + items: + $ref: '#/definitions/ScopedPolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scopedpolicy_PerformBindOutput: + description: "" + scopedpolicy_PerformChangeOwnerOutput: + description: "" + scopedpolicy_PerformClassMetadataOutput: + description: "" + scopedpolicy_PerformPrivateOutput: + description: "" + scopedpolicy_PerformPublicOutput: + description: "" + scopedpolicy_PerformPurgeSplitableOutput: + description: "" + scopedpolicy_PerformSetClassMetadataOutput: + description: "" + scopedpolicy_PerformSetOrgMetadataOutput: + description: "" + scopedpolicy_PerformSetUserMetadataOutput: + description: "" + scopedpolicy_ValidateCreateDataOutput: + description: "" + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyDetails' + type: object + scopedpolicy_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyDetails' + type: object + scopedpolicybinding_CustomizeDeleteOutput: + description: "" + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: object + scopedpolicybinding_FetchCustomizeColumnsOutput: + description: "" + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: object + scopedpolicybinding_GetPropertyDistinctFieldOutput: + description: "" + scopedpolicybinding_GetPropertySplitableExportOutput: + description: "" + scopedpolicybinding_GetPropertySplitableOutput: + description: "" + scopedpolicybinding_ListItemFilterOutput: + description: "" + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scopedpolicybindings: + items: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scopedpolicybinding_PerformPurgeSplitableOutput: + description: "" + scopedpolicybinding_ValidateCreateDataOutput: + description: "" + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: object + scopedpolicybinding_ValidateUpdateDataOutput: + description: "" + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: object schemes: -- https -- http + - https + - http securityDefinitions: - keystone: - in: header - name: X-Auth-Token - type: apiKey + keystone: + in: header + name: X-Auth-Token + type: apiKey swagger: "2.0" diff --git a/pkg/apis/cloudid/zz_generated.model.go b/pkg/apis/cloudid/zz_generated.model.go index e63aa8aaca..e871995450 100644 --- a/pkg/apis/cloudid/zz_generated.model.go +++ b/pkg/apis/cloudid/zz_generated.model.go @@ -52,30 +52,11 @@ type SCloudgroup struct { SCloudproviderResourceBase } -// SCloudgroupJointsBase is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudid/models.SCloudgroupJointsBase. -type SCloudgroupJointsBase struct { - apis.SJointResourceBase - // 用户组Id - CloudgroupId string `json:"cloudgroup_id"` -} - -// SCloudgroupPolicy is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudid/models.SCloudgroupPolicy. -type SCloudgroupPolicy struct { - SCloudgroupJointsBase - SCloudpolicyResourceBase -} - // SCloudgroupResourceBase is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudid/models.SCloudgroupResourceBase. type SCloudgroupResourceBase struct { CloudgroupId string `json:"cloudgroup_id"` } -// SCloudgroupUser is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudid/models.SCloudgroupUser. -type SCloudgroupUser struct { - SCloudgroupJointsBase - SClouduserResourceBase -} - // SCloudpolicy is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudid/models.SCloudpolicy. type SCloudpolicy struct { apis.SStatusInfrasResourceBase @@ -137,23 +118,6 @@ type SClouduser struct { Email string `json:"email"` } -// SClouduserJointsBase is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudid/models.SClouduserJointsBase. -type SClouduserJointsBase struct { - apis.SJointResourceBase - SClouduserResourceBase -} - -// SClouduserPolicy is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudid/models.SClouduserPolicy. -type SClouduserPolicy struct { - SClouduserJointsBase - SCloudpolicyResourceBase -} - -// SClouduserResourceBase is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudid/models.SClouduserResourceBase. -type SClouduserResourceBase struct { - ClouduserId string `json:"clouduser_id"` -} - // SSAMLProvider is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudid/models.SSAMLProvider. type SSAMLProvider struct { apis.SStatusInfrasResourceBase diff --git a/pkg/apis/compute/zz_generated.model.go b/pkg/apis/compute/zz_generated.model.go index 52b8eb66dc..8bc2c1e06c 100644 --- a/pkg/apis/compute/zz_generated.model.go +++ b/pkg/apis/compute/zz_generated.model.go @@ -351,12 +351,6 @@ type SCloudproviderregion struct { LastAutoSyncAt time.Time `json:"last_auto_sync_at"` } -// SCloudproviderschedtag is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SCloudproviderschedtag. -type SCloudproviderschedtag struct { - SSchedtagJointsBase - SCloudproviderResourceBase -} - // SCloudregion is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SCloudregion. type SCloudregion struct { apis.SEnabledStatusStandaloneResourceBase @@ -377,12 +371,6 @@ type SCloudregionResourceBase struct { CloudregionId string `json:"cloudregion_id"` } -// SCloudregionschedtag is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SCloudregionschedtag. -type SCloudregionschedtag struct { - SSchedtagJointsBase - SCloudregionResourceBase -} - // SContainer is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SContainer. type SContainer struct { apis.SVirtualResourceBase @@ -499,19 +487,6 @@ type SDBInstanceDatabase struct { CharacterSet string `json:"character_set"` } -// SDBInstanceJointsBase is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SDBInstanceJointsBase. -type SDBInstanceJointsBase struct { - apis.SVirtualJointResourceBase - SDBInstanceResourceBase -} - -// SDBInstanceNetwork is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SDBInstanceNetwork. -type SDBInstanceNetwork struct { - SDBInstanceJointsBase - NetworkId string `json:"network_id"` - IpAddr string `json:"ip_addr"` -} - // SDBInstanceParameter is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SDBInstanceParameter. type SDBInstanceParameter struct { apis.SStandaloneResourceBase @@ -538,12 +513,6 @@ type SDBInstanceResourceBase struct { DBInstanceId string `json:"dbinstance_id"` } -// SDBInstanceSecgroup is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SDBInstanceSecgroup. -type SDBInstanceSecgroup struct { - SDBInstanceJointsBase - SSecurityGroupResourceBase -} - // SDBInstanceSku is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SDBInstanceSku. type SDBInstanceSku struct { apis.SEnabledStatusStandaloneResourceBase @@ -1314,15 +1283,6 @@ type SHostBackupstorage struct { BackupstorageId string `json:"backupstorage_id"` } -// SHostIsolatedDeviceModel is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SHostIsolatedDeviceModel. -type SHostIsolatedDeviceModel struct { - SHostJointsBase - // 宿主机Id - HostId string `json:"host_id"` - // 设备类型Id - IsolatedDeviceModelId string `json:"isolated_device_model_id"` -} - // SHostJointsBase is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SHostJointsBase. type SHostJointsBase struct { apis.SJointResourceBase @@ -2983,9 +2943,3 @@ type SZone struct { type SZoneResourceBase struct { ZoneId string `json:"zone_id"` } - -// SZoneschedtag is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SZoneschedtag. -type SZoneschedtag struct { - SSchedtagJointsBase - SZoneResourceBase -} diff --git a/pkg/apis/identity/organization.go b/pkg/apis/identity/organization.go index 85a561d31b..ef61628aac 100644 --- a/pkg/apis/identity/organization.go +++ b/pkg/apis/identity/organization.go @@ -221,5 +221,12 @@ type SOrganizationNodeDetails struct { Type TOrgType `json:"type"` } +type SOrganizationDetails struct { + EnabledIdentityBaseResourceDetails + apis.SharableResourceBaseInfo + + SOrganization +} + type OrganizationPerformCleanInput struct { } diff --git a/pkg/apis/identity/zz_generated.model.go b/pkg/apis/identity/zz_generated.model.go index e206b6837d..d345678f02 100644 --- a/pkg/apis/identity/zz_generated.model.go +++ b/pkg/apis/identity/zz_generated.model.go @@ -210,13 +210,6 @@ type SOrganization struct { Level int `json:"level"` } -// SOrganizationDetails is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SOrganizationDetails. -type SOrganizationDetails struct { - EnabledIdentityBaseResourceDetails - apis.SharableResourceBaseInfo - SOrganization -} - // SOrganizationNode is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SOrganizationNode. type SOrganizationNode struct { apis.SStandaloneResourceBase @@ -385,10 +378,3 @@ type SUserOption struct { OptionId string `json:"option_id"` OptionValue string `json:"option_value"` } - -// SUsergroupMembership is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SUsergroupMembership. -type SUsergroupMembership struct { - apis.SResourceBase - UserId string `json:"user_id"` - GroupId string `json:"group_id"` -} diff --git a/pkg/apis/image/zz_generated.model.go b/pkg/apis/image/zz_generated.model.go index f016865757..865c93f475 100644 --- a/pkg/apis/image/zz_generated.model.go +++ b/pkg/apis/image/zz_generated.model.go @@ -68,44 +68,9 @@ type SImage struct { EncryptStatus string `json:"encrypt_status"` } -// SImageMember is an autogenerated struct via yunion.io/x/onecloud/pkg/image/models.SImageMember. -type SImageMember struct { - SImagePeripheral - Member string `json:"member"` - CanShare bool `json:"can_share"` -} - // SImagePeripheral is an autogenerated struct via yunion.io/x/onecloud/pkg/image/models.SImagePeripheral. type SImagePeripheral struct { apis.SResourceBase Id int `json:"id"` ImageId string `json:"image_id"` } - -// SImageProperty is an autogenerated struct via yunion.io/x/onecloud/pkg/image/models.SImageProperty. -type SImageProperty struct { - SImagePeripheral - Name string `json:"name"` - Value string `json:"value"` -} - -// SImageSubformat is an autogenerated struct via yunion.io/x/onecloud/pkg/image/models.SImageSubformat. -type SImageSubformat struct { - SImagePeripheral - Format string `json:"format"` - Size int64 `json:"size"` - Location string `json:"location"` - Checksum string `json:"checksum"` - FastHash string `json:"fast_hash"` - Status string `json:"status"` - TorrentSize int64 `json:"torrent_size"` - TorrentLocation string `json:"torrent_location"` - TorrentChecksum string `json:"torrent_checksum"` - TorrentStatus string `json:"torrent_status"` -} - -// SImageTag is an autogenerated struct via yunion.io/x/onecloud/pkg/image/models.SImageTag. -type SImageTag struct { - SImagePeripheral - Value string `json:"value"` -} diff --git a/pkg/apis/monitor/alertnotification.go b/pkg/apis/monitor/alertnotification.go index b4b05dd510..77f55ac0a4 100644 --- a/pkg/apis/monitor/alertnotification.go +++ b/pkg/apis/monitor/alertnotification.go @@ -29,7 +29,6 @@ const ( type AlertJointResourceBaseDetails struct { apis.JointResourceBaseDetails - SAlertJointsBase Alert string `json:"alert"` } diff --git a/pkg/apis/monitor/zz_generated.model.go b/pkg/apis/monitor/zz_generated.model.go index cabc2c114e..1d10633c35 100644 --- a/pkg/apis/monitor/zz_generated.model.go +++ b/pkg/apis/monitor/zz_generated.model.go @@ -67,12 +67,6 @@ type SAlertDashboardPanel struct { PanelId string `json:"panel_id"` } -// SAlertJointsBase is an autogenerated struct via yunion.io/x/onecloud/pkg/monitor/models.SAlertJointsBase. -type SAlertJointsBase struct { - apis.SVirtualJointResourceBase - AlertId string `json:"alert_id"` -} - // SAlertPanel is an autogenerated struct via yunion.io/x/onecloud/pkg/monitor/models.SAlertPanel. type SAlertPanel struct { apis.SStatusStandaloneResourceBase @@ -115,31 +109,6 @@ type SAlertResource struct { Type string `json:"type"` } -// SAlertResourceAlert is an autogenerated struct via yunion.io/x/onecloud/pkg/monitor/models.SAlertResourceAlert. -type SAlertResourceAlert struct { - SAlertResourceJointsBase - AlertId string `json:"alert_id"` - AlertRecordId string `json:"alert_record_id"` - TriggerTime time.Time `json:"trigger_time"` - Data jsonutils.JSONObject `json:"data"` -} - -// SAlertResourceJointsBase is an autogenerated struct via yunion.io/x/onecloud/pkg/monitor/models.SAlertResourceJointsBase. -type SAlertResourceJointsBase struct { - apis.SJointResourceBase - AlertResourceId string `json:"alert_resource_id"` -} - -// SAlertnotification is an autogenerated struct via yunion.io/x/onecloud/pkg/monitor/models.SAlertnotification. -type SAlertnotification struct { - SAlertJointsBase - NotificationId string `json:"notification_id"` - State string `json:"state"` - Index byte `json:"index"` - UsedBy string `json:"used_by"` - Params jsonutils.JSONObject `json:"params"` -} - // SCommonAlert is an autogenerated struct via yunion.io/x/onecloud/pkg/monitor/models.SCommonAlert. type SCommonAlert struct { SAlert diff --git a/pkg/cloudid/models/cloudgroup_policies.go b/pkg/cloudid/models/cloudgroup_policies.go index f87db776fb..ec39a39d6d 100644 --- a/pkg/cloudid/models/cloudgroup_policies.go +++ b/pkg/cloudid/models/cloudgroup_policies.go @@ -53,6 +53,7 @@ func init() { } +// +onecloud:swagger-gen-ignore type SCloudgroupPolicy struct { SCloudgroupJointsBase SCloudpolicyResourceBase diff --git a/pkg/cloudid/models/cloudgroup_users.go b/pkg/cloudid/models/cloudgroup_users.go index 2744f0a589..df77e503f2 100644 --- a/pkg/cloudid/models/cloudgroup_users.go +++ b/pkg/cloudid/models/cloudgroup_users.go @@ -53,6 +53,7 @@ func init() { } +// +onecloud:swagger-gen-ignore type SCloudgroupUser struct { SCloudgroupJointsBase diff --git a/pkg/cloudid/models/cloudgroupjoints.go b/pkg/cloudid/models/cloudgroupjoints.go index 38b01f07cf..07b7266ca9 100644 --- a/pkg/cloudid/models/cloudgroupjoints.go +++ b/pkg/cloudid/models/cloudgroupjoints.go @@ -49,6 +49,7 @@ func NewCloudgroupJointsManager(dt interface{}, tableName string, keyword string } } +// +onecloud:swagger-gen-ignore type SCloudgroupJointsBase struct { db.SJointResourceBase diff --git a/pkg/cloudid/models/clouduser_policies.go b/pkg/cloudid/models/clouduser_policies.go index a5d2ea5f0e..c1dbf2b5d1 100644 --- a/pkg/cloudid/models/clouduser_policies.go +++ b/pkg/cloudid/models/clouduser_policies.go @@ -55,6 +55,7 @@ func init() { } +// +onecloud:swagger-gen-ignore type SClouduserPolicy struct { SClouduserJointsBase diff --git a/pkg/cloudid/models/clouduserjoints.go b/pkg/cloudid/models/clouduserjoints.go index 45c6661530..c67249e025 100644 --- a/pkg/cloudid/models/clouduserjoints.go +++ b/pkg/cloudid/models/clouduserjoints.go @@ -46,6 +46,7 @@ func NewClouduserJointsManager(dt interface{}, tableName string, keyword string, } } +// +onecloud:swagger-gen-ignore type SClouduserJointsBase struct { db.SJointResourceBase diff --git a/pkg/cloudid/models/clouduserresource.go b/pkg/cloudid/models/clouduserresource.go index 5569acb23d..d1c168aee8 100644 --- a/pkg/cloudid/models/clouduserresource.go +++ b/pkg/cloudid/models/clouduserresource.go @@ -35,6 +35,7 @@ import ( type SClouduserResourceBaseManager struct { } +// +onecloud:swagger-gen-ignore type SClouduserResourceBase struct { ClouduserId string `width:"36" charset:"ascii" nullable:"false" list:"user" create:"required"` } diff --git a/pkg/compute/models/cloudproviderschedtags.go b/pkg/compute/models/cloudproviderschedtags.go index 3b9986cff8..ab48250582 100644 --- a/pkg/compute/models/cloudproviderschedtags.go +++ b/pkg/compute/models/cloudproviderschedtags.go @@ -45,11 +45,13 @@ func init() { }) } +// +onecloud:swagger-gen-ignore type SCloudproviderschedtagManager struct { *SSchedtagJointsManager SCloudproviderResourceBaseManager } +// +onecloud:swagger-gen-ignore type SCloudproviderschedtag struct { SSchedtagJointsBase SCloudproviderResourceBase diff --git a/pkg/compute/models/cloudregionschedtags.go b/pkg/compute/models/cloudregionschedtags.go index 5b9cf2325a..b193b64cde 100644 --- a/pkg/compute/models/cloudregionschedtags.go +++ b/pkg/compute/models/cloudregionschedtags.go @@ -45,11 +45,13 @@ func init() { }) } +// +onecloud:swagger-gen-ignore type SCloudregionschedtagManager struct { *SSchedtagJointsManager resourceBaseManager SCloudregionResourceBaseManager } +// +onecloud:swagger-gen-ignore type SCloudregionschedtag struct { SSchedtagJointsBase SCloudregionResourceBase diff --git a/pkg/compute/models/dbinstance_secgroups.go b/pkg/compute/models/dbinstance_secgroups.go index 7c4ff29ac9..af01bba184 100644 --- a/pkg/compute/models/dbinstance_secgroups.go +++ b/pkg/compute/models/dbinstance_secgroups.go @@ -32,6 +32,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SDBInstanceSecgroupManager struct { SDBInstanceJointsManager SSecurityGroupResourceBaseManager @@ -54,6 +55,7 @@ func init() { }) } +// +onecloud:swagger-gen-ignore type SDBInstanceSecgroup struct { SDBInstanceJointsBase diff --git a/pkg/compute/models/dbinstancejoints.go b/pkg/compute/models/dbinstancejoints.go index 2d6a682648..d2a4819d1e 100644 --- a/pkg/compute/models/dbinstancejoints.go +++ b/pkg/compute/models/dbinstancejoints.go @@ -25,6 +25,7 @@ import ( "yunion.io/x/onecloud/pkg/mcclient" ) +// +onecloud:swagger-gen-ignore type SDBInstanceJointsManager struct { db.SVirtualJointResourceBaseManager SDBInstanceResourceBaseManager @@ -43,6 +44,7 @@ func NewDBInstanceJointsManager(dt interface{}, tableName string, keyword string } } +// +onecloud:swagger-gen-ignore type SDBInstanceJointsBase struct { db.SVirtualJointResourceBase diff --git a/pkg/compute/models/dbinstancenetworks.go b/pkg/compute/models/dbinstancenetworks.go index 2f86d62b41..3cf4a940f4 100644 --- a/pkg/compute/models/dbinstancenetworks.go +++ b/pkg/compute/models/dbinstancenetworks.go @@ -30,6 +30,7 @@ import ( "yunion.io/x/onecloud/pkg/mcclient" ) +// +onecloud:swagger-gen-ignore type SDBInstanceNetworkManager struct { SDBInstanceJointsManager SNetworkResourceBaseManager @@ -53,6 +54,7 @@ func init() { }) } +// +onecloud:swagger-gen-ignore type SDBInstanceNetwork struct { SDBInstanceJointsBase diff --git a/pkg/compute/models/elasticcache_joints.go b/pkg/compute/models/elasticcache_joints.go index cb71fde509..6c62de0159 100644 --- a/pkg/compute/models/elasticcache_joints.go +++ b/pkg/compute/models/elasticcache_joints.go @@ -29,6 +29,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SElasticcacheJointsManager struct { db.SVirtualJointResourceBaseManager SElasticcacheResourceBaseManager @@ -47,6 +48,7 @@ func NewElasticcacheJointsManager(dt interface{}, tableName string, keyword stri } } +// +onecloud:model-api-gen type SElasticcacheJointsBase struct { db.SVirtualJointResourceBase SElasticcacheResourceBase diff --git a/pkg/compute/models/elasticcache_secgroups.go b/pkg/compute/models/elasticcache_secgroups.go index 06f69054d1..d7a6df6e8a 100644 --- a/pkg/compute/models/elasticcache_secgroups.go +++ b/pkg/compute/models/elasticcache_secgroups.go @@ -29,6 +29,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SElasticcachesecgroupManager struct { SElasticcacheJointsManager SSecurityGroupResourceBaseManager @@ -51,6 +52,7 @@ func init() { }) } +// +onecloud:model-api-gen type SElasticcachesecgroup struct { SElasticcacheJointsBase diff --git a/pkg/compute/models/groupguests.go b/pkg/compute/models/groupguests.go index bd9b247cab..65d045e868 100644 --- a/pkg/compute/models/groupguests.go +++ b/pkg/compute/models/groupguests.go @@ -28,6 +28,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SGroupguestManager struct { SGroupJointsManager SGuestResourceBaseManager @@ -50,6 +51,7 @@ func init() { }) } +// +onecloud:model-api-gen type SGroupguest struct { SGroupJointsBase diff --git a/pkg/compute/models/groupjoints.go b/pkg/compute/models/groupjoints.go index bdc120bafb..4679402d92 100644 --- a/pkg/compute/models/groupjoints.go +++ b/pkg/compute/models/groupjoints.go @@ -29,6 +29,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SGroupJointsManager struct { db.SVirtualJointResourceBaseManager SGroupResourceBaseManager @@ -47,6 +48,7 @@ func NewGroupJointsManager(dt interface{}, tableName string, keyword string, key } } +// +onecloud:model-api-gen type SGroupJointsBase struct { db.SVirtualJointResourceBase diff --git a/pkg/compute/models/groupnetworks.go b/pkg/compute/models/groupnetworks.go index 79881a5422..f02427ce0d 100644 --- a/pkg/compute/models/groupnetworks.go +++ b/pkg/compute/models/groupnetworks.go @@ -29,6 +29,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SGroupnetworkManager struct { SGroupJointsManager SNetworkResourceBaseManager @@ -51,6 +52,7 @@ func init() { }) } +// +onecloud:model-api-gen type SGroupnetwork struct { SGroupJointsBase diff --git a/pkg/compute/models/guest_actions.go b/pkg/compute/models/guest_actions.go index ee64eb8ac6..17f62bfe09 100644 --- a/pkg/compute/models/guest_actions.go +++ b/pkg/compute/models/guest_actions.go @@ -69,6 +69,7 @@ import ( "yunion.io/x/onecloud/pkg/util/seclib2" ) +// 获取VNC信息 func (self *SGuest) GetDetailsVnc(ctx context.Context, userCred mcclient.TokenCredential, input *cloudprovider.ServerVncInput) (*cloudprovider.ServerVncOutput, error) { ret := &cloudprovider.ServerVncOutput{} if self.PowerStates == api.VM_POWER_STATES_ON || @@ -115,6 +116,7 @@ func (self *SGuest) PreCheckPerformAction( return nil } +// 远程执行QMP命令 func (self *SGuest) PerformMonitor( ctx context.Context, userCred mcclient.TokenCredential, @@ -131,6 +133,7 @@ func (self *SGuest) PerformMonitor( return nil, httperrors.NewInvalidStatusError("Cannot send command in status %s", self.Status) } +// +onecloud:swagger-gen-ignore func (self *SGuest) PerformEvent(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { event, err := data.GetString("event") @@ -160,6 +163,7 @@ func (self *SGuest) GetDetailsDesc(ctx context.Context, userCred mcclient.TokenC return self.GetDriver().GetJsonDescAtHost(ctx, userCred, self, host, nil) } +// 保存镜像 func (self *SGuest) PerformSaveImage(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerSaveImageInput) (api.ServerSaveImageInput, error) { if !utils.IsInStringArray(self.Status, []string{api.VM_READY, api.VM_RUNNING}) { return input, httperrors.NewInputParameterError("Cannot save image in status %s", self.Status) @@ -208,6 +212,7 @@ func (self *SGuest) StartGuestSaveImage(ctx context.Context, userCred mcclient.T return self.GetDriver().StartGuestSaveImage(ctx, userCred, self, jsonutils.Marshal(input).(*jsonutils.JSONDict), parentTaskId) } +// 保存主机模板 func (self *SGuest) PerformSaveGuestImage(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerSaveGuestImageInput) (jsonutils.JSONObject, error) { @@ -313,6 +318,7 @@ func (self *SGuest) StartGuestSaveGuestImage(ctx context.Context, userCred mccli return self.GetDriver().StartGuestSaveGuestImage(ctx, userCred, self, data, parentTaskId) } +// 同步配置 func (self *SGuest) PerformSync(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if !utils.IsInStringArray(self.Status, []string{api.VM_READY, api.VM_RUNNING}) { return nil, httperrors.NewResourceBusyError("Cannot sync in status %s", self.Status) @@ -440,6 +446,7 @@ func (self *SGuest) validateConvertToKvm( return nil } +// 迁移调度 func (self *SGuest) PerformMigrateForecast(ctx context.Context, userCred mcclient.TokenCredential, _ jsonutils.JSONObject, input *api.ServerMigrateForecastInput) (jsonutils.JSONObject, error) { var ( mInput *api.GuestMigrateInput = nil @@ -518,6 +525,7 @@ func (self *SGuest) GetSchedMigrateParams( return schedDesc } +// 冷迁移虚拟机 func (self *SGuest) PerformMigrate(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input *api.GuestMigrateInput) (jsonutils.JSONObject, error) { if err := self.validateMigrate(ctx, userCred, input, nil); err != nil { return nil, err @@ -555,6 +563,7 @@ func (self *SGuest) StartMigrateTask( return nil } +// 在线迁移虚拟机 func (self *SGuest) PerformLiveMigrate(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input *api.GuestLiveMigrateInput) (jsonutils.JSONObject, error) { if err := self.validateMigrate(ctx, userCred, nil, input); err != nil { return nil, err @@ -612,6 +621,7 @@ func (self *SGuest) StartGuestLiveMigrateTask( return nil } +// +onecloud:swagger-gen-ignore func (self *SGuest) PerformSetLiveMigrateParams( ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerSetLiveMigrateParamsInput, ) (jsonutils.JSONObject, error) { @@ -641,6 +651,7 @@ func (self *SGuest) PerformSetLiveMigrateParams( return self.SendMonitorCommand(ctx, userCred, monitorInput) } +// 取消在线迁移 func (self *SGuest) PerformCancelLiveMigrate( ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject, ) (jsonutils.JSONObject, error) { @@ -651,6 +662,7 @@ func (self *SGuest) PerformCancelLiveMigrate( return nil, self.GetDriver().RequestCancelLiveMigrate(ctx, self, userCred) } +// 克隆虚拟机 func (self *SGuest) PerformClone(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if self.IsEncrypted() { return nil, httperrors.NewForbiddenError("cannot clone encrypted server") @@ -723,6 +735,7 @@ func (self *SGuest) PerformClone(ctx context.Context, userCred mcclient.TokenCre return nil, nil } +// 重置密码 func (self *SGuest) PerformSetPassword(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerSetPasswordInput) (jsonutils.JSONObject, error) { if self.Hypervisor == api.HYPERVISOR_KVM && self.Status == api.VM_RUNNING { inputQga := &api.ServerQgaSetPasswordInput{ @@ -775,6 +788,7 @@ func (self *SGuest) GetOldPassword(ctx context.Context, userCred mcclient.TokenC return password } +// 重置密码或秘钥信息&探测虚拟机镜像 func (self *SGuest) PerformDeploy( ctx context.Context, userCred mcclient.TokenCredential, @@ -894,6 +908,7 @@ func (self *SGuest) ValidateAttachDisk(ctx context.Context, disk *SDisk) error { return nil } +// 绑定磁盘 func (self *SGuest) PerformAttachdisk(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerAttachDiskInput) (jsonutils.JSONObject, error) { if len(input.DiskId) == 0 { return nil, httperrors.NewMissingParameterError("disk_id") @@ -984,6 +999,7 @@ func (self *SGuest) doSyncTask(ctx context.Context, data *jsonutils.JSONDict, us return nil } +// 挂起虚拟机 func (self *SGuest) PerformSuspend(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if self.Status == api.VM_RUNNING { err := self.StartSuspendTask(ctx, userCred, "") @@ -1000,6 +1016,7 @@ func (self *SGuest) StartSuspendTask(ctx context.Context, userCred mcclient.Toke return self.GetDriver().StartSuspendTask(ctx, userCred, self, nil, parentTaskId) } +// 恢复虚拟机挂起状态 func (self *SGuest) PerformResume(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerResumeInput) (jsonutils.JSONObject, error) { if self.Status == api.VM_SUSPEND { err := self.StartResumeTask(ctx, userCred, "") @@ -1016,6 +1033,7 @@ func (self *SGuest) StartResumeTask(ctx context.Context, userCred mcclient.Token return self.GetDriver().StartResumeTask(ctx, userCred, self, nil, parentTaskId) } +// 开机 func (self *SGuest) PerformStart( ctx context.Context, userCred mcclient.TokenCredential, @@ -1242,6 +1260,7 @@ func (self *SGuest) GetDetailsIso(ctx context.Context, userCred mcclient.TokenCr return desc, nil } +// 挂载ISO镜像 func (self *SGuest) PerformInsertiso(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if !utils.IsInStringArray(self.Hypervisor, []string{api.HYPERVISOR_KVM, api.HYPERVISOR_BAREMETAL}) { return nil, httperrors.NewNotAcceptableError("Not allow for hypervisor %s", self.Hypervisor) @@ -1281,6 +1300,7 @@ func (self *SGuest) PerformInsertiso(ctx context.Context, userCred mcclient.Toke } } +// 卸载ISO镜像 func (self *SGuest) PerformEjectiso(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if !utils.IsInStringArray(self.Hypervisor, []string{api.HYPERVISOR_KVM, api.HYPERVISOR_BAREMETAL}) { return nil, httperrors.NewNotAcceptableError("Not allow for hypervisor %s", self.Hypervisor) @@ -1362,6 +1382,7 @@ func (self *SGuest) GetDetailsVfd(floppyOrdinal int64, userCred mcclient.TokenCr return desc } +// 挂载软盘 func (self *SGuest) PerformInsertvfd(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data api.ServerInsertVfdInput) (jsonutils.JSONObject, error) { if !utils.IsInStringArray(self.Hypervisor, []string{api.HYPERVISOR_KVM, api.HYPERVISOR_BAREMETAL}) { return nil, httperrors.NewNotAcceptableError("Not allow for hypervisor %s", self.Hypervisor) @@ -1387,6 +1408,7 @@ func (self *SGuest) PerformInsertvfd(ctx context.Context, userCred mcclient.Toke } } +// 卸载软盘 func (self *SGuest) PerformEjectvfd(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data api.ServerEjectVfdInput) (jsonutils.JSONObject, error) { if !utils.IsInStringArray(self.Hypervisor, []string{api.HYPERVISOR_KVM, api.HYPERVISOR_BAREMETAL}) { return nil, httperrors.NewNotAcceptableError("Not allow for hypervisor %s", self.Hypervisor) @@ -1551,6 +1573,7 @@ func (self *SGuest) StartDeleteGuestTask( return self.GetDriver().StartDeleteGuestTask(ctx, userCred, self, params, parentTaskId) } +// 清除虚拟机记录(仅数据库操作) func (self *SGuest) PerformPurge(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { err := self.validateDeleteCondition(ctx, true) if err != nil { @@ -1770,6 +1793,7 @@ func (self *SGuest) DetachDisk(ctx context.Context, disk *SDisk, userCred mcclie } } +// 创建虚拟机磁盘 func (self *SGuest) PerformCreatedisk(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { diskSize := 0 disksConf := make([]*api.DiskConfig, 0) @@ -1854,6 +1878,7 @@ func (self *SGuest) StartGuestCreateDiskTask(ctx context.Context, userCred mccli return task.ScheduleRun(nil) } +// 卸载磁盘 func (self *SGuest) PerformDetachdisk(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerDetachDiskInput) (jsonutils.JSONObject, error) { if len(input.DiskId) == 0 { return nil, httperrors.NewMissingParameterError("disk_id") @@ -1914,6 +1939,7 @@ func (self *SGuest) StartGuestDetachdiskTask( return self.GetDriver().StartGuestDetachdiskTask(ctx, userCred, self, taskData, parentTaskId) } +// 卸载透传设备 func (self *SGuest) PerformDetachIsolatedDevice(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if self.Hypervisor != api.HYPERVISOR_KVM { return nil, httperrors.NewNotAcceptableError("Not allow for hypervisor %s", self.Hypervisor) @@ -2016,6 +2042,7 @@ func (self *SGuest) detachIsolateDevice(ctx context.Context, userCred mcclient.T return nil } +// 挂载透传设备 func (self *SGuest) PerformAttachIsolatedDevice(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if self.Hypervisor != api.HYPERVISOR_KVM { return nil, httperrors.NewNotAcceptableError("Not allow for hypervisor %s", self.Hypervisor) @@ -2191,6 +2218,7 @@ func (self *SGuest) attachIsolatedDevice(ctx context.Context, userCred mcclient. return nil } +// 设置透传设备 func (self *SGuest) PerformSetIsolatedDevice(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if self.Hypervisor != api.HYPERVISOR_KVM { return nil, httperrors.NewNotAcceptableError("Not allow for hypervisor %s", self.Hypervisor) @@ -2517,6 +2545,7 @@ func (self *SGuest) GetIfNameByMac(ctx context.Context, userCred mcclient.TokenC return ifnameDevice, nil } +// 卸载网卡 func (self *SGuest) PerformDetachnetwork( ctx context.Context, userCred mcclient.TokenCredential, @@ -2650,6 +2679,7 @@ func (guest *SGuest) fixDefaultGateway(ctx context.Context, userCred mcclient.To return nil } +// 挂载网卡 func (self *SGuest) PerformAttachnetwork( ctx context.Context, userCred mcclient.TokenCredential, @@ -2797,6 +2827,7 @@ func (self *SGuest) PerformAttachnetwork( return nil, nil } +// 调整带宽 func (self *SGuest) PerformChangeBandwidth( ctx context.Context, userCred mcclient.TokenCredential, @@ -2832,6 +2863,7 @@ func (self *SGuest) PerformChangeBandwidth( return nil, nil } +// 修改源地址检查 func (self *SGuest) PerformModifySrcCheck(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if !utils.IsInStringArray(self.Status, []string{api.VM_READY, api.VM_RUNNING}) { return nil, httperrors.NewBadRequestError("Cannot change setting in status %s", self.Status) @@ -2881,6 +2913,7 @@ func (self *SGuest) PerformModifySrcCheck(ctx context.Context, userCred mcclient return nil, nil } +// 调整配置 func (self *SGuest) PerformChangeConfig(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerChangeConfigInput) (jsonutils.JSONObject, error) { if !self.GetDriver().AllowReconfigGuest() { return nil, httperrors.NewInvalidStatusError("Not allow to change config") @@ -2994,6 +3027,7 @@ func (self *SGuest) DoPendingDelete(ctx context.Context, userCred mcclient.Token self.SVirtualResourceBase.DoPendingDelete(ctx, userCred) } +// 从回收站恢复虚拟机 func (self *SGuest) PerformCancelDelete(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if self.PendingDeleted && !self.Deleted { err := self.DoCancelPendingDelete(ctx, userCred) @@ -3048,6 +3082,7 @@ func (self *SGuest) StartUndeployGuestTask(ctx context.Context, userCred mcclien return nil } +// 重置虚拟机状态 func (self *SGuest) PerformReset(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { isHard := jsonutils.QueryBoolean(data, "is_hard", false) @@ -3131,6 +3166,7 @@ func (self *SGuest) SetBackupGuestStatus(userCred mcclient.TokenCredential, stat return nil } +// 同步状态 func (self *SGuest) PerformStatus(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input apis.PerformStatusInput) (jsonutils.JSONObject, error) { if input.HostId != "" && self.BackupHostId != "" && input.HostId == self.BackupHostId { // perform status called from slave guest @@ -3193,6 +3229,7 @@ func (self *SGuest) PerformStatus(ctx context.Context, userCred mcclient.TokenCr return nil, nil } +// 关机 func (self *SGuest) PerformStop(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerStopInput) (jsonutils.JSONObject, error) { // XXX if is force, force stop guest @@ -3205,6 +3242,7 @@ func (self *SGuest) PerformStop(ctx context.Context, userCred mcclient.TokenCred return nil, httperrors.NewInvalidStatusError("Cannot stop server in status %s", self.Status) } +// 冻结虚拟机 func (self *SGuest) PerformFreeze(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input apis.PerformFreezeInput) (jsonutils.JSONObject, error) { if self.Freezed { return nil, httperrors.NewBadRequestError("virtual resource already freezed") @@ -3226,6 +3264,7 @@ func (self *SGuest) StartGuestStopAndFreezeTask(ctx context.Context, userCred mc return nil } +// 重启 func (self *SGuest) PerformRestart(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { isForce := jsonutils.QueryBoolean(data, "is_force", false) if utils.IsInStringArray(self.Status, []string{api.VM_RUNNING, api.VM_STOP_FAILED}) || (isForce && self.Status == api.VM_STOPPING) { @@ -3235,6 +3274,7 @@ func (self *SGuest) PerformRestart(ctx context.Context, userCred mcclient.TokenC } } +// 发送远程命令 func (self *SGuest) PerformSendkeys(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if self.Hypervisor != api.HYPERVISOR_KVM { return nil, httperrors.NewNotAcceptableError("Not allow for hypervisor %s", self.Hypervisor) @@ -3307,6 +3347,7 @@ func (self *SGuest) SendMonitorCommand(ctx context.Context, userCred mcclient.To return ret, nil } +// 绑定EIP func (self *SGuest) PerformAssociateEip(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerAssociateEipInput) (jsonutils.JSONObject, error) { err := self.IsEipAssociable() if err != nil { @@ -3389,6 +3430,7 @@ func (self *SGuest) PerformAssociateEip(ctx context.Context, userCred mcclient.T return nil, err } +// 解绑EIP func (self *SGuest) PerformDissociateEip(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerDissociateEipInput) (jsonutils.JSONObject, error) { eip, err := self.GetElasticIp() if err != nil { @@ -3416,6 +3458,7 @@ func (self *SGuest) PerformDissociateEip(ctx context.Context, userCred mcclient. return nil, nil } +// 创建EIP func (self *SGuest) PerformCreateEip(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerCreateEipInput) (jsonutils.JSONObject, error) { var ( host, _ = self.GetHost() @@ -3512,6 +3555,7 @@ func (self *SGuest) GetUserData(ctx context.Context, userCred mcclient.TokenCred return decodeData } +// 更新自定义脚本数据 func (self *SGuest) PerformUserData(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerUserDataInput) (jsonutils.JSONObject, error) { if len(input.UserData) == 0 { return nil, httperrors.NewMissingParameterError("user_data") @@ -3530,6 +3574,7 @@ func (self *SGuest) PerformUserData(ctx context.Context, userCred mcclient.Token return nil, nil } +// 设置Qemu参数 func (self *SGuest) PerformSetQemuParams(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { isaSerial, err := data.GetString("disable_isa_serial") if err == nil { @@ -3574,6 +3619,7 @@ func (self *SGuest) SwitchToBackup(userCred mcclient.TokenCredential) error { return nil } +// 主备机切换 func (self *SGuest) PerformSwitchToBackup( ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject, ) (jsonutils.JSONObject, error) { @@ -3857,6 +3903,7 @@ func (self *SGuest) guestDisksStorageTypeIsShared() bool { return true } +// 创建备机 func (self *SGuest) PerformCreateBackup( ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject, @@ -3915,6 +3962,7 @@ func (self *SGuest) StartGuestCreateBackupTask( return nil, nil } +// 删除备机 func (self *SGuest) PerformDeleteBackup(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if len(self.BackupHostId) == 0 { return nil, httperrors.NewBadRequestError("Guest without backup") @@ -3965,6 +4013,7 @@ func (self *SGuest) StartCreateBackup(ctx context.Context, userCred mcclient.Tok return nil } +// 备机开机 func (self *SGuest) PerformStartBackup( ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject, ) (jsonutils.JSONObject, error) { @@ -4032,6 +4081,7 @@ func (self *SGuest) PerformDelExtraOption(ctx context.Context, userCred mcclient return nil, self.SetExtraOptions(ctx, userCred, extraOptions) } +// 取消定时删除 func (self *SGuest) PerformCancelExpire(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if self.BillingType != billing_api.BILLING_TYPE_POSTPAID { return nil, httperrors.NewBadRequestError("guest billing type %s not support cancel expire", self.BillingType) @@ -4051,6 +4101,7 @@ func (self *SGuest) PerformCancelExpire(ctx context.Context, userCred mcclient.T return nil, nil } +// 设置定时删除 func (self *SGuest) PerformPostpaidExpire(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input apis.PostpaidExpireInput) (jsonutils.JSONObject, error) { if self.BillingType != billing_api.BILLING_TYPE_POSTPAID { return nil, httperrors.NewBadRequestError("guest billing type is %s", self.BillingType) @@ -4073,6 +4124,7 @@ func (self *SGuest) PerformPostpaidExpire(ctx context.Context, userCred mcclient return nil, nil } +// 续费 func (self *SGuest) PerformRenew(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { durationStr, _ := data.GetString("duration") if len(durationStr) == 0 { @@ -4207,6 +4259,7 @@ func (self *SGuest) PerformStreamDisksComplete(ctx context.Context, userCred mcc return nil, nil } +// 导入虚拟机 func (man *SGuestManager) PerformImport(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { desc := &api.SImportGuestDesc{} if err := data.Unmarshal(desc); err != nil { @@ -4355,6 +4408,7 @@ func (self *SGuest) importDisks(ctx context.Context, userCred mcclient.TokenCred return nil } +// 从Libvirt导入虚拟机 func (manager *SGuestManager) PerformImportFromLibvirt(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { host := &api.SLibvirtHostConfig{} if err := data.Unmarshal(host); err != nil { @@ -4576,6 +4630,7 @@ func (self *SGuest) PerformSyncFixNics(ctx context.Context, return nil, nil } +// 更改项目 func (guest *SGuest) PerformChangeOwner(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input apis.PerformChangeProjectOwnerInput) (jsonutils.JSONObject, error) { disks, err := guest.GetDisks() if err != nil { @@ -4617,6 +4672,7 @@ func (guest *SGuest) PerformChangeOwner(ctx context.Context, userCred mcclient.T return changOwner, nil } +// 磁盘扩容 func (guest *SGuest) PerformResizeDisk(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerResizeDiskInput) (jsonutils.JSONObject, error) { if guest.Hypervisor == api.HYPERVISOR_ESXI { c, err := guest.GetInstanceSnapshotCount() @@ -4663,6 +4719,7 @@ func (guest *SGuest) StartGuestDiskResizeTask(ctx context.Context, userCred mccl return nil } +// 磁盘限速 func (self *SGuest) PerformIoThrottle(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input *api.ServerSetDiskIoThrottleInput) (jsonutils.JSONObject, error) { if self.Hypervisor != api.HYPERVISOR_KVM { return nil, httperrors.NewBadRequestError("Hypervisor %s can't do io throttle", self.Hypervisor) @@ -4778,6 +4835,7 @@ func (self *SGuest) validateForBatchMigrate(ctx context.Context, rescueMode bool return guest, nil } +// 批量迁移 func (manager *SGuestManager) PerformBatchMigrate(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { params := new(api.GuestBatchMigrateRequest) err := data.Unmarshal(params) @@ -5301,6 +5359,7 @@ func (guest *SGuest) StartDeleteGuestSnapshots(ctx context.Context, userCred mcc return nil } +// 重置网卡限速 func (self *SGuest) PerformResetNicTrafficLimit(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input *api.ServerNicTrafficLimit) (jsonutils.JSONObject, error) { @@ -5324,6 +5383,7 @@ func (self *SGuest) PerformResetNicTrafficLimit(ctx context.Context, userCred mc return nil, nil } +// 网卡限速 func (self *SGuest) PerformSetNicTrafficLimit(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input *api.ServerNicTrafficLimit) (jsonutils.JSONObject, error) { @@ -5619,6 +5679,7 @@ func (self *SGuest) PerformListForward(ctx context.Context, userCred mcclient.To return resp.JSON(), nil } +// 更改存储 func (self *SGuest) PerformChangeStorage(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input *api.ServerChangeStorageInput) (*api.ServerChangeStorageInput, error) { // validate input if input.TargetStorageId == "" { @@ -5756,6 +5817,7 @@ func (self *SGuest) startSwitchToClonedDisk(ctx context.Context, userCred mcclie return nil } +// 设置启动顺序 func (self *SGuest) PerformSetBootIndex(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input *api.ServerSetBootIndexInput) (jsonutils.JSONObject, error) { gds, err := self.GetGuestDisks() if err != nil { @@ -5841,6 +5903,7 @@ func (self *SGuest) PerformSetBootIndex(ctx context.Context, userCred mcclient.T return nil, nil } +// 探测透传设备 func (self *SGuest) PerformProbeIsolatedDevices(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { host, err := self.GetHost() if err != nil { @@ -6098,6 +6161,7 @@ func (self *SGuest) PerformEnableMemclean(ctx context.Context, userCred mcclient return nil, self.SetMetadata(ctx, api.VM_METADATA_ENABLE_MEMCLEAN, "true", userCred) } +// 设置操作系统信息 func (self *SGuest) PerformSetOsInfo(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input api.ServerSetOSInfoInput) (jsonutils.JSONObject, error) { if err := self.GetDriver().ValidateSetOSInfo(ctx, userCred, self, &input); err != nil { return nil, err @@ -6127,6 +6191,7 @@ func (self *SGuest) PerformSetOsInfo(ctx context.Context, userCred mcclient.Toke return nil, nil } +// 同步操作系统信息 func (self *SGuest) PerformSyncOsInfo(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) { if err := self.GetDriver().ValidateSyncOSInfo(ctx, userCred, self); err != nil { return nil, err diff --git a/pkg/compute/models/guest_secgroups.go b/pkg/compute/models/guest_secgroups.go index e33905d299..0537f09c23 100644 --- a/pkg/compute/models/guest_secgroups.go +++ b/pkg/compute/models/guest_secgroups.go @@ -120,6 +120,7 @@ func (self *SGuest) saveDefaultSecgroupId(userCred mcclient.TokenCredential, sec return nil } +// 解绑安全组 func (self *SGuest) PerformRevokeSecgroup( ctx context.Context, userCred mcclient.TokenCredential, @@ -173,6 +174,7 @@ func (self *SGuest) PerformRevokeSecgroup( return nil, self.StartSyncTask(ctx, userCred, true, "") } +// 解绑管理员安全组 func (self *SGuest) PerformRevokeAdminSecgroup( ctx context.Context, userCred mcclient.TokenCredential, @@ -219,6 +221,7 @@ func (self *SGuest) PerformAssignSecgroup( return self.performAssignSecgroup(ctx, userCred, query, input, false) } +// +onecloud:swagger-gen-ignore func (self *SGuest) PerformAssignAdminSecgroup( ctx context.Context, userCred mcclient.TokenCredential, diff --git a/pkg/compute/models/guestdisks.go b/pkg/compute/models/guestdisks.go index f35c8d4cdd..8a65d47ea1 100644 --- a/pkg/compute/models/guestdisks.go +++ b/pkg/compute/models/guestdisks.go @@ -30,6 +30,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SGuestdiskManager struct { SGuestJointsManager SDiskResourceBaseManager @@ -54,6 +55,7 @@ func init() { } +// +onecloud:model-api-gen type SGuestdisk struct { SGuestJointsBase diff --git a/pkg/compute/models/guestjoints.go b/pkg/compute/models/guestjoints.go index ec64fde8be..f36075addc 100644 --- a/pkg/compute/models/guestjoints.go +++ b/pkg/compute/models/guestjoints.go @@ -29,6 +29,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SGuestJointsManager struct { db.SVirtualJointResourceBaseManager SGuestResourceBaseManager @@ -47,6 +48,7 @@ func NewGuestJointsManager(dt interface{}, tableName string, keyword string, key } } +// +onecloud:model-api-gen type SGuestJointsBase struct { db.SVirtualJointResourceBase diff --git a/pkg/compute/models/guestnetworks.go b/pkg/compute/models/guestnetworks.go index 9799e8f09f..9059beb4ff 100644 --- a/pkg/compute/models/guestnetworks.go +++ b/pkg/compute/models/guestnetworks.go @@ -50,6 +50,7 @@ const ( MAX_GUESTNIC_TO_SAME_NETWORK = 2 ) +// +onecloud:swagger-gen-ignore type SGuestnetworkManager struct { SGuestJointsManager SNetworkResourceBaseManager @@ -75,6 +76,7 @@ func init() { }) } +// +onecloud:model-api-gen type SGuestnetwork struct { SGuestJointsBase diff --git a/pkg/compute/models/guestsecgroups.go b/pkg/compute/models/guestsecgroups.go index 61641d1fdc..d0b06f4ab1 100644 --- a/pkg/compute/models/guestsecgroups.go +++ b/pkg/compute/models/guestsecgroups.go @@ -28,6 +28,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SGuestsecgroupManager struct { SGuestJointsManager SSecurityGroupResourceBaseManager @@ -50,6 +51,7 @@ func init() { }) } +// +onecloud:model-api-gen type SGuestsecgroup struct { SGuestJointsBase diff --git a/pkg/compute/models/host_isolated_device_models.go b/pkg/compute/models/host_isolated_device_models.go index bc54d39a97..29dc7a266d 100644 --- a/pkg/compute/models/host_isolated_device_models.go +++ b/pkg/compute/models/host_isolated_device_models.go @@ -12,6 +12,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SHostIsolatedDeviceModelManager struct { SHostJointsManager } @@ -35,6 +36,7 @@ func init() { }) } +// +onecloud:swagger-gen-ignore type SHostIsolatedDeviceModel struct { SHostJointsBase diff --git a/pkg/compute/models/hostbackupstorages.go b/pkg/compute/models/hostbackupstorages.go index e59ee11cec..aaf4783f69 100644 --- a/pkg/compute/models/hostbackupstorages.go +++ b/pkg/compute/models/hostbackupstorages.go @@ -30,6 +30,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SHostBackupstorageManager struct { SHostJointsManager SBackupstorageResourceBaseManager @@ -54,6 +55,7 @@ func init() { }) } +// +onecloud:model-api-gen type SHostBackupstorage struct { SHostJointsBase diff --git a/pkg/compute/models/hostjoints.go b/pkg/compute/models/hostjoints.go index 81c69d33ed..d42299768a 100644 --- a/pkg/compute/models/hostjoints.go +++ b/pkg/compute/models/hostjoints.go @@ -27,6 +27,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SHostJointsManager struct { db.SJointResourceBaseManager SHostResourceBaseManager @@ -48,6 +49,7 @@ func NewHostJointsManager(hostIdFieldName string, dt interface{}, tableName stri } } +// +onecloud:model-api-gen type SHostJointsBase struct { db.SJointResourceBase } diff --git a/pkg/compute/models/hostnetworks.go b/pkg/compute/models/hostnetworks.go index 4ec63acfc6..789a19c5ff 100644 --- a/pkg/compute/models/hostnetworks.go +++ b/pkg/compute/models/hostnetworks.go @@ -28,6 +28,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SHostnetworkManager struct { SHostJointsManager SNetworkResourceBaseManager @@ -51,6 +52,7 @@ func init() { }) } +// +onecloud:model-api-gen type SHostnetwork struct { SHostJointsBase diff --git a/pkg/compute/models/hostschedtags.go b/pkg/compute/models/hostschedtags.go index 0af541e118..c937c0f99d 100644 --- a/pkg/compute/models/hostschedtags.go +++ b/pkg/compute/models/hostschedtags.go @@ -45,11 +45,13 @@ func init() { }) } +// +onecloud:swagger-gen-ignore type SHostschedtagManager struct { *SSchedtagJointsManager resourceBaseManager SHostResourceBaseManager } +// +onecloud:model-api-gen type SHostschedtag struct { SSchedtagJointsBase diff --git a/pkg/compute/models/hoststorages.go b/pkg/compute/models/hoststorages.go index 280358a9d5..efb3619145 100644 --- a/pkg/compute/models/hoststorages.go +++ b/pkg/compute/models/hoststorages.go @@ -36,6 +36,7 @@ import ( const ErrStorageInUse = errors.Error("StorageInUse") +// +onecloud:swagger-gen-ignore type SHoststorageManager struct { SHostJointsManager SStorageResourceBaseManager @@ -60,6 +61,7 @@ func init() { }) } +// +onecloud:model-api-gen type SHoststorage struct { SHostJointsBase diff --git a/pkg/compute/models/hostwires.go b/pkg/compute/models/hostwires.go index e05a974025..fad1c74719 100644 --- a/pkg/compute/models/hostwires.go +++ b/pkg/compute/models/hostwires.go @@ -29,6 +29,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SHostwireManagerDeprecated struct { SHostJointsManager SWireResourceBaseManager @@ -52,6 +53,7 @@ func init() { }) } +// +onecloud:model-api-gen type SHostwireDeprecated struct { SHostJointsBase diff --git a/pkg/compute/models/loadbalancernetworks.go b/pkg/compute/models/loadbalancernetworks.go index ee6f4ebe0d..7433a82f03 100644 --- a/pkg/compute/models/loadbalancernetworks.go +++ b/pkg/compute/models/loadbalancernetworks.go @@ -34,6 +34,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SLoadbalancernetworkManager struct { db.SVirtualJointResourceBaseManager SLoadbalancerResourceBaseManager @@ -58,6 +59,7 @@ func init() { }) } +// +onecloud:model-api-gen type SLoadbalancerNetwork struct { db.SVirtualJointResourceBase diff --git a/pkg/compute/models/networkschedtags.go b/pkg/compute/models/networkschedtags.go index 54877ddde3..6b0b4c4cb1 100644 --- a/pkg/compute/models/networkschedtags.go +++ b/pkg/compute/models/networkschedtags.go @@ -45,11 +45,13 @@ func init() { }) } +// +onecloud:swagger-gen-ignore type SNetworkschedtagManager struct { *SSchedtagJointsManager resourceBaseManager SNetworkResourceBaseManager } +// +onecloud:model-api-gen type SNetworkschedtag struct { SSchedtagJointsBase diff --git a/pkg/compute/models/schedtagjoint.go b/pkg/compute/models/schedtagjoint.go index b338cc7ef8..b1966155ae 100644 --- a/pkg/compute/models/schedtagjoint.go +++ b/pkg/compute/models/schedtagjoint.go @@ -32,6 +32,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SSchedtagJointsManager struct { db.SJointResourceBaseManager SSchedtagResourceBaseManager @@ -56,6 +57,7 @@ func NewSchedtagJointsManager( } } +// +onecloud:model-api-gen type SSchedtagJointsBase struct { db.SJointResourceBase diff --git a/pkg/compute/models/storageschedtags.go b/pkg/compute/models/storageschedtags.go index 8f6b8654b5..be49271c87 100644 --- a/pkg/compute/models/storageschedtags.go +++ b/pkg/compute/models/storageschedtags.go @@ -30,6 +30,7 @@ var ( _ ISchedtagJointModel = new(SStorageschedtag) ) +// +onecloud:swagger-gen-ignore type SStorageschedtagManager struct { *SSchedtagJointsManager resourceBaseManager SStorageResourceBaseManager @@ -50,6 +51,7 @@ func init() { }) } +// +onecloud:model-api-gen type SStorageschedtag struct { SSchedtagJointsBase diff --git a/pkg/compute/models/zoneschedtags.go b/pkg/compute/models/zoneschedtags.go index 855304d2f9..983235af89 100644 --- a/pkg/compute/models/zoneschedtags.go +++ b/pkg/compute/models/zoneschedtags.go @@ -45,11 +45,13 @@ func init() { }) } +// +onecloud:swagger-gen-ignore type SZoneschedtagManager struct { *SSchedtagJointsManager resourceBaseManager SZoneResourceBaseManager } +// +onecloud:swagger-gen-ignore type SZoneschedtag struct { SSchedtagJointsBase SZoneResourceBase diff --git a/pkg/image/models/image_members.go b/pkg/image/models/image_members.go index acdf1baabc..fd787e9de8 100644 --- a/pkg/image/models/image_members.go +++ b/pkg/image/models/image_members.go @@ -51,7 +51,7 @@ func init() { | deleted | tinyint(1) | NO | MUL | NULL | | +------------+--------------+------+-----+---------+----------------+ */ - +// +onecloud:swagger-gen-ignore type SImageMember struct { SImagePeripheral diff --git a/pkg/image/models/image_peripherals.go b/pkg/image/models/image_peripherals.go index 154703481f..9ff00546ff 100644 --- a/pkg/image/models/image_peripherals.go +++ b/pkg/image/models/image_peripherals.go @@ -20,6 +20,7 @@ import ( "yunion.io/x/onecloud/pkg/cloudcommon/db" ) +// +onecloud:model-api-gen type SImagePeripheral struct { db.SResourceBase diff --git a/pkg/image/models/image_properties.go b/pkg/image/models/image_properties.go index deebf0d1e6..5037966569 100644 --- a/pkg/image/models/image_properties.go +++ b/pkg/image/models/image_properties.go @@ -57,6 +57,7 @@ func init() { | deleted | tinyint(1) | NO | MUL | NULL | | +------------+--------------+------+-----+---------+----------------+ */ +// +onecloud:swagger-gen-ignore type SImageProperty struct { SImagePeripheral diff --git a/pkg/image/models/image_subs.go b/pkg/image/models/image_subs.go index 0d44c8cd1b..108af5ae66 100644 --- a/pkg/image/models/image_subs.go +++ b/pkg/image/models/image_subs.go @@ -58,6 +58,7 @@ func init() { ImageSubformatManager.TableSpec().AddIndex(true, "image_id", "format") } +// +onecloud:swagger-gen-ignore type SImageSubformat struct { SImagePeripheral diff --git a/pkg/image/models/image_tags.go b/pkg/image/models/image_tags.go index bef49a57d1..87f2a66aa3 100644 --- a/pkg/image/models/image_tags.go +++ b/pkg/image/models/image_tags.go @@ -49,6 +49,7 @@ func init() { | deleted | tinyint(1) | NO | | NULL | | +------------+--------------+------+-----+---------+----------------+ */ +// +onecloud:swagger-gen-ignore type SImageTag struct { SImagePeripheral diff --git a/pkg/keystone/models/organizations.go b/pkg/keystone/models/organizations.go index 7d4f5dc879..891ea1507b 100644 --- a/pkg/keystone/models/organizations.go +++ b/pkg/keystone/models/organizations.go @@ -167,13 +167,6 @@ func (manager *SOrganizationManager) QueryDistinctExtraField(q *sqlchemy.SQuery, return q, httperrors.ErrNotFound } -type SOrganizationDetails struct { - api.EnabledIdentityBaseResourceDetails - apis.SharableResourceBaseInfo - - SOrganization -} - func (manager *SOrganizationManager) FetchCustomizeColumns( ctx context.Context, userCred mcclient.TokenCredential, @@ -181,13 +174,13 @@ func (manager *SOrganizationManager) FetchCustomizeColumns( objs []interface{}, fields stringutils2.SSortedStrings, isList bool, -) []SOrganizationDetails { - rows := make([]SOrganizationDetails, len(objs)) +) []api.SOrganizationDetails { + rows := make([]api.SOrganizationDetails, len(objs)) infRows := manager.SEnabledIdentityBaseResourceManager.FetchCustomizeColumns(ctx, userCred, query, objs, fields, isList) sharedRows := manager.SSharableBaseResourceManager.FetchCustomizeColumns(ctx, userCred, query, objs, fields, isList) for i := range rows { // org := objs[i].(*SOrganization) - rows[i] = SOrganizationDetails{ + rows[i] = api.SOrganizationDetails{ EnabledIdentityBaseResourceDetails: infRows[i], SharableResourceBaseInfo: sharedRows[i], } diff --git a/pkg/keystone/models/projects.go b/pkg/keystone/models/projects.go index a2ab56a4b2..2805b59b3d 100644 --- a/pkg/keystone/models/projects.go +++ b/pkg/keystone/models/projects.go @@ -224,6 +224,7 @@ func (manager *SProjectManager) FetchProject(projectId, projectName string, doma return nil, fmt.Errorf("no project Id or name provided") } +// +onecloud:model-api-gen type SProjectExtended struct { SProject diff --git a/pkg/keystone/models/user_group_memberships.go b/pkg/keystone/models/user_group_memberships.go index 6e78833990..6dcd0d0654 100644 --- a/pkg/keystone/models/user_group_memberships.go +++ b/pkg/keystone/models/user_group_memberships.go @@ -28,6 +28,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SUsergroupManager struct { db.SResourceBaseManager } @@ -57,6 +58,7 @@ func init() { +----------+-------------+------+-----+---------+-------+ */ +// +onecloud:swagger-gen-ignore type SUsergroupMembership struct { db.SResourceBase diff --git a/pkg/monitor/models/alertjoint.go b/pkg/monitor/models/alertjoint.go index 72a8a4879c..5cde6eb03f 100644 --- a/pkg/monitor/models/alertjoint.go +++ b/pkg/monitor/models/alertjoint.go @@ -27,6 +27,7 @@ import ( "yunion.io/x/onecloud/pkg/util/stringutils2" ) +// +onecloud:swagger-gen-ignore type SAlertJointsManager struct { db.SJointResourceBaseManager } @@ -41,6 +42,7 @@ func NewAlertJointsManager( } } +// +onecloud:swagger-gen-ignore type SAlertJointsBase struct { db.SVirtualJointResourceBase diff --git a/pkg/monitor/models/alertnotification.go b/pkg/monitor/models/alertnotification.go index 9b1730b55d..da33dc2920 100644 --- a/pkg/monitor/models/alertnotification.go +++ b/pkg/monitor/models/alertnotification.go @@ -35,6 +35,7 @@ const ( AlertNotificationUsedByMigrationAlert = monitor.AlertNotificationUsedByMigrationAlert ) +// +onecloud:swagger-gen-ignore type SAlertNotificationManager struct { SAlertJointsManager } @@ -56,6 +57,7 @@ func init() { }) } +// +onecloud:swagger-gen-ignore type SAlertnotification struct { SAlertJointsBase NotificationId string `width:"36" charset:"ascii" nullable:"false" list:"user" create:"required"` diff --git a/pkg/monitor/models/alertresource_alert.go b/pkg/monitor/models/alertresource_alert.go index c91a9ce7ef..4d673dc0c0 100644 --- a/pkg/monitor/models/alertresource_alert.go +++ b/pkg/monitor/models/alertresource_alert.go @@ -53,10 +53,12 @@ func GetAlertResourceAlertManager() *SAlertResourceAlertManager { return alertResourceAlertManager } +// +onecloud:swagger-gen-ignore type SAlertResourceAlertManager struct { SAlertResourceJointsManager } +// +onecloud:swagger-gen-ignore type SAlertResourceAlert struct { SAlertResourceJointsBase diff --git a/pkg/monitor/models/alertresourcejoints.go b/pkg/monitor/models/alertresourcejoints.go index b3075594ce..b466e54814 100644 --- a/pkg/monitor/models/alertresourcejoints.go +++ b/pkg/monitor/models/alertresourcejoints.go @@ -34,10 +34,12 @@ type IAlertResourceJointModel interface { GetDetails(base monitor.AlertResourceJointBaseDetails, isList bool) interface{} } +// +onecloud:swagger-gen-ignore type SAlertResourceJointsManager struct { db.SJointResourceBaseManager } +// +onecloud:swagger-gen-ignore type SAlertResourceJointsBase struct { db.SJointResourceBase diff --git a/pkg/notify/models/topic.go b/pkg/notify/models/topic.go index 1330dd3913..38a4d8af93 100644 --- a/pkg/notify/models/topic.go +++ b/pkg/notify/models/topic.go @@ -641,6 +641,7 @@ func (sm *STopicManager) FetchCustomizeColumns(ctx context.Context, userCred mcc return rows } +// +onecloud:model-api-gen type SSubscriberDis struct { SSubscriber ReceiverName string `json:"receiver_name"`